Package com.yahoo.searchdefinition.document

Class HnswIndexParams

java.lang.Object

com.yahoo.searchdefinition.document.HnswIndexParams

public class HnswIndexParams
extends java.lang.Object

Configuration parameters for a hnsw index used together with a 1-dimensional indexed tensor for approximate nearest neighbor search.

Author:

geirst

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HnswIndexParams.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MAX_LINKS_PER_NODE
static int	DEFAULT_NEIGHBORS_TO_EXPLORE_AT_INSERT

Constructor Summary

Constructors

Constructor	Description
HnswIndexParams()
HnswIndexParams(java.util.Optional<java.lang.Integer> maxLinksPerNode, java.util.Optional<java.lang.Integer> neighborsToExploreAtInsert, java.util.Optional<java.lang.Boolean> multiThreadedIndexing)

Method Summary

Modifier and Type	Method	Description
int	maxLinksPerNode()
boolean	multiThreadedIndexing()
int	neighborsToExploreAtInsert()
HnswIndexParams	overrideFrom(java.util.Optional<HnswIndexParams> other)	Creates a new instance where values from the given parameter instance are used where they are present, otherwise we use values from this.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_MAX_LINKS_PER_NODE

public static final int DEFAULT_MAX_LINKS_PER_NODE

See Also:

Constant Field Values

DEFAULT_NEIGHBORS_TO_EXPLORE_AT_INSERT

public static final int DEFAULT_NEIGHBORS_TO_EXPLORE_AT_INSERT

See Also:

Constant Field Values

Constructor Detail

HnswIndexParams

public HnswIndexParams()

HnswIndexParams

public HnswIndexParams(java.util.Optional<java.lang.Integer> maxLinksPerNode,
                       java.util.Optional<java.lang.Integer> neighborsToExploreAtInsert,
                       java.util.Optional<java.lang.Boolean> multiThreadedIndexing)

Method Detail

overrideFrom

public HnswIndexParams overrideFrom(java.util.Optional<HnswIndexParams> other)

Creates a new instance where values from the given parameter instance are used where they are present, otherwise we use values from this.

maxLinksPerNode

public int maxLinksPerNode()

neighborsToExploreAtInsert

public int neighborsToExploreAtInsert()

multiThreadedIndexing

public boolean multiThreadedIndexing()