Index provides a constant-time look-up of a value within array-backed storage, as well as operations to support joining and slicing.
Attributes
- Companion:
- object
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
Members list
Value members
Abstract methods
Returns offsets into index that would result in sorted index
Returns offsets into index that would result in sorted index
Attributes
Concatenate two Index objects together
Concatenate two Index objects together
Attributes
- B
Type of other index
- C
Result of promoting types A, B
- mc
Implicit evidence of ST[C]
- oc
Implicit evidence of ORD[C]
- other
Other index to concatenate
- p
Implicit evidence of a Promoter which can send both T and B to C
Produces a org.saddle.index.ReIndexer corresponding to the intersection of this Index with another. Both indexes must have set semantics - ie, have no duplicates.
Produces a org.saddle.index.ReIndexer corresponding to the intersection of this Index with another. Both indexes must have set semantics - ie, have no duplicates.
Attributes
- other
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.
Attributes
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.
Attributes
Allows for the following SQL-style joins between this index and another:
Allows for the following SQL-style joins between this index and another:
Attributes
- how
join type, see org.saddle.index.JoinType
- other
Another index
Number of elements in the index
Number of elements in the index
Attributes
Find the first location whereby inserting a key would maintain a sorted index. Index must already be sorted.
Find the first location whereby inserting a key would maintain a sorted index. Index must already be sorted.
Attributes
- t
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.
Attributes
- B
Type of resulting elements
- f
Function to map with
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.
Attributes
- loc
Offset into the index
Returns the index in reversed order
Returns the index in reversed order
Attributes
Find the last location whereby inserting a key would maintain a sorted index. Index must already be sorted.
Find the last location whereby inserting a key would maintain a sorted index. Index must already be sorted.
Attributes
- t
Key that would be inserted
A org.saddle.scalar.ScalarTag representing the kind of Scalar found in this index.
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.
Attributes
- from
Int, lower bound
- stride
Default is 1, the step with which to advance over bound
- until
Int, one past upper bound
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
Attributes
- locs
Locations to take
Convert Index to a org.saddle.Vec
Produces a org.saddle.index.ReIndexer corresponding to the union of this Index with another. Both indexes must have set semantics - ie, have no duplicates.
Produces a org.saddle.index.ReIndexer corresponding to the union of this Index with another. Both indexes must have set semantics - ie, have no duplicates.
Attributes
- other
The other index
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.
Attributes
- locs
Locations to omit
Concrete methods
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.
Attributes
- keys
Sequence of keys to find
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.
Attributes
- keys
Sequence of keys to find
Retrieve an element of the index at a particular offset
Retrieve an element of the index at a particular offset
Attributes
- loc
Offset into index
Retrieve several elements from the index at provided offets
Retrieve several elements from the index at provided offets
Attributes
- locs
An array of integer offsets
Retrieve several elements from the index at provided offsets
Retrieve several elements from the index at provided offsets
Attributes
- locs
A sequence of integer offsets
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
Attributes
- key
Key to query
Return the number of times the key occurs in the index
Return the number of times the key occurs in the index
Attributes
- key
The key to query
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.
Attributes
Return the index of distinct values. Keeps order of first occurences.
Return the index of distinct values. Keeps order of first occurences.
Attributes
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.
Attributes
- 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)
Default equality does an iterative, element-wise equality check of all values.
Default equality does an iterative, element-wise equality check of all values.
Attributes
- Definition Classes
- Any
Returns true if there is an element which satisfies the predicate function,
Returns true if there is an element which satisfies the predicate function,
Attributes
- pred
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.
Attributes
- pred
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
Attributes
Given a sequence of keys, return the sequence of first 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 first locations in the index at which those keys correspondingly occur, ignoring keys which do not exist.
Attributes
- keys
Sequence of keys to find
Get location offsets within Index given a particular key
Get location offsets within Index given a particular key
Attributes
- key
Key with which to search
Get first integer offset of a key
Get first integer offset of a key
Attributes
- key
Key to find in index
Generates offsets into current index given another index for the purposes of re-indexing. For more on reindexing, see org.saddle.index.ReIndexer. If the current and other indexes are equal, a value of None is returned.
Generates offsets into current index given another index for the purposes of re-indexing. For more on reindexing, see org.saddle.index.ReIndexer. If the current and other indexes are equal, a value of None is returned.
Attributes
- other
The other index with which to generate offsets
Get last integer offset of a key
Get last integer offset of a key
Attributes
- key
Key to find in index
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.
Attributes
- Definition Classes
- Any
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
Attributes
- n
Number of elements to slice
Returns true if there are no duplicate keys in the Index
Returns true if there are no duplicate keys in the Index
Attributes
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
Attributes
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.
Returns current
if it is the last.
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.
Returns current
if it is the last.
Attributes
- current
Key value to find
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.
Returns current
if it is the first.
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.
Returns current
if it is the first.
Attributes
- current
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.
Attributes
- len
Number of elements to display
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.
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.
Attributes
- from
Key lower bound
- inclusive
If true (default), include upper bound in slice
- to
Key upper 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.
Attributes
- rng
An instance of
Returns the index in sorted (ascending) order
Returns the index in sorted (ascending) order
Attributes
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.
Attributes
- O1
Left index type (of arity N-1)
- O2
Right index type (of arity 1)
- ev
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. See org.saddle.index.Stacker for more details.
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 org.saddle.index.Stacker for more details.
Attributes
- U
The input type, of arity 1
- V
The result type, of arity N+1
- ev
Implicit evidence of a Stacker
- other
Another Index
Creates a string representation of Index
Creates a string representation of Index
Attributes
- len
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
Attributes
- n
Number of elements to slice
Convert Index elements to an IndexedSeq.
Convert Index elements to an IndexedSeq.
Attributes
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
Attributes
- Returns:
a string representation of the object.
- Definition Classes
- Any
Returns a unique index where each element is paired up with a unique integer in [0,n) n being the multiplicity count of that element in the index
Returns a unique index where each element is paired up with a unique integer in [0,n) n being the multiplicity count of that element in the index
Attributes
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.
Attributes
- ord
Implicit ORD for instances of type T
- tag
Implicit ST for instances of type T