org

saddle

package saddle

Saddle

Saddle is a Scala Data Library.

Saddle provides array-backed, indexed one- and two-dimensional data structures.

These data structures are specialized on JVM primitives. With them one can often avoid the overhead of boxing and unboxing.

Basic operations also aim to be robust to missing values (NA's)

The building blocks are intended to be easily composed.

Additionally, there are some numerical utilities: eg, a fast suite of org.saddle.util.Random number generators).

The foundational building blocks are:

Inspiration for Saddle comes from many sources, including the R programming language, the pandas data analysis library for Python, and the Scala collections library.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. saddle
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait Buffer[T] extends AnyRef

    Buffer provides a mutable data structure specialized on several primitive types.

  2. type CLM[C] = ClassTag[C]

    Type alias shorthand for class manifest evidence

  3. class Frame[RX, CX, T] extends NumericOps[Frame[RX, CX, T]]

    Frame is an immutable container for 2D data which is indexed along both axes (rows, columns) by associated keys (i.

  4. trait Index[T] extends AnyRef

    Index provides a constant-time look-up of a value within array-backed storage, as well as operations to support joining and slicing.

  5. trait Mat[A] extends NumericOps[Mat[A]]

    Mat is an immutable container for 2D homogeneous data (a "matrix").

  6. type NUM[C] = Numeric[C]

    Type alias shorthand for numeric evidence

  7. type ORD[C] = Ordering[C]

    Type alias: something is comparable if there is an ordering for it

  8. type ST[C] = ScalarTag[C]

    Type alias shorthand for scalar tag evidence

  9. class Series[X, T] extends NumericOps[Series[X, T]]

    Series is an immutable container for 1D homogeneous data which is indexed by a an associated sequence of keys.

  10. trait Vec[A] extends NumericOps[Vec[A]]

    Vec is an immutable container for 1D homogeneous data (a "vector").

Value Members

  1. def *: SliceAll

    Syntactic sugar, placeholder for 'slice-all'

    Syntactic sugar, placeholder for 'slice-all'

    val v = Vec(1,2,3, 4)
    val u = v(*)
  2. object Buffer

  3. object Frame extends BinOpFrame

  4. object Index

  5. object Mat extends BinOpMat

  6. object Panel

    Convenience constructors for a Frame[RX, CX, Any] that accept arbitrarily-typed Vectors and Series as constructor parameters, leaving their internal representations unchanged.

  7. object Series extends BinOpSeries

  8. object Vec extends BinOpVec

  9. def clock[T](op: ⇒ T): (Double, T)

    Allow timing of an operation

    Allow timing of an operation

    clock { bigMat.T dot bigMat }
  10. implicit def dtOrdering: Ordering[DateTime]

    Provides an implicit ordering for DateTime

  11. package groupby

  12. package index

  13. package io

  14. package locator

  15. package mat

  16. object na

    na provides syntactic sugar for constructing primitives recognized as NA.

  17. package ops

    Provides type aliases for a few basic operations

  18. implicit def pair2Slice[T](p: (T, T)): SliceDefault[T]

    Syntactic sugar, allow '->' to generate an (inclusive) index slice

    Syntactic sugar, allow '->' to generate an (inclusive) index slice

    val v = Vec(1,2,3,4)
    val u = v(0 -> 2)
  19. implicit def pair2SliceFrom[T](p: (T, SliceAll)): SliceFrom[T]

    Syntactic sugar, allow ' -> *' to generate an (inclusive) index slice, open on right

    Syntactic sugar, allow ' -> *' to generate an (inclusive) index slice, open on right

    val v = Vec(1,2,3,4)
    val u = v(1 -> *)
  20. implicit def pair2SliceSingle[T](k: T): SliceDefault[T]

    Provides for one-element slicing, e.

    Provides for one-element slicing, e.g.

    val v = Vec(1,2,3, 4)
    val u = v(1)
  21. implicit def pair2SliceTo[T](p: (SliceAll, T)): SliceTo[T]

    Syntactic sugar, allow '* -> ' to generate an (inclusive) index slice, open on left

    Syntactic sugar, allow '* -> ' to generate an (inclusive) index slice, open on left

    val v = Vec(1,2,3,4)
    val u = v(* -> 2)
  22. package scalar

  23. implicit def seqToFrame[RX, CX, T](s: Seq[(RX, CX, T)])(implicit arg0: ORD[RX], arg1: ST[RX], arg2: ORD[CX], arg3: ST[CX], arg4: ST[T]): AnyRef { def toFrame: org.saddle.Frame[RX,CX,T] }

    Augments Seq with a toFrame method that returns a new Frame instance.

    Augments Seq with a toFrame method that returns a new Frame instance.

    For example,

    val t = IndexedSeq(("a", "x", 3), ("b", "y", 4))
    val f = t.toFrame
    
    res0: org.saddle.Frame[java.lang.String,java.lang.String,Int] =
    [2 x 2]
          x  y
         -- --
    a ->  3 NA
    b -> NA  4
    RX

    Type of row index elements of Frame

    CX

    Type of col index elements of Frame

    T

    Type of data elements of Frame

    s

    A value of type Seq[(RX, CX, T)]

  24. implicit def seqToIndex[X](ix: Seq[X])(implicit arg0: ST[X], arg1: ORD[X]): AnyRef { def toIndex: org.saddle.Index[X] }

    Augments Seq with a toIndex method that returns a new Index instance.

    Augments Seq with a toIndex method that returns a new Index instance.

    For example,

    val i = IndexedSeq(1,2,3)
    val s = i.toIndex
    X

    Type of index elements

    ix

    A value of type Seq[X]

  25. implicit def seqToSeries[T, X](s: Seq[(X, T)])(implicit arg0: ST[T], arg1: ST[X], arg2: ORD[X]): AnyRef { def toSeries: org.saddle.Series[X,T] }

    Augments Seq with a toSeries method that returns a new Series instance.

    Augments Seq with a toSeries method that returns a new Series instance.

    For example,

    val p = IndexedSeq(1,2,3) zip IndexedSeq(4,5,6)
    val s = p.toSeries
    T

    Type of data elements of Series

    X

    Type of index elements of Series

    s

    A value of type Seq[(X, T)]

  26. implicit def seqToVec[T](s: Seq[T])(implicit arg0: ST[T]): AnyRef { def toVec: org.saddle.Vec[T] }

    Augments Seq with a toVec method that returns a new Vec instance.

    Augments Seq with a toVec method that returns a new Vec instance.

    For example,

    val s = IndexedSeq(1,2,3)
    val v = s.toVec
    T

    Type of elements of Vec

    s

    A value of type Seq[T]

  27. package stats

  28. package time

    Functionality to assist in TimeSeries related operations

  29. package util

    Additional utilities that need a home

  30. package vec

    Factory methods to generate Vec instances

Inherited from AnyRef

Inherited from Any

Ungrouped