ScalaIndexAdapter

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. def add(item: TItem): Unit

   

   Add a new item to the index.

   Add a new item to the index. If the item already exists in the index the old item will first be removed from the index. for this removes need to be enabled for the index.

   item

   the item to add to the index

   Definition Classes

   ScalaIndexAdapter → Index

5. 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

   Definition Classes

   ScalaIndexAdapter → Index

6. 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

   Definition Classes

   ScalaIndexAdapter → Index

7. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

8. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

9. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

10. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

11. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

12. 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

    Definition Classes

    ScalaIndexAdapter → Index

13. def findNeighbors(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 neighbors of

    k

    number of neighbors to return

    returns

    the items closest to the item

    Definition Classes

    ScalaIndexAdapter → Index

14. 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

    Definition Classes

    ScalaIndexAdapter → Index

15. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

16. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

17. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

18. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

19. final def notify(): Unit

    

    Definition Classes

    AnyRef

20. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

21. 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

    Definition Classes

    ScalaIndexAdapter → Index

22. def save(path: Path): Unit

    

    Saves the index to a path.

    Saves the index to a path.

    path

    path to write the index to

    Definition Classes

    ScalaIndexAdapter → Index

23. def save(file: File): Unit

    

    Saves the index to a file.

    Saves the index to a file.

    file

    file to write the index to

    Definition Classes

    ScalaIndexAdapter → Index

24. 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

    Definition Classes

    ScalaIndexAdapter → Index

25. def size: Int

    

    Returns the size of the index.

    Returns the size of the index.

    returns

    size of the index

    Definition Classes

    ScalaIndexAdapter → Index

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

    

    Definition Classes

    AnyRef

27. def toString(): String

    

    Definition Classes

    AnyRef → Any

28. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

30. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )