IndexInt

class IndexInt(keys: Vec[Int], val ord: Order[Int]) extends Index[Int]

Index with integer keys

trait Index[Int]
class Object
trait Matchable
class Any

Value members

Concrete methods

def argSort: Array[Int]
def concat(x: Index[Int]): Index[Int]
override 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
Index -> Any
def intersect(other: Index[Int]): ReIndexer[Int]
def isContiguous: Boolean
def isMonotonic: Boolean
def join(other: Index[Int], how: JoinType): ReIndexer[Int]
def length: Int
def lsearch(t: Int): Int
def map[@specialized(Boolean, Int, Long, Double) B : Order](f: Int => B): Index[B]
def raw(idx: Int): Int
def reversed: Index[Int]
def rsearch(t: Int): Int
def slice(from: Int, until: Int, stride: Int): Index[Int]
def take(locs: Array[Int]): Index[Int]
def toArray: Array[Int]
def toVec: Vec[Int]
def union(other: Index[Int]): ReIndexer[Int]
def without(locs: Array[Int]): Index[Int]

Inherited methods

def apply(keys: Array[Int]): 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.

Value parameters:
keys

Sequence of keys to find

Inherited from:
Index
def apply(keys: Int*): 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.

Value parameters:
keys

Sequence of keys to find

Inherited from:
Index
def at(locs: Int*): Index[Int]

Retrieve several elements from the index at provided offsets

Retrieve several elements from the index at provided offsets

Value parameters:
locs

A sequence of integer offsets

Inherited from:
Index
def at(locs: Array[Int]): Index[Int]

Retrieve several elements from the index at provided offets

Retrieve several elements from the index at provided offets

Value parameters:
locs

An array of integer offsets

Inherited from:
Index
def at(loc: Int): Scalar[Int]

Retrieve an element of the index at a particular offset

Retrieve an element of the index at a particular offset

Value parameters:
loc

Offset into index

Inherited from:
Index
def contains(key: Int): 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

Value parameters:
key

Key to query

Inherited from:
Index
def count(key: Int): Int

Return the number of times the key occurs in the index

Return the number of times the key occurs in the index

Value parameters:
key

The key to query

Inherited from:
Index
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.

Inherited from:
Index
def distinct(implicit st: ScalarTag[Int], ord: Order[Int]): Index[Int]

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

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

Inherited from:
Index
def dropLevel[U](implicit ev: Splitter[Int, 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.

Type parameters:
U

Type of elements of result index

Value parameters:
ev

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

Inherited from:
Index
def exists(pred: Int => 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,

Value parameters:
pred

Function from T => Boolean

Inherited from:
Index
def findOne(pred: Int => 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.

Value parameters:
pred

Function from T => Boolean

Inherited from:
Index
def first: Scalar[Int]

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

Inherited from:
Index
def firsts(keys: Array[Int]): Array[Int]

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.

Value parameters:
keys

Sequence of keys to find

Inherited from:
Index
def get(key: Int): Array[Int]

Get location offsets within Index given a particular key

Get location offsets within Index given a particular key

Value parameters:
key

Key with which to search

Inherited from:
Index
def getFirst(key: Int): Int

Get first integer offset of a key

Get first integer offset of a key

Value parameters:
key

Key to find in index

Inherited from:
Index
def getIndexer(other: Index[Int]): Option[Array[Int]]

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.

Value parameters:
other

The other index with which to generate offsets

Inherited from:
Index
def getLast(key: Int): Int

Get last integer offset of a key

Get last integer offset of a key

Value parameters:
key

Key to find in index

Inherited from:
Index
override 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 -> Any
Inherited from:
Index
def head(n: Int): Index[Int]

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

Value parameters:
n

Number of elements to slice

Inherited from:
Index
def isEmpty: Boolean
Inherited from:
Index
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

Inherited from:
Index
def last: Scalar[Int]

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

Inherited from:
Index
def next(current: Scalar[Int]): Scalar[Int]

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.

Value parameters:
current

Key value to find

Inherited from:
Index
def nonEmpty: Boolean
Inherited from:
Index
def prev(current: Scalar[Int]): Scalar[Int]

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.

Value parameters:
current

Key value to find

Inherited from:
Index
def sliceBy(rng: Slice[Int]): Index[Int]

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.

Value parameters:
rng

An instance of

Inherited from:
Index
def sliceBy(from: Int, to: Int, inclusive: Boolean): Index[Int]

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.

Value parameters:
from

Key lower bound

inclusive

If true (default), include upper bound in slice

to

Key upper bound

Inherited from:
Index
def sorted: Index[Int]

Returns the index in sorted (ascending) order

Returns the index in sorted (ascending) order

Inherited from:
Index
def split[O1, O2](implicit ev: Splitter[Int, 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.

Type parameters:
O1

Left index type (of arity N-1)

O2

Right index type (of arity 1)

Value parameters:
ev

Implicit evidence of an instance of Splitter

Inherited from:
Index
def stack[U, V](other: Index[U])(implicit ev: Stacker[Int, 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. 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.

Type parameters:
U

The input type, of arity 1

V

The result type, of arity N+1

Value parameters:
ev

Implicit evidence of a Stacker

other

Another Index

Inherited from:
Index
def stringify(len: Int): String

Creates a string representation of Index

Creates a string representation of Index

Value parameters:
len

Max number of elements to include

Inherited from:
Index
def tail(n: Int): Index[Int]

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

Value parameters:
n

Number of elements to slice

Inherited from:
Index
def toSeq: IndexedSeq[Int]

Convert Index elements to an IndexedSeq.

Convert Index elements to an IndexedSeq.

Inherited from:
Index
override def toString: String
Definition Classes
Index -> Any
Inherited from:
Index
def toUniqueIndex(implicit ord: Order[Int]): Index[(Int, Int)]

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

Inherited from:
Index
def uniques(implicit ord: Order[Int], tag: ScalarTag[Int]): Index[Int]

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.

Value parameters:
ord

Implicit ORD for instances of type T

tag

Implicit ST for instances of type T

Inherited from:
Index

Concrete fields

val ord: Order[Int]