Class Packer

Class which can pack multiple values which may have multiple dimensions into a one-dimensional array of values, and unpack them again.

Index

Constructors

Accessors

Methods

unpackArray unpackNdarray

Constructors

constructor

new Packer(options: PackerOptions): Packer
Parameters
- options: PackerOptions
  Packing options for the Packer
Returns Packer
- Defined in Packer.ts:65

Accessors

length

get length(): number
Returns the total number of values which will be held in a one-dimensional array after packing by this Packer.

Returns number
- Defined in Packer.ts:87

Methods

unpackArray

unpackArray(x: number[]): UnpackResult
Unpacks a one-dimensional array to the shapes defined by this Packer.
Parameters
- x: number[]
  A standard number array
Returns UnpackResult
- Defined in Packer.ts:99

unpackNdarray

unpackNdarray(x: NdArray): UnpackResult
Unpacks an NdArray to the shapes defined by this Packer. We require the first dimension in the NdArray to equal length. Any additional dimensions are added to the configured shapes for each unpacked value.
Parameters
- x: NdArray
  NdArray of numbers
Returns UnpackResult
- Defined in Packer.ts:125