jruby/docs BETA
Navigation
org.apache.lucene.codecs.hnsw 9
C DefaultFlatVectorScorer
C FlatFieldVectorsWriter
C FlatVectorScorerUtil
C FlatVectorsFormat
C FlatVectorsReader
I FlatVectorsScorer
C FlatVectorsWriter
I HnswGraphProvider
C ScalarQuantizedVectorScorer
FlatFieldVectorsWriter — members 5+
C new()
M docs_with_field_set() DocsWithFieldSet
C finish()
M finished?() boolean
M vectors() List<T>
from Accountable
F NULL_ACCOUNTABLE Accountable
M child_resources() Accountable>
M ram_bytes_used() long
from KnnFieldVectorsWriter
C add_value(doc_id, vector_value)
M copy_value(vector_value) T

org.apache.lucene.codecs.hnsw.FlatFieldVectorsWriter

class abstract extends KnnFieldVectorsWriter<T> 5 members

Vectors' writer for a field

Constructors

new

new ( )
Java: <init>()

Instance Methods

docs_with_field_set

DocsWithFieldSet docs_with_field_set ( )
Java: getDocsWithFieldSet() · also: get_docs_with_field_set

Returns: the docsWithFieldSet for the field writer

finish

finish ( )
Java: finish()

indicates that this writer is done and no new vectors are allowed to be added

Throws

IOException if an I/O error occurs

finished?

boolean finished? ( )
Java: isFinished() · also: is_finished

Returns: true if the writer is done and no new vectors are allowed to be added

vectors

List<T> vectors ( )
Java: getVectors() · also: get_vectors

Returns: a list of vectors to be written

Inherited

from Accountable

fieldtypenote
NULL_ACCOUNTABLE Accountable An accountable that always returns 0

child_resources

Collection<Accountable> child_resources ( )
Java: getChildResources() · also: get_child_resources

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

ram_bytes_used

long ram_bytes_used ( )
Java: ramBytesUsed()

Return the memory usage of this object in bytes. Negative values are illegal.

from KnnFieldVectorsWriter

add_value

add_value ( int doc_id, T vector_value )
Java: addValue(int docID, T vectorValue)

Add new docID with its vector value to the given field for indexing. Doc IDs must be added in increasing order.

copy_value

T copy_value ( T vector_value )
Java: copyValue(T vectorValue)

Used to copy values being indexed to internal storage.

nametypedescription
vector_valueTan array containing the vector value to add

Returns: a copy of the value; a new array

this work for additional information regarding copyright ownership.