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

Concise view

Type members

Classlikes

case class IndexException(err: String) extends RuntimeException

Provides an index-specific exception

Provides an index-specific exception

Attributes

err

Error message

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

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

Attributes

C

Type of elements in Vec

values

Vec

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

Attributes

C

Type of elements in array

arr

Array

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) : _*)

Attributes

C

Type of elements in Seq

values

Seq[C]

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

Factor method to create an empty Index

Factor method to create an empty Index

Attributes

C

type of Index

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

Attributes

I

The type of the values input

O

The type of the elements of the result index

ev

Implicit evidence of an IndexMaker that can utilize values

values

Values from which to construct the index