Commit 042337a

authored

Merge pull request #79 from msgpack/prefer-float32

implement `forceFloat32` to encode numbers in float32 instead of float64

2 parents c4a1ef5 + 91eeb98 commit 042337aCopy full SHA for 042337a

File tree

+50

-5

lines changed

+50

-5

lines changed

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -114,6 +114,7 @@ extensionCodec \| ExtensionCodec \| `ExtensinCodec.defaultCodec`
`114`	`114`	maxDepth \| number \| `100`
`115`	`115`	initialBufferSize \| number \| `2048`
`116`	`116`	`sortKeys \| boolean \| false`
	`117`	`+forceFloat32 \| boolean \| false`
`117`	`118`
`118`	`119`	### `decode(buffer: ArrayLike<number> \| ArrayBuffer, options?: DecodeOptions): unknown`
`119`	`120`

Lines changed: 17 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ export class Encoder {`
`18`	`18`	`readonly maxDepth = DEFAULT_MAX_DEPTH,`
`19`	`19`	`readonly initialBufferSize = DEFAULT_INITIAL_BUFFER_SIZE,`
`20`	`20`	`readonly sortKeys = false,`
	`21`	`+ readonly forceFloat32 = false,`
`21`	`22`	`) {}`
`22`	`23`
`23`	`24`	`encode(object: unknown, depth: number): void {`
`@@ -118,8 +119,16 @@ export class Encoder {`
`118`	`119`	`}`
`119`	`120`	`}`
`120`	`121`	`} else {`
`121`		`- this.writeU8(0xcb);`
`122`		`- this.writeF64(object);`
	`122`	`+ // non-integer numbers`
	`123`	`+ if (this.forceFloat32) {`
	`124`	`+ // float 32`
	`125`	`+ this.writeU8(0xca);`
	`126`	`+ this.writeF32(object);`
	`127`	`+ } else {`
	`128`	`+ // float 64`
	`129`	`+ this.writeU8(0xcb);`
	`130`	`+ this.writeF64(object);`
	`131`	`+ }`
`123`	`132`	`}`
`124`	`133`	`}`
`125`	`134`
`@@ -345,9 +354,14 @@ export class Encoder {`
`345`	`354`	`this.pos += 4;`
`346`	`355`	`}`
`347`	`356`
	`357`	`+ writeF32(value: number) {`
	`358`	`+ this.ensureBufferSizeToWrite(4);`
	`359`	`+ this.view.setFloat32(this.pos, value);`
	`360`	`+ this.pos += 4;`
	`361`	`+ }`
	`362`	`+`
`348`	`363`	`writeF64(value: number) {`
`349`	`364`	`this.ensureBufferSizeToWrite(8);`
`350`		`-`
`351`	`365`	`this.view.setFloat64(this.pos, value);`
`352`	`366`	`this.pos += 8;`
`353`	`367`	`}`

Lines changed: 14 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,13 @@ export type EncodeOptions = Partial<`
`7`	`7`	`maxDepth: number;`
`8`	`8`	`initialBufferSize: number;`
`9`	`9`	`sortKeys: boolean;`
	`10`	`+`
	`11`	`+ /**`
	`12`	+ * If `true`, non-integer numbers are encoded in float32, not in float64 (the default).
	`13`	`+ *`
	`14`	`+ * Only use it if precisions don't matter.`
	`15`	`+ */`
	`16`	`+ forceFloat32: boolean;`
`10`	`17`	`}>`
`11`	`18`	`>;`
`12`	`19`
`@@ -19,7 +26,13 @@ const defaultEncodeOptions = {};`
`19`	`26`	* The returned buffer is a slice of a larger `ArrayBuffer`, so you have to use its `#byteOffset` and `#byteLength` in order to convert it to another typed arrays including NodeJS `Buffer`.
`20`	`27`	`*/`
`21`	`28`	`export function encode(value: unknown, options: EncodeOptions = defaultEncodeOptions): Uint8Array {`
`22`		`- const encoder = new Encoder(options.extensionCodec, options.maxDepth, options.initialBufferSize, options.sortKeys);`
	`29`	`+ const encoder = new Encoder(`
	`30`	`+ options.extensionCodec,`
	`31`	`+ options.maxDepth,`
	`32`	`+ options.initialBufferSize,`
	`33`	`+ options.sortKeys,`
	`34`	`+ options.forceFloat32,`
	`35`	`+ );`
`23`	`36`	`encoder.encode(value, 1);`
`24`	`37`	`return encoder.getUint8Array();`
`25`	`38`	`}`

Lines changed: 18 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,28 @@ import { encode, decode } from "@msgpack/msgpack";`
`3`	`3`
`4`	`4`	`describe("encode", () => {`
`5`	`5`	`context("sortKeys", () => {`
`6`		`- it("canonicalize encoded binaries", () => {`
	`6`	`+ it("canonicalizes encoded binaries", () => {`
`7`	`7`	`assert.deepStrictEqual(encode({ a: 1, b: 2 }, { sortKeys: true }), encode({ b: 2, a: 1 }, { sortKeys: true }));`
`8`	`8`	`});`
`9`	`9`	`});`
`10`	`10`
	`11`	`+ context("forceFloat32", () => {`
	`12`	`+ it("encodes numbers in float64 wihout forceFloat32", () => {`
	`13`	`+ assert.deepStrictEqual(encode(3.14), Uint8Array.from([0xcb, 0x40, 0x9, 0x1e, 0xb8, 0x51, 0xeb, 0x85, 0x1f]));`
	`14`	`+ });`
	`15`	`+`
	`16`	`+ it("encodes numbers in float32 when forceFloate32=true", () => {`
	`17`	`+ assert.deepStrictEqual(encode(3.14, { forceFloat32: true }), Uint8Array.from([0xca, 0x40, 0x48, 0xf5, 0xc3]));`
	`18`	`+ });`
	`19`	`+`
	`20`	`+ it("encodes numbers in float64 with forceFloat32=false", () => {`
	`21`	`+ assert.deepStrictEqual(`
	`22`	`+ encode(3.14, { forceFloat32: false }),`
	`23`	`+ Uint8Array.from([0xcb, 0x40, 0x9, 0x1e, 0xb8, 0x51, 0xeb, 0x85, 0x1f]),`
	`24`	`+ );`
	`25`	`+ });`
	`26`	`+ });`
	`27`	`+`
`11`	`28`	`context("ArrayBuffer as buffer", () => {`
`12`	`29`	`const buffer = encode([1, 2, 3]);`
`13`	`30`	`const arrayBuffer = buffer.buffer.slice(buffer.byteOffset, buffer.byteLength);`

Comments

(0)