org.saddle.index

IndexDouble

class IndexDouble extends Index[Double]

Index with double keys

Linear Supertypes
Index[Double], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. IndexDouble
  2. Index
  3. Serializable
  4. Serializable
  5. AnyRef
  6. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IndexDouble(keys: Vec[Double])

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. def apply(keys: Array[Double]): Array[Int]

    Given an array of keys, return the sequence of locations in the index at which those keys correspondingly occur, ignoring keys which do not exist.

    Given an array of keys, return the sequence of locations in the index at which those keys correspondingly occur, ignoring keys which do not exist.

    keys

    Sequence of keys to find

    Definition Classes
    Index
  7. def apply(keys: Double*): Array[Int]

    Given a sequence of keys, return the sequence of locations in the index at which those keys correspondingly occur, ignoring keys which do not exist.

    Given a sequence of keys, return the sequence of locations in the index at which those keys correspondingly occur, ignoring keys which do not exist.

    keys

    Sequence of keys to find

    Definition Classes
    Index
  8. def argSort: Array[Int]

    Returns offsets into index that would result in sorted index

    Returns offsets into index that would result in sorted index

    Definition Classes
    IndexDoubleIndex
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def at(locs: Int*): Index[Double]

    Retrieve several elements from the index at provided offsets

    Retrieve several elements from the index at provided offsets

    locs

    A sequence of integer offsets

    Definition Classes
    Index
  11. def at(locs: Array[Int]): Index[Double]

    Retrieve several elements from the index at provided offets

    Retrieve several elements from the index at provided offets

    locs

    An array of integer offsets

    Definition Classes
    Index
  12. def at(loc: Int): Scalar[Double]

    Retrieve an element of the index at a particular offset

    Retrieve an element of the index at a particular offset

    loc

    Offset into index

    Definition Classes
    Index
  13. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  14. def concat[B, C](x: Index[B])(implicit wd: Promoter[Double, B, C], mc: ST[C], oc: ORD[C]): Index[C]

    Concatenate two Index objects together

    Concatenate two Index objects together

    B

    Type of other index

    C

    Result of promoting types A, B

    mc

    Implicit evidence of ST[C]

    oc

    Implicit evidence of ORD[C]

    Definition Classes
    IndexDoubleIndex
  15. def contains(key: Double): Boolean

    Returns true if the index contains at least one entry equal to the provided key

    Returns true if the index contains at least one entry equal to the provided key

    key

    Key to query

    Definition Classes
    Index
  16. def count(key: Double): Int

    Return the number of times the key occurs in the index

    Return the number of times the key occurs in the index

    key

    The key to query

    Definition Classes
    Index
  17. def counts: Array[Int]

    Returns an array whose entries represent the number of times the corresponding entry in uniques occurs within the index.

    Returns an array whose entries represent the number of times the corresponding entry in uniques occurs within the index.

    Definition Classes
    Index
  18. def dropLevel[U, _](implicit ev: org.saddle.index.Splitter[Double, U, _]): Index[U]

    For an index which contains Tuples, drop the right-most element of each tuple, resulting in a new index.

    For an index which contains Tuples, drop the right-most element of each tuple, resulting in a new index.

    U

    Type of elements of result index

    ev

    Implicit evidence of a Splitter instance that takes T (of arity N) to U (of arity N-1)

    Definition Classes
    Index
  19. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  20. def equals(o: Any): Boolean

    Default equality does an iterative, element-wise equality check of all values.

    Default equality does an iterative, element-wise equality check of all values.

    Definition Classes
    IndexDoubleIndex → AnyRef → Any
  21. def exists(pred: (Double) ⇒ Boolean): Boolean

    Returns true if there is an element which satisfies the predicate function,

    Returns true if there is an element which satisfies the predicate function,

    pred

    Function from T => Boolean

    Definition Classes
    Index
  22. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  23. def findOne(pred: (Double) ⇒ Boolean): Int

    Returns the int location of the first element of the index to satisfy the predicate function, or -1 if no element satisfies the function.

    Returns the int location of the first element of the index to satisfy the predicate function, or -1 if no element satisfies the function.

    pred

    Function from T => Boolean

    Definition Classes
    Index
  24. def first: Scalar[Double]

    Returns the first element of the Index, or NA if there is none

    Returns the first element of the Index, or NA if there is none

    Definition Classes
    Index
  25. def get(key: Double): Array[Int]

    Get location offsets within Index given a particular key

    Get location offsets within Index given a particular key

    key

    Key with which to search

    Definition Classes
    Index
  26. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  27. def getFirst(key: Double): Int

    Get first integer offset of a key

    Get first integer offset of a key

    key

    Key to find in index

    Definition Classes
    Index
  28. def getIndexer(other: Index[Double]): Option[Array[Int]]

    Generates offsets into current index given another index for the purposes of re-indexing.

    Generates offsets into current index given another index for the purposes of re-indexing. For more on reindexing, see ReIndexer. If the current and other indexes are equal, a value of None is returned.

    other

    The other index with which to generate offsets

    Definition Classes
    Index
  29. def getLast(key: Double): Int

    Get last integer offset of a key

    Get last integer offset of a key

    key

    Key to find in index

    Definition Classes
    Index
  30. def hashCode(): Int

    Default hashcode is simple rolling prime multiplication of sums of hashcodes for all values.

    Default hashcode is simple rolling prime multiplication of sums of hashcodes for all values.

    Definition Classes
    Index → AnyRef → Any
  31. def head(n: Int): Index[Double]

    Returns a slice comprised of at most the first n elements of the Index

    Returns a slice comprised of at most the first n elements of the Index

    n

    Number of elements to slice

    Definition Classes
    Index
  32. def intersect(other: Index[Double]): ReIndexer[Double]

    Produces a ReIndexer corresponding to the intersection of this Index with another.

    Produces a ReIndexer corresponding to the intersection of this Index with another. Both indexes must have set semantics - ie, have no duplicates.

    other

    The other index

    Definition Classes
    IndexDoubleIndex
  33. def isContiguous: Boolean

    Returns true if the index is either unique, or any two or more duplicate keys occur in consecutive locations in the index.

    Returns true if the index is either unique, or any two or more duplicate keys occur in consecutive locations in the index.

    Definition Classes
    IndexDoubleIndex
  34. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  35. def isMonotonic: Boolean

    Returns true if the ordering of the elements of the Index is non-decreasing.

    Returns true if the ordering of the elements of the Index is non-decreasing.

    Definition Classes
    IndexDoubleIndex
  36. def isUnique: Boolean

    Returns true if there are no duplicate keys in the Index

    Returns true if there are no duplicate keys in the Index

    Definition Classes
    Index
  37. def join(other: Index[Double], how: JoinType = LeftJoin): ReIndexer[Double]

    Allows for the following SQL-style joins between this index and another:

    Allows for the following SQL-style joins between this index and another:

    • org.saddle.index.LeftJoin
    • org.saddle.index.RightJoin
    • org.saddle.index.InnerJoin
    • org.saddle.index.OuterJoin
    other

    Another index

    how

    join type, see JoinType

    Definition Classes
    IndexDoubleIndex
  38. def last: Scalar[Double]

    Returns the last element of the Index, or NA if there is none

    Returns the last element of the Index, or NA if there is none

    Definition Classes
    Index
  39. def length: Int

    Number of elements in the index

    Number of elements in the index

    Definition Classes
    IndexDoubleIndex
  40. def locator: Locator[Double]

    Attributes
    protected
    Definition Classes
    IndexDoubleIndex
  41. def lsearch(t: Double): Int

    Find the first location whereby inserting a key would maintain a sorted index.

    Find the first location whereby inserting a key would maintain a sorted index. Index must already be sorted.

    t

    Key that would be inserted

    Definition Classes
    IndexDoubleIndex
  42. def map[B](f: (Double) ⇒ B)(implicit arg0: ST[B], arg1: ORD[B]): Index[B]

    Map over the elements in the Index, producing a new Index, similar to Map in the Scala collections.

    Map over the elements in the Index, producing a new Index, similar to Map in the Scala collections.

    B

    Type of resulting elements

    f

    Function to map with

    Definition Classes
    IndexDoubleIndex
  43. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  44. def next(current: Scalar[Double]): Scalar[Double]

    Given a key, return the next value in the Index (in the natural, ie supplied, order).

    Given a key, return the next value in the Index (in the natural, ie supplied, order). The Index must at least be contiguous, if not unique.

    current

    Key value to find

    Definition Classes
    Index
  45. final def notify(): Unit

    Definition Classes
    AnyRef
  46. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  47. def prev(current: Scalar[Double]): Scalar[Double]

    Given a key, return the previous value in the Index (in the natural, ie supplied, order).

    Given a key, return the previous value in the Index (in the natural, ie supplied, order). The Index must at least be contiguous, if not unique.

    current

    Key value to find

    Definition Classes
    Index
  48. def print(len: Int = 10, stream: OutputStream = System.out): Unit

    Pretty-printer for Index, which simply outputs the result of stringify.

    Pretty-printer for Index, which simply outputs the result of stringify.

    len

    Number of elements to display

    Definition Classes
    Index
  49. def raw(idx: Int): Double

    Access an element directly within the index, without wrapping in a Scalar box.

    Access an element directly within the index, without wrapping in a Scalar box.

    Definition Classes
    IndexDoubleIndex
  50. def reversed: Index[Double]

    Returns the index in reversed order

    Returns the index in reversed order

    Definition Classes
    IndexDoubleIndex
  51. def rsearch(t: Double): Int

    Find the last location whereby inserting a key would maintain a sorted index.

    Find the last location whereby inserting a key would maintain a sorted index. Index must already be sorted.

    t

    Key that would be inserted

    Definition Classes
    IndexDoubleIndex
  52. val scalarTag: org.saddle.scalar.ScalarTagDouble.type

    A ScalarTag representing the kind of Scalar found in this index.

    A ScalarTag representing the kind of Scalar found in this index.

    Definition Classes
    IndexDoubleIndex
  53. def slice(from: Int, until: Int, stride: Int): Index[Double]

    Returns a slice of Index between two integers, including the from bound, and excluding the until bound.

    Returns a slice of Index between two integers, including the from bound, and excluding the until bound.

    from

    Int, lower bound

    until

    Int, one past upper bound

    stride

    Default is 1, the step with which to advance over bound

    Definition Classes
    IndexDoubleIndex
  54. def sliceBy(rng: Slice[Double]): Index[Double]

    Returns a slice of Index between two keys, including both the lower and upper keys.

    Returns a slice of Index between two keys, including both the lower and upper keys.

    rng

    An instance of

    Definition Classes
    Index
  55. def sliceBy(from: Double, to: Double, inclusive: Boolean = true): Index[Double]

    Returns a slice of an index between two keys; if inclusive is false, then exclude the upper bound.

    Returns a slice of an index between two keys; if inclusive is false, then exclude the upper bound. Index must be sorted, as this method relies on lsearch and rsearch.

    from

    Key lower bound

    to

    Key upper bound

    inclusive

    If true (default), include upper bound in slice

    Definition Classes
    Index
  56. def sorted: Index[Double]

    Returns the index in sorted (ascending) order

    Returns the index in sorted (ascending) order

    Definition Classes
    Index
  57. def split[O1, O2](implicit ev: Splitter[Double, O1, O2]): (Index[O1], Index[O2])

    Given this index contains tuples of arity N > 1, split will result in a pair of index instances; the left will have elements of arity N-1, and the right arity 1.

    Given this index contains tuples of arity N > 1, split will result in a pair of index instances; the left will have elements of arity N-1, and the right arity 1.

    O1

    Left index type (of arity N-1)

    O2

    Right index type (of arity 1)

    ev

    Implicit evidence of an instance of Splitter

    Definition Classes
    Index
  58. def stack[U, V](other: Index[U])(implicit ev: Stacker[Double, U, V]): Index[V]

    Given this index whose elements have arity N and another index of arity 1, form a result index whose entries are tuples of arity N+1 reflecting the Cartesian product of the two, in the provided order.

    Given this index whose elements have arity N and another index of arity 1, form a result index whose entries are tuples of arity N+1 reflecting the Cartesian product of the two, in the provided order. See Stacker for more details.

    U

    The input type, of arity 1

    V

    The result type, of arity N+1

    other

    Another Index

    ev

    Implicit evidence of a Stacker

    Definition Classes
    Index
  59. def stringify(len: Int = 10): String

    Creates a string representation of Index

    Creates a string representation of Index

    len

    Max number of elements to include

    Definition Classes
    Index
  60. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  61. def tail(n: Int): Index[Double]

    Returns a slice comprised of at most the last n elements of the Index

    Returns a slice comprised of at most the last n elements of the Index

    n

    Number of elements to slice

    Definition Classes
    Index
  62. def take(locs: Array[Int]): Index[Double]

    Take values of the index at certain locations, returning a new Index consisting of those values.

    Take values of the index at certain locations, returning a new Index consisting of those values.

    See also org.saddle.array.take

    locs

    Locations to take

    Definition Classes
    IndexDoubleIndex
  63. def toArray: Array[Double]

    Definition Classes
    IndexDoubleIndex
  64. def toSeq: IndexedSeq[Double]

    Convert Index elements to an IndexedSeq.

    Convert Index elements to an IndexedSeq.

    Definition Classes
    Index
  65. def toString(): String

    Definition Classes
    Index → AnyRef → Any
  66. def toVec: Vec[Double]

    Convert Index to a Vec

    Convert Index to a Vec

    Definition Classes
    IndexDoubleIndex
  67. def union(other: Index[Double]): ReIndexer[Double]

    Produces a ReIndexer corresponding to the union of this Index with another.

    Produces a ReIndexer corresponding to the union of this Index with another. Both indexes must have set semantics - ie, have no duplicates.

    other

    The other index

    Definition Classes
    IndexDoubleIndex
  68. def uniques(implicit ord: ORD[Double], tag: ST[Double]): Index[Double]

    Returns an array of unique keys in the Index, in the order in which they originally appeared in the backing Vec.

    Returns an array of unique keys in the Index, in the order in which they originally appeared in the backing Vec.

    ord

    Implicit ORD for instances of type T

    tag

    Implicit ST for instances of type T

    Definition Classes
    Index
  69. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  72. def without(locs: Array[Int]): Index[Double]

    Complement of the take method; return a new Index whose values are those which do not occur at the specified locations.

    Complement of the take method; return a new Index whose values are those which do not occur at the specified locations.

    locs

    Locations to omit

    Definition Classes
    IndexDoubleIndex

Inherited from Index[Double]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any