Index

Type Members

type ProgressListener = (Int, Int) ⇒ Unit

Called periodically to report on progress during indexing.
Called periodically to report on progress during indexing. The first argument is the number of records processed. The second argument is the total number of record to index as part of this operation.

Abstract Value Members

abstract def add(item: TItem): Unit

Add a new item to the index.
Add a new item to the index.
item
the item to add to the index
abstract def addAll(items: Iterable[TItem], numThreads: Int = ..., listener: ProgressListener = (_, _) => (), progressUpdateInterval: Int = ...): Unit

Add multiple items to the index.
Add multiple items to the index. Reports progress to the passed in progress listener every progressUpdateInterval elements indexed.
items
the items to add to the index
numThreads
number of threads to use for parallel indexing
listener
listener to report progress to
progressUpdateInterval
after indexing this many items progress will be reported
abstract def apply(id: TId): TItem

Returns an item by its identifier.
Returns an item by its identifier. If the item does not exist in the index a NoSuchElementException is thrown
id
unique identifier of the item to return
returns
the item

Exceptions thrown
NoSuchElementException when the item does not exist
abstract def findNearest(vector: TVector, k: Int): Seq[SearchResult[TItem, TDistance]]

Find the items closest to the passed in vector.
Find the items closest to the passed in vector.
vector
the vector
k
number of items to return
returns
the items closest to the passed in vector
abstract def findNeighbours(id: TId, k: Int): Seq[SearchResult[TItem, TDistance]]

Find the items closest to the item identified by the passed in id.
Find the items closest to the item identified by the passed in id. If the id does not match an item an empty list is returned. the element itself is not included in the response.
id
of the item to find the neighbours of
k
number of neighbours to return
returns
the items closest to the item
abstract def get(id: TId): Option[TItem]

Optionally return an item by its identifier
Optionally return an item by its identifier
id
unique identifier of the item to return
returns
the item
abstract def remove(id: TId): Boolean

Removes an item from the index.
Removes an item from the index.
id
unique identifier or the item to remove
returns
true if this list contained the specified element
abstract def save(path: Path): Unit

Saves the index to a path.
Saves the index to a path.
path
path to write the index to
abstract def save(file: File): Unit

Saves the index to a file.
Saves the index to a file.
file
file to write the index to
abstract def save(out: OutputStream): Unit

Saves the index to an OutputStream.
Saves the index to an OutputStream.
out
the output stream to write the index to
abstract def size: Int

Returns the size of the index.
Returns the size of the index.
returns
size of the index

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package scalalike

trait Index[TId, TVector, TItem <: Item[TId, TVector], TDistance] extends Serializable

Type Members

type ProgressListener = (Int, Int) ⇒ Unit

Abstract Value Members

abstract def add(item: TItem): Unit

abstract def addAll(items: Iterable[TItem], numThreads: Int = ..., listener: ProgressListener = (_, _) => (), progressUpdateInterval: Int = ...): Unit

abstract def apply(id: TId): TItem

abstract def findNearest(vector: TVector, k: Int): Seq[SearchResult[TItem, TDistance]]

abstract def findNeighbours(id: TId, k: Int): Seq[SearchResult[TItem, TDistance]]

abstract def get(id: TId): Option[TItem]

abstract def remove(id: TId): Boolean

abstract def save(path: Path): Unit

abstract def save(file: File): Unit

abstract def save(out: OutputStream): Unit

abstract def size: Int

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped