Class Index

Index. Index that stores the full vectors and performs exhaustive search.

Param

The dimensionality of index.

Hierarchy

Index
- IndexFlatL2
- IndexFlatIP

Index

Constructors

Methods

add getDimension isTrained mergeFrom ntotal removeIds search toBuffer train write fromBuffer fromFactory read

Constructors

constructor

new Index(d: number): Index
Parameters
- d: number
Returns Index
- Defined in index.d.ts:32

Methods

add

add(x: number[]): void
Add n vectors of dimension d to the index. Vectors are implicitly assigned labels ntotal .. ntotal + n - 1
Parameters
- x: number[]
  
  Input matrix, size n * d
Returns void
- Defined in index.d.ts:53

getDimension

getDimension(): number
returns the dimensionality of verctors.

Returns
The dimensionality of verctors.

Returns number
- Defined in index.d.ts:42

isTrained

isTrained(): boolean
returns a boolean that indicates whether training is required.

Returns
Whether training is required.

Returns boolean
- Defined in index.d.ts:47

mergeFrom

mergeFrom(otherIndex: Index): void
Merge the current index with another Index instance.
Parameters
- otherIndex: Index
  
  The other Index instance to merge from.
Returns void
- Defined in index.d.ts:103

ntotal

ntotal(): number
returns the number of verctors currently indexed.

Returns
The number of verctors currently indexed.

Returns number
- Defined in index.d.ts:37

removeIds

removeIds(ids: number[]): number
Remove IDs from the index.

Returns
number of IDs removed.
Parameters
- ids: number[]
  
  IDs to read.
Returns number
- Defined in index.d.ts:109

search

search(x: number[], k: number): SearchResult
Query n vectors of dimension d to the index. return at most k vectors. If there are not enough results for a query, the result array is padded with -1s.

Returns
Output of the search result.
Parameters
- x: number[]
  
  Input vectors to search, size n * d.
- k: number
  
  The number of nearest neighbors to search for.
Returns SearchResult
- Defined in index.d.ts:69

toBuffer

toBuffer(): Buffer
Write index to buffer.

Returns Buffer
- Defined in index.d.ts:78

train

train(x: number[]): void
Train n vectors of dimension d to the index. Vectors are implicitly assigned labels ntotal .. ntotal + n - 1
Parameters
- x: number[]
  
  Input matrix, size n * d
Returns void
- Defined in index.d.ts:59

write

write(fname: string): void
Write index to a file.
Parameters
- fname: string
  
  File path to write.
Returns void
- Defined in index.d.ts:74

`Static` fromBuffer

fromBuffer(src: Buffer): Index
Read index from buffer.

Returns
The index read.
Parameters
- src: Buffer
  
  Buffer to create index from.
Returns Index
- Defined in index.d.ts:90

`Static` fromFactory

fromFactory(dims: number, descriptor: string, metric?: MetricType): Index
Construct an index from factory descriptor.

Returns
The index read.
Parameters
- dims: number
  
  Buffer to create index from.
- descriptor: string
  
  Factory descriptor.
- Optional metric: MetricType
  
  Metric type (defaults to L2).
Returns Index
- Defined in index.d.ts:98

`Static` read

read(fname: string): Index
Read index from a file.

Returns
The index read.
Parameters
- fname: string
  
  File path to read.
Returns Index
- Defined in index.d.ts:84

Generated using TypeDoc