Index

org.saddle.Index$
See theIndex companion trait
object Index

Attributes

Companion
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Index.type

Members list

Type members

Classlikes

case class IndexException(err: String) extends RuntimeException

Provides an index-specific exception

Provides an index-specific exception

Value parameters

err

Error message

Attributes

Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all

Value members

Concrete methods

def apply[C : Order](values: Vec[C]): Index[C]

Factory method to create an index from a Vec of elements

Factory method to create an index from a Vec of elements

Type parameters

C

Type of elements in Vec

Value parameters

values

Vec

Attributes

def apply[C : Order](arr: Array[C]): Index[C]

Factory method to create an index from an array of elements

Factory method to create an index from an array of elements

Type parameters

C

Type of elements in array

Value parameters

arr

Array

Attributes

def apply[C : Order](values: C*): Index[C]

Factory method to create an index from a sequence of elements, eg

Factory method to create an index from a sequence of elements, eg

 Index(1,2,3)
 Index(IndexedSeq(1,2,3) : _*)

Type parameters

C

Type of elements in Seq

Value parameters

values

Seq[C]

Attributes

def empty[C : Order]: Index[C]

Factor method to create an empty Index

Factor method to create an empty Index

Type parameters

C

type of Index

Attributes

def make[I, O](values: I)(implicit ev: IndexMaker[I, O]): Index[O]

Factory method to create an Index; the basic use case is to construct a multi-level index (i.e., an Index of Tuples) via a Tuple of Vecs.

Factory method to create an Index; the basic use case is to construct a multi-level index (i.e., an Index of Tuples) via a Tuple of Vecs.

For instance:

 Index.make(vec.rand(10), vec.rand(10))

Type parameters

I

The type of the values input

O

The type of the elements of the result index

Value parameters

ev

Implicit evidence of an IndexMaker that can utilize values

values

Values from which to construct the index

Attributes