IndexInt

Returns offsets into index that would result in sorted index

Concatenate two Index objects together

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

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.

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.

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

Number of elements in the index

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

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

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

Returns the index in reversed order

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

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

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

See also org.saddle.array.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.

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

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 a sequence of keys, return the sequence of locations in the index at which those keys correspondingly occur, ignoring keys which do not exist.

Retrieve several elements from the index at provided offsets

Retrieve several elements from the index at provided offets

Retrieve an element of the index at a particular offset

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

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.

Return the index of distinct values. Keeps order of first occurences.

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

Returns true if there is an element which satisfies the predicate 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.

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

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.

Get location offsets within Index given a particular key

Get first integer offset of a key

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.

Get last integer offset of a key

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 true if there are no duplicate keys in the Index

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

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

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

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

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

Creates a string representation of Index

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

Convert Index elements to an IndexedSeq.

Returns a string representation of the object.

The default representation is platform dependent.

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 an array of unique keys in the Index, in the order in which they originally appeared in the backing Vec.

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