topk-js / data

​
Functions

​
binaryVector()

function binaryVector(values: number[]): List;
Creates a binary vector from an array of bytes. Parameters
ParameterType
valuesnumber[]
Returns List

​
bytes()

function bytes(buffer: number[] | Buffer<ArrayBufferLike>): Buffer;
Creates a bytes value from a buffer or array of numbers. Parameters
ParameterType
buffernumber[] | Buffer<ArrayBufferLike>
Returns Buffer

​
f32List()

function f32List(values: number[]): List;
Creates a list of 64-bit floating point numbers. Parameters
ParameterType
valuesnumber[]
Returns List

​
f32SparseVector()

function f32SparseVector(vector: Record<number, number>): SparseVector;
Parameters
ParameterType
vectorRecord<number, number>
Returns SparseVector

​
f32Vector()

function f32Vector(values: number[]): List;
Creates a 32-bit float vector from an array of numbers. Parameters
ParameterType
valuesnumber[]
Returns List

​
f64List()

function f64List(values: number[]): List;
Parameters
ParameterType
valuesnumber[]
Returns List

​
i32List()

function i32List(values: number[]): List;
Creates a list of 32-bit signed integers. Parameters
ParameterType
valuesnumber[]
Returns List

​
i64List()

function i64List(values: number[]): List;
Creates a list of 64-bit signed integers. Parameters
ParameterType
valuesnumber[]
Returns List

​
stringList()

function stringList(values: string[]): List;
Creates a sparse vector of 32-bit floats. Parameters
ParameterType
valuesstring[]
Returns List

​
u32List()

function u32List(values: number[]): List;
Creates a list of 32-bit unsigned integers. Parameters
ParameterType
valuesnumber[]
Returns List

​
u8SparseVector()

function u8SparseVector(vector: Record<number, number>): SparseVector;
Creates a sparse vector of 8-bit unsigned integers. Parameters
ParameterType
vectorRecord<number, number>
Returns SparseVector

​
u8Vector()

function u8Vector(values: number[]): List;
Creates an 8-bit unsigned integer vector from an array of numbers. Parameters
ParameterType
valuesnumber[]
Returns List

​
Classes

​
List

Internal Instances of the List class are used to represent lists of values in TopK. Usually created using data constructors such as f32_list(), i32_list(), etc.

​
SparseVector

Internal Instances of the SparseVector class are used to represent sparse vectors in TopK. Usually created using data constructors such as f32_sparse_vector() or u8_sparse_vector().