130 lines
5.6 KiB
Markdown
130 lines
5.6 KiB
Markdown
# ieee754-buffer
|
|
Copyright (c) 2018-2019 Rafael da Silva Rocha.
|
|
Copyright (c) 2013 DeNA Co., Ltd.
|
|
Copyright (c) 2010, Linden Research, Inc
|
|
https://github.com/rochars/ieee754-buffer
|
|
|
|
[](https://www.npmjs.com/package/ieee754-buffer) [](https://rochars.github.io/ieee754-buffer/docs/index.html) [](https://rochars.github.io/ieee754-buffer/test/dist/browser.html)
|
|
[](https://codecov.io/gh/rochars/ieee754-buffer) [](https://travis-ci.org/rochars/ieee754-buffer) [](https://ci.appveyor.com/project/rochars/ieee754-buffer) [](https://scrutinizer-ci.com/g/rochars/ieee754-buffer/)
|
|
|
|
**ieee754-buffer** is a module to encode and decode IEEE 754 floating point numbers.
|
|
|
|
- **MIT licensed**
|
|
- **Can be used where typed arrays can't**
|
|
- **Parse 16-bit, 32-bit and 64-bit floats**
|
|
|
|
## Install
|
|
```
|
|
npm install ieee754-buffer
|
|
```
|
|
|
|
## Use
|
|
|
|
### Browser
|
|
Use the **ieee754-buffer.js** file in the **/dist** folder:
|
|
```html
|
|
<script src="ieee754-buffer.js"></script>
|
|
<script>
|
|
let packer = new IEEE754Buffer.IEEE754Buffer(8, 23);
|
|
var buffer = [];
|
|
packer.pack(buffer, 0, 3.1415927410);
|
|
console.log(buffer);
|
|
</script>
|
|
```
|
|
|
|
Or load it from the [jsDelivr](https://cdn.jsdelivr.net/npm/ieee754-buffer) CDN:
|
|
```html
|
|
<script src="https://cdn.jsdelivr.net/npm/ieee754-buffer"></script>
|
|
```
|
|
|
|
Or load it from [unpkg](https://unpkg.com/ieee754-buffer):
|
|
```html
|
|
<script src="https://unpkg.com/ieee754-buffer"></script>
|
|
```
|
|
|
|
### Node
|
|
```javascript
|
|
const IEEE754Buffer = require('ieee754-buffer').IEEE754Buffer;
|
|
let packer = new IEEE754Buffer(8, 23);
|
|
let buffer = Uint8Array(4);
|
|
packer.pack(buffer, 0, 3.1415927410);
|
|
console.log(buffer);
|
|
```
|
|
|
|
## About
|
|
- **Overflows** are rounded towards **Infinity** and **-Infinity**.
|
|
- **NaN** is packed as quiet NaN. Both **quiet NaN** and **signaling NaN** can be unpacked.
|
|
- Support packing and unpacking **zero** and **negative zero**.
|
|
- Support packing and unpacking **Infinity** and **negative Infinity**
|
|
- **always little endian**, use [byte-data](https://www.github.com/rochars/byte-data) for a endianness-independent interface of this lib
|
|
|
|
## API
|
|
```javascript
|
|
|
|
export class IEEE754Buffer {
|
|
|
|
/**
|
|
* Pack a IEEE 754 floating point number.
|
|
* @param {number} ebits The exponent bits.
|
|
* @param {number} fbits The fraction bits.
|
|
*/
|
|
constructor(ebits, fbits) {}
|
|
|
|
/**
|
|
* Pack a IEEE 754 floating point number.
|
|
* @param {!Uint8Array|!Array<number>} buffer The buffer.
|
|
* @param {number} num The number.
|
|
* @param {number} index The index to write on the buffer.
|
|
* @return {number} The next index to write on the buffer.
|
|
* @throws {TypeError} If input is not a number.
|
|
*/
|
|
pack(buffer, index, num) {}
|
|
|
|
/**
|
|
* Unpack a IEEE 754 floating point number.
|
|
* Derived from IEEE754 by DeNA Co., Ltd., MIT License.
|
|
* Adapted to handle NaN. Should port the solution to the original repo.
|
|
* @param {!Uint8Array|!Array<number>} buffer The buffer.
|
|
* @param {number} index The index to read from the buffer.
|
|
* @return {number} The floating point number.
|
|
*/
|
|
unpack(buffer, index) {}
|
|
}
|
|
```
|
|
|
|
## Contributing
|
|
**ieee754-buffer** welcomes all contributions from anyone willing to work in good faith with other contributors and the community. No contribution is too small and all contributions are valued.
|
|
|
|
See [CONTRIBUTING.md](https://github.com/rochars/ieee754-buffer/blob/master/CONTRIBUTING.md) for details.
|
|
|
|
### Style guide
|
|
**ieee754-buffer** code should follow the Google JavaScript Style Guide:
|
|
https://google.github.io/styleguide/jsguide.html
|
|
|
|
### Code of conduct
|
|
This project is bound by a code of conduct: The [Contributor Covenant, version 1.4](https://github.com/rochars/ieee754-buffer/blob/master/CODE_OF_CONDUCT.md), also available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
|
|
|
## LICENSE
|
|
Copyright (c) 2018-2019 Rafael da Silva Rocha.
|
|
Copyright (c) 2013 DeNA Co., Ltd.
|
|
Copyright (c) 2010, Linden Research, Inc
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining
|
|
a copy of this software and associated documentation files (the
|
|
"Software"), to deal in the Software without restriction, including
|
|
without limitation the rights to use, copy, modify, merge, publish,
|
|
distribute, sublicense, and/or sell copies of the Software, and to
|
|
permit persons to whom the Software is furnished to do so, subject to
|
|
the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be
|
|
included in all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|