Built motion from commit 6a09e18b.|2.6.11

[motion2.git] / legacy-libs / grpc-cloned / node_modules / @protobufjs / float / README.md

diff --git a/legacy-libs/grpc-cloned/node_modules/@protobufjs/float/README.md b/legacy-libs/grpc-cloned/node_modules/@protobufjs/float/README.md
new file mode 100644 (file)
index 0000000..8947bae
--- /dev/null
+++ b/legacy-libs/grpc-cloned/node_modules/@protobufjs/float/README.md
@@ -0,0 +1,102 @@
+@protobufjs/float\r
+=================\r
+[![npm](https://img.shields.io/npm/v/@protobufjs/float.svg)](https://www.npmjs.com/package/@protobufjs/float)\r
+\r
+Reads / writes floats / doubles from / to buffers in both modern and ancient browsers. Fast.\r
+\r
+API\r
+---\r
+\r
+* **writeFloatLE(val: `number`, buf: `Uint8Array`, pos: `number`)**<br />\r
+  Writes a 32 bit float to a buffer using little endian byte order.\r
+\r
+* **writeFloatBE(val: `number`, buf: `Uint8Array`, pos: `number`)**<br />\r
+  Writes a 32 bit float to a buffer using big endian byte order.\r
+\r
+* **readFloatLE(buf: `Uint8Array`, pos: `number`): `number`**<br />\r
+  Reads a 32 bit float from a buffer using little endian byte order.\r
+\r
+* **readFloatBE(buf: `Uint8Array`, pos: `number`): `number`**<br />\r
+  Reads a 32 bit float from a buffer using big endian byte order.\r
+\r
+* **writeDoubleLE(val: `number`, buf: `Uint8Array`, pos: `number`)**<br />\r
+  Writes a 64 bit double to a buffer using little endian byte order.\r
+\r
+* **writeDoubleBE(val: `number`, buf: `Uint8Array`, pos: `number`)**<br />\r
+  Writes a 64 bit double to a buffer using big endian byte order.\r
+\r
+* **readDoubleLE(buf: `Uint8Array`, pos: `number`): `number`**<br />\r
+  Reads a 64 bit double from a buffer using little endian byte order.\r
+\r
+* **readDoubleBE(buf: `Uint8Array`, pos: `number`): `number`**<br />\r
+  Reads a 64 bit double from a buffer using big endian byte order.\r
+\r
+Performance\r
+-----------\r
+There is a simple benchmark included comparing raw read/write performance of this library (float), float's fallback for old browsers, the [ieee754](https://www.npmjs.com/package/ieee754) module and node's [buffer](https://nodejs.org/api/buffer.html). On an i7-2600k running node 6.9.1 it yields:\r
+\r
+```\r
+benchmarking writeFloat performance ...\r
+\r
+float x 42,741,625 ops/sec ±1.75% (81 runs sampled)\r
+float (fallback) x 11,272,532 ops/sec ±1.12% (85 runs sampled)\r
+ieee754 x 8,653,337 ops/sec ±1.18% (84 runs sampled)\r
+buffer x 12,412,414 ops/sec ±1.41% (83 runs sampled)\r
+buffer (noAssert) x 13,471,149 ops/sec ±1.09% (84 runs sampled)\r
+\r
+                      float was fastest\r
+           float (fallback) was 73.5% slower\r
+                    ieee754 was 79.6% slower\r
+                     buffer was 70.9% slower\r
+          buffer (noAssert) was 68.3% slower\r
+\r
+benchmarking readFloat performance ...\r
+\r
+float x 44,382,729 ops/sec ±1.70% (84 runs sampled)\r
+float (fallback) x 20,925,938 ops/sec ±0.86% (87 runs sampled)\r
+ieee754 x 17,189,009 ops/sec ±1.01% (87 runs sampled)\r
+buffer x 10,518,437 ops/sec ±1.04% (83 runs sampled)\r
+buffer (noAssert) x 11,031,636 ops/sec ±1.15% (87 runs sampled)\r
+\r
+                      float was fastest\r
+           float (fallback) was 52.5% slower\r
+                    ieee754 was 61.0% slower\r
+                     buffer was 76.1% slower\r
+          buffer (noAssert) was 75.0% slower\r
+\r
+benchmarking writeDouble performance ...\r
+\r
+float x 38,624,906 ops/sec ±0.93% (83 runs sampled)\r
+float (fallback) x 10,457,811 ops/sec ±1.54% (85 runs sampled)\r
+ieee754 x 7,681,130 ops/sec ±1.11% (83 runs sampled)\r
+buffer x 12,657,876 ops/sec ±1.03% (83 runs sampled)\r
+buffer (noAssert) x 13,372,795 ops/sec ±0.84% (85 runs sampled)\r
+\r
+                      float was fastest\r
+           float (fallback) was 73.1% slower\r
+                    ieee754 was 80.1% slower\r
+                     buffer was 67.3% slower\r
+          buffer (noAssert) was 65.3% slower\r
+\r
+benchmarking readDouble performance ...\r
+\r
+float x 40,527,888 ops/sec ±1.05% (84 runs sampled)\r
+float (fallback) x 18,696,480 ops/sec ±0.84% (86 runs sampled)\r
+ieee754 x 14,074,028 ops/sec ±1.04% (87 runs sampled)\r
+buffer x 10,092,367 ops/sec ±1.15% (84 runs sampled)\r
+buffer (noAssert) x 10,623,793 ops/sec ±0.96% (84 runs sampled)\r
+\r
+                      float was fastest\r
+           float (fallback) was 53.8% slower\r
+                    ieee754 was 65.3% slower\r
+                     buffer was 75.1% slower\r
+          buffer (noAssert) was 73.8% slower\r
+```\r
+\r
+To run it yourself:\r
+\r
+```\r
+$> npm run bench\r
+```\r
+\r
+**License:** [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause)\r