Packages

final class SparseArray[V] extends ArrayLike[V] with Storage[V] with Serializable

A SparseArray is a sparse representation of an array using a two-array binary-search approach. There are two arrays: index and data, which together are pairs (i, v) of indices into the array and the value at that position.

The default value is assumed to be null for AnyRef, and 0 for AnyVal types.

Annotations
@SerialVersionUID()
Linear Supertypes
Serializable, Storage[V], ArrayLike[V], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SparseArray
  2. Serializable
  3. Storage
  4. ArrayLike
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SparseArray(size: Int)(implicit manElem: ClassTag[V], zero: Zero[V])
  2. new SparseArray(size: Int, default: V)(implicit manElem: ClassTag[V])
  3. new SparseArray(index: Array[Int], data: Array[V], used: Int, size: Int, default: V)

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 activeSize: Int

    How many elements are stored in terms of space.

    How many elements are stored in terms of space. In HashVectors, activeSize is the number of non-zero elements, while iterableSize is the number of buckets currently allocated. (activeSize <= iterableSize in general, activeSize == iterableSize for everything except hashing implementations.)

    Definition Classes
    SparseArray → Storage → ArrayLike
  5. def allVisitableIndicesActive: Boolean

    Only gives true if isActive would return true for all i.

    Only gives true if isActive would return true for all i. (May be false anyway)

    Definition Classes
    SparseArray → Storage
  6. final def apply(i: Int): V
    Definition Classes
    SparseArray → ArrayLike
    Annotations
    @inline()
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  9. def compact(): Unit

    Compacts the array by removing all stored default values.

  10. def concatenate(that: SparseArray[V])(implicit man: ClassTag[V]): SparseArray[V]
  11. def contains(i: Int): Boolean
  12. var data: Array[V]

    Returns the actual flat array of elements used.

    Returns the actual flat array of elements used.

    Definition Classes
    SparseArray → Storage
  13. val default: V
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(o: Any): Boolean
    Definition Classes
    SparseArray → AnyRef → Any
  16. def filter(f: (V) ⇒ Boolean): SparseArray[V]

    Filter's the array by removing all values for which f is false.

  17. final def findOffset(i: Int): Int

    Returns the offset into index and data for the requested vector index.

    Returns the offset into index and data for the requested vector index. If the requested index is not found, the value is negative and can be converted into an insertion point with ~rv.

    Attributes
    protected
  18. def foreach[U](f: (V) ⇒ U): Unit

    Only iterates "active" elements.

    Only iterates "active" elements. I'm not sure how I feel about this behavior, since it's inconsistent with the rest of Breeze. I will think on it.

    Definition Classes
    ArrayLike
  19. def get(i: Int): Option[V]
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def getOrElse(i: Int, value: ⇒ V): V
  22. def getOrElseUpdate(i: Int, value: ⇒ V): V
  23. def hashCode(): Int
    Definition Classes
    SparseArray → AnyRef → Any
  24. var index: Array[Int]
  25. final def indexAt(i: Int): Int

    Gives the logical index from the physical index.

    Gives the logical index from the physical index.

    Definition Classes
    SparseArray → Storage
  26. def isActive(i: Int): Boolean

    Some storages (namely HashStorage) won't have active indices packed.

    Some storages (namely HashStorage) won't have active indices packed. This lets you know if the bin is actively in use.

    i

    index into index/data arrays

    Definition Classes
    SparseArray → Storage
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def iterableSize: Int

    How many elements must be iterated over using valueAt/indexAt.

    How many elements must be iterated over using valueAt/indexAt. In HashVectors, activeSize is the number of non-zero elements, while iterableSize is the number of buckets currently allocated. (activeSize <= iterableSize in general, activeSize == iterableSize for everything except hashing implementations.)

    Definition Classes
    Storage
  29. def iterator: Iterator[(Int, V)]

    Only iterates "active" elements

    Only iterates "active" elements

    Definition Classes
    ArrayLike
  30. def keysIterator: Iterator[Int]

    Only iterates "active" keys

    Only iterates "active" keys

    Definition Classes
    SparseArray → ArrayLike
  31. def length: Int
    Definition Classes
    ArrayLike
  32. def map[B](f: (V) ⇒ B)(implicit arg0: ClassTag[B], arg1: Zero[B]): SparseArray[B]

    Maps all values.

    Maps all values. If f(this.default) is not equal to the new default value, the result may be an efficiently dense (or almost dense) paired array.

  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. def quickCompact(): Unit

    Like compact, but doesn't look for defaultValues that can be removed.

  37. def reserve(nnz: Int): Unit
  38. val size: Int

    How many elements are logically stored here.

    How many elements are logically stored here. This may be <= activeSize.

    Definition Classes
    SparseArray → Storage → ArrayLike
  39. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  40. def toArray[U >: V](implicit arg0: ClassTag[U]): Array[U]
    Definition Classes
    ArrayLike
  41. def toIndexedSeq: List[V]
    Definition Classes
    ArrayLike
  42. def toList: List[V]
    Definition Classes
    ArrayLike
  43. def toMap: Map[Int, V]
    Definition Classes
    ArrayLike
  44. def toString(): String
    Definition Classes
    SparseArray → AnyRef → Any
  45. final def update(i: Int, value: V): Unit

    Sets the given value at the given index if the value is not equal to the current default.

    Sets the given value at the given index if the value is not equal to the current default. The data and index arrays will be grown to support the insertion if necessary. The growth schedule doubles the amount of allocated memory at each allocation request up until the sparse array contains 1024 values, at which point the growth is additive: an additional n * 1024 spaces will be allocated for n in 1,2,4,8,16. The largest amount of space added to this vector will be an additional 16*1024*(sizeof(Elem)+4), which is 196608 bytes at a time for a SparseVector[Double], although more space is needed temporarily while moving to the new arrays.

    Definition Classes
    SparseArray → ArrayLike
    Annotations
    @inline()
  46. def use(index: Array[Int], data: Array[V], used: Int): Unit
  47. final def valueAt(i: Int): V

    same as data(i).

    same as data(i). Gives the value at the underlying offset.

    i

    index into the data array

    Definition Classes
    SparseArray → Storage
  48. def valuesIterator: Iterator[V]

    Only iterates "active" elements

    Only iterates "active" elements

    Definition Classes
    SparseArray → ArrayLike
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Storage[V]

Inherited from ArrayLike[V]

Inherited from AnyRef

Inherited from Any

Ungrouped