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.
Sequence of keys to find
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.
Sequence of keys to find
Returns offsets into index that would result in sorted index
Returns offsets into index that would result in sorted index
Retrieve several elements from the index at provided offsets
Retrieve several elements from the index at provided offsets
A sequence of integer offsets
Retrieve several elements from the index at provided offets
Retrieve several elements from the index at provided offets
An array of integer offsets
Retrieve an element of the index at a particular offset
Concatenate two Index objects together
Concatenate two Index objects together
Type of other index
Result of promoting types A, B
Implicit evidence of ST[C]
Implicit evidence of ORD[C]
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 to query
Return the number of times the key occurs in the index
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.
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.
Type of elements of result index
Implicit evidence of a Splitter instance that takes T (of arity N) to U (of arity N-1)
Default equality does an iterative, element-wise equality check of all values.
Default equality does an iterative, element-wise equality check of all values.
Returns true if there is an element which satisfies the predicate function,
Returns true if there is an element which satisfies the predicate function,
Function from T => Boolean
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.
Function from T => Boolean
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
Get location offsets within Index given a particular key
Get location offsets within Index given a particular key
Key with which to search
Get first integer offset of a key
Generates offsets into current index given another index for the purposes of re-indexing.
Get last integer offset of a key
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.
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
Number of elements to slice
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.
The other index
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.
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.
Returns true if there are no duplicate keys in the Index
Returns true if there are no duplicate keys in the Index
Allows for the following SQL-style joins between this index and another:
Allows for the following SQL-style joins between this index and another:
Another index
join type, see JoinType
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
Number of elements in the index
Number of elements in the index
Custom implementation of a Locator to serve as the backing map in a more space-efficient manner than the full blown LocatorInt implementation.
Custom implementation of a Locator to serve as the backing map in a more space-efficient manner than the full blown LocatorInt implementation.
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.
Key that would be inserted
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.
Type of resulting elements
Function to map with
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.
Key value to find
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.
Key value to find
Pretty-printer for Index, which simply outputs the result of stringify.
Pretty-printer for Index, which simply outputs the result of stringify.
Number of elements to display
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.
Offset into the index
Returns the index in reversed order
Returns the index in reversed order
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.
Key that would be inserted
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.
Int, lower bound
Int, one past upper bound
Default is 1, the step with which to advance over bound
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.
An instance of
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.
Key lower bound
Key upper bound
If true (default), include upper bound in slice
Returns the index in sorted (ascending) order
Returns the index in sorted (ascending) order
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.
Left index type (of arity N-1)
Right index type (of arity 1)
Implicit evidence of an instance of Splitter
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.
The input type, of arity 1
The result type, of arity N+1
Another Index
Implicit evidence of a Stacker
Creates a string representation of Index
Creates a string representation of Index
Max number of elements to include
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
Number of elements to slice
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
Locations to take
Convert Index elements to an IndexedSeq.
Convert Index elements to an IndexedSeq.
Convert Index to a Vec
Convert Index to a Vec
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.
The other index
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.
Implicit ORD for instances of type T
Implicit ST for instances of type T
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.
Locations to omit
An implementation of an Index[Int] which implicitly represents a bound of integers, which lazily generates its elements as an array when needed. This compact representation is the default when creating a Saddle object such as Series which requires and index and one is not supplied.