pan-data/pd.implicits/SeriesDouble

SeriesDouble

class SeriesDouble extends Series[Double]

Series extension for type Double.

Since

0.1.0

class Series[Double]
trait IndexOps[Series[Double]]
class Object
trait Matchable
class Any

Value members

Concrete methods

@targetName("times")
def *(series: SeriesDouble): Series[Double]
Since

0.1.0

@targetName("times")
def *(series: SeriesInt): Series[Double]
Since

0.1.0

@targetName("times")
def *(v: Double): Series[Double]
Since

0.1.0

@targetName("times")
def *(v: Int): Series[Double]
Since

0.1.0

@targetName("plus")
def +(series: SeriesDouble): Series[Double]
Since

0.1.0

@targetName("plus")
def +(series: SeriesInt): Series[Double]
Since

0.1.0

@targetName("plus")
def +(v: Double): Series[Double]
Since

0.1.0

@targetName("plus")
def +(v: Int): Series[Double]
Since

0.1.0

@targetName("minus")
def -(series: SeriesDouble): Series[Double]
Since

0.1.0

@targetName("minus")
def -(series: SeriesInt): Series[Double]
Since

0.1.0

@targetName("minus")
def -(v: Double): Series[Double]
Since

0.1.0

@targetName("minus")
def -(v: Int): Series[Double]
Since

0.1.0

@targetName("div")
def /(series: SeriesDouble): Series[Double]
Since

0.1.0

@targetName("div")
def /(series: SeriesInt): Series[Double]
Since

0.1.0

@targetName("div")
def /(v: Double): Series[Double]
Since

0.1.0

@targetName("div")
def /(v: Int): Series[Double]
Since

0.1.0

@targetName("smaller")
def <(series: SeriesDouble): Series[Boolean]
Since

0.1.0

@targetName("smaller")
def <(v: Double): Series[Boolean]
Since

0.1.0

@targetName("smallerEqual")
def <=(series: SeriesDouble): Series[Boolean]
Since

0.1.0

@targetName("smallerEqual")
def <=(v: Double): Series[Boolean]
Since

0.1.0

@targetName("greater")
def >(series: SeriesDouble): Series[Boolean]
Since

0.1.0

@targetName("greater")
def >(v: Double): Series[Boolean]
Since

0.1.0

@targetName("greaterEqual")
def >=(series: SeriesDouble): Series[Boolean]
Since

0.1.0

@targetName("greaterEqual")
def >=(v: Double): Series[Boolean]
Since

0.1.0

def clip(lower: Double, upper: Double): Series[Double]
Since

0.1.0

def countNotNaN: Int
Since

0.1.0

def inRange(lower: Double, upper: Double): Series[Boolean]
Since

0.1.0

def inRangeExclusive(lower: Double, upper: Double): Series[Boolean]
Since

0.1.0

def inRangeLowerExclusive(lower: Double, upper: Double): Series[Boolean]
Since

0.1.0

def inRangeUpperExclusive(lower: Double, upper: Double): Series[Boolean]
Since

0.1.0

def mad: Double
Since

0.1.0

def max: Double
Since

0.1.0

def mean: Double
Since

0.1.0

def min: Double
Since

0.1.0

def rint: Series[Double]
Since

0.1.0

def round: Series[Int]
Since

0.1.0

def sum: Double
Since

0.1.0

Inherited methods

@targetName("notEqualByRow")
def !=(v: Int): Series[Boolean]

Compares the entries of the Series with the value v returning a boolean Series with entries

Compares the entries of the Series with the value v returning a boolean Series with entries

  • true if values are not equal,
  • false if values are equal,
  • null if the value of the series is not defined (null).
Value Params
v

Value to compare with.

Returns

Boolean Series.

See also
Since

0.1.0

Inherited from
Series
@targetName("notEqualsByRow")
def !=(v: Double): Series[Boolean]

Compares the entries of the Series with the value v returning a boolean Series with entries

Compares the entries of the Series with the value v returning a boolean Series with entries

  • true if values are not equal,
  • false if values are equal,
  • null if the value of the series is not defined (null).
Value Params
v

Value to compare with.

Returns

Boolean Series.

See also
Since

0.1.0

Inherited from
Series
@targetName("notEqualsByRow")
def !=(v: Boolean): Series[Boolean]

Compares the entries of the Series with the value v returning a boolean Series with entries

Compares the entries of the Series with the value v returning a boolean Series with entries

  • true if values are not equal,
  • false if values are equal,
  • null if the value of the series is not defined (null).
Value Params
v

Value to compare with.

Returns

Boolean Series.

See also
Since

0.1.0

Inherited from
Series
@targetName("notEqualsByRow")
def !=[T2](v: T2): Series[Boolean]

Compares the entries of the Series with the value v returning a boolean Series with entries

Compares the entries of the Series with the value v returning a boolean Series with entries

  • true if values are not equal,
  • false if values are equal,
  • null if the value of the series is not defined (null).
Value Params
v

Value to compare with.

Returns

Boolean Series.

See also
Since

0.1.0

Inherited from
Series
@targetName("notEqualsByRow")
def !=[T2](series: Series[T2]): Series[Boolean]

Compares two series row-by-row returning a boolean Series with entries

Compares two series row-by-row returning a boolean Series with entries

  • true if values are not equal,
  • false if values are equal,
  • null if one of the values is not defined (null) or is not in the index.
Value Params
series

Series to compare with.

Returns

Boolean Series with index of left operand.

See also
Since

0.1.0

Inherited from
Series
@targetName("prepend")
def +:(string: String): Series[String]

Prepends a string to a Series, where the Series is converted to a String Series if required.

Prepends a string to a Series, where the Series is converted to a String Series if required.

Value Params
string

String to be prepended.

Returns

String Series.

See also
Since

0.1.0

Inherited from
Series
@targetName("prepend")
def ::[T2](series: Series[T2]): DataFrame

Concatenates the Series on the left and the Series on the right hand side.

Concatenates the Series on the left and the Series on the right hand side.

Value Params
series

DataFrame.

Returns

DataFrame, where the Series series is the first column.

Throws
MergeIndexException

If indices are not compatible.

See also
Since

0.1.0

Note
  • Columns with the same name are replaced by the rightmost column.
  • The index of the left Series must be included in the right Series.
  • Data on the left hand side might be copied if indices are not equivalent.
  • The resulting index is equivalent to the right operand.
  • The operators | and :: are equivalent if indices on the left and right side are equal.
Inherited from
Series
@targetName("prepend")
def ::(df: DataFrame): DataFrame

Concatenates the DataFrame on the left and the Series on the right hand side.

Concatenates the DataFrame on the left and the Series on the right hand side.

Value Params
df

DataFrame.

Returns

DataFrame, where the Series is the last column.

Throws
MergeIndexException

If indices are not compatible.

See also
Since

0.1.0

Note
  • Columns with the same name are replaced by the rightmost column.
  • The index of the left DataFrame must be included in the right Series.
  • Data on the left hand side might be copied if indices are not equivalent.
  • The resulting index is equivalent to the right operand.
  • The operators | and :: are equivalent if indices on the left and right side are equal.
Inherited from
Series
@targetName("equalsByRow")
def ==(v: Int): Series[Boolean]

Compares the entries of the Series with the value v returning a boolean Series with entries

Compares the entries of the Series with the value v returning a boolean Series with entries

  • true if values are equal,
  • false if values are not equal,
  • null if the value of the Series is not defined (null).
Value Params
v

Value to compare with.

Returns

Boolean Series.

See also
Since

0.1.0

Inherited from
Series
@targetName("equalsByRow")
def ==(v: Double): Series[Boolean]

Compares the entries of the Series with the value v returning a boolean Series with entries

Compares the entries of the Series with the value v returning a boolean Series with entries

  • true if values are equal,
  • false if values are not equal,
  • null if the value of the Series is not defined (null).
Value Params
v

Value to compare with.

Returns

Boolean Series.

See also
Since

0.1.0

Inherited from
Series
@targetName("equalsByRow")
def ==(v: Boolean): Series[Boolean]

Compares the entries of the Series with the value v returning a boolean Series with entries

Compares the entries of the Series with the value v returning a boolean Series with entries

  • true if values are equal,
  • false if values are not equal,
  • null if the values of the Series is not defined (null).
Value Params
v

Value to compare with.

Returns

Boolean Series.

See also
Since

0.1.0

Inherited from
Series
@targetName("equalsByRow")
def ==[T2](v: T2): Series[Boolean]

Compares the entries of the Series with the value v returning a boolean Series with entries

Compares the entries of the Series with the value v returning a boolean Series with entries

  • true if values are equal,
  • false if values are not equal,
  • null if the values of the series is not defined (null).

Value to compare with.

Value Params
v

Value.

Returns

Boolean Series.

See also
Since

0.1.0

Inherited from
Series
@targetName("equalsByRow")
def ==[T2](series: Series[T2]): Series[Boolean]

Compares two series row-by-row returning a boolean Series with entries

Compares two series row-by-row returning a boolean Series with entries

  • true if values are equal,
  • false if values are not equal,
  • null if one of the values is not defined (null) or is not in the index.
Value Params
series

Series to compare with.

Returns

Boolean Series with index of left operand.

See also
Since

0.1.0

Inherited from
Series
def agg[R](start: R, f: (R, Double) => R): R

Aggregates over values row-by-row.

Aggregates over values row-by-row.

Value Params
f

Aggregation function (aggregatedValue, rowValue) => newAggregatedValue.

start

Start value.

Returns

Aggregated value.

See also
Since

0.1.0

Note

The aggregation function should not depend on the traversal order.

Inherited from
Series
inline def apply(ix: Option[Int], default: => Double): Double

Returns the value at index ix or the value default if undefined.

Returns the value at index ix or the value default if undefined.

Value Params
default

Default value.

ix

Option of row index.

Returns

Value or default if ix is None, the value is not defined or ix not in the index.

Throws
IndexBoundsException

If ix is not part of the base index.

See also
Since

0.1.0

Note

Due to performance, this method should be preferred over apply(ix: Option[Int]): Option[T].

Inherited from
Series
inline def apply(ix: Int, default: => Double): Double

Returns the value at index ix or the value default if undefined.

Returns the value at index ix or the value default if undefined.

Value Params
default

Default value.

ix

Row index.

Returns

Value or default if the value is not defined or ix not in the index.

Throws
IndexBoundsException

If ix is not part of the base index.

See also
Since

0.1.0

Note

Due to performance, this method should be preferred over apply(ix: Int): Option[T].

Inherited from
Series
def apply(ix: Option[Int]): Option[Double]

Returns the value at index ix as an Option, i.e. Some(value) or None.

Returns the value at index ix as an Option, i.e. Some(value) or None.

Value Params
ix

Option of row index.

Returns

Value as an Option. None if ix is None, the value is undefined or ix not in the index.

Throws
IndexBoundsException

If the value of ix is not part of the base index.

See also
Since

0.1.0

Inherited from
Series
def apply(ix: Int): Option[Double]

Returns the value at index ix as an Option, i.e. Some(value) or None.

Returns the value at index ix as an Option, i.e. Some(value) or None.

Value Params
ix

Row index.

Returns

Value as an Option. None if the value is undefined or ix not in the index.

Throws
IndexBoundsException

If ix is not part of the base index.

See also
Since

0.1.0

Inherited from
Series
def apply(series: Series[Boolean]): Series[Double]

Slices the index by intersecting the current index with a boolean Series.

Slices the index by intersecting the current index with a boolean Series.

Value Params
series

Boolean Series as mask, where only index positions kept that are true.

Returns

Object with sliced index and order of series.

See also
Since

0.1.0

Inherited from
IndexOps
def apply(array: Array[Int]): Series[Double]

Slices the index by intersecting it with an array of index positions.

Slices the index by intersecting it with an array of index positions.

Value Params
array

Array of index positions.

Returns

Object with sliced index and order of array.

See also
Since

0.1.0

Inherited from
IndexOps
def apply(seq: Seq[Int]): Series[Double]

Slices the index by intersecting it with a sequence of index positions.

Slices the index by intersecting it with a sequence of index positions.

Value Params
seq

Sequence of index positions.

Returns

Object with sliced index and order of seq.

See also
Since

0.1.0

Inherited from
IndexOps
def apply(range: Range): Series[Double]

Slices the index by intersecting it with a range.

Slices the index by intersecting it with a range.

Value Params
range

Range.

Returns

Object with sliced index with ascending order.

See also
Since

0.1.0

Inherited from
IndexOps
def as[T2](ix: Option[Int], default: => T2)(implicit evidence$8: Typeable[T2], evidence$9: ClassTag[T2]): T2

Returns the value at index ix or the value default if not set.

Returns the value at index ix or the value default if not set.

Value Params
default

Default value.

ix

Option of row index.

Returns

Value or default if ix is None, the value is not set or not in the index.

Throws
IndexBoundsException

If ix is not part of the base index.

See also
Since

0.1.0

Note

Due to performance, this method should be preferred over as[T2](ix: Option[Int]): Option[T2].

Inherited from
Series
def as[T2](ix: Int, default: => T2)(implicit evidence$6: Typeable[T2], evidence$7: ClassTag[T2]): T2

Returns the value at index ix or the value default if not set.

Returns the value at index ix or the value default if not set.

Value Params
default

Default value.

ix

Row index.

Returns

Value or default if the value is not set or not in the index.

Throws
IndexBoundsException

If ix is not part of the base index.

See also
Since

0.1.0

Note

Due to performance, this method should be preferred over as[T2](ix: Int): Option[T2].

Inherited from
Series
def as[T2](ix: Option[Int])(implicit evidence$4: Typeable[T2], evidence$5: ClassTag[T2]): Option[T2]

Returns the value at index ix as an Option, i.e. Some(value) or None.

Returns the value at index ix as an Option, i.e. Some(value) or None.

Value Params
ix

Option of row index.

Returns

Value as an Option. None if ix is None, the value is not set or not in the index.

Throws
IndexBoundsException

If the value of ix is not part of the base index.

See also
Since

0.1.0

Inherited from
Series
def as[T2](ix: Int)(implicit evidence$3: Typeable[T2]): Option[T2]

Returns the value at index ix as an Option, i.e. Some(value) or None.

Returns the value at index ix as an Option, i.e. Some(value) or None.

Value Params
ix

Row index.

Returns

Value as an Option. None if the value is not set or not in the index.

Throws
IndexBoundsException

If ix is not part of the base index.

SeriesCastException

If inner type is not instance of the new type T2.

See also
Since

0.1.0

Inherited from
Series
def as(name: String): Series[Double]

Renames the Series.

Renames the Series.

Value Params
name

New name.

Returns

Series with new name.

Since

0.1.0

Inherited from
Series
def as[T2](implicit evidence$1: Typeable[T2], evidence$2: ClassTag[T2]): Series[T2]

Casts the Series into another type.

Casts the Series into another type.

Returns

Instance of Series[T2].

Throws
SeriesCastException

If inner type does not equal the new type T2.

See also
Since

0.1.0

Note

When casting from Any to native types, consider using pd.implicits.SeriesAny.asBoolean, pd.implicits.SeriesAny.asDouble, pd.implicits.SeriesAny.asInt, etc. for more performance.

Inherited from
Series
def count: Int

Counts the number of defined (non-null) elements. For Double Series, also Double.NaN is accounted as not defined.

Counts the number of defined (non-null) elements. For Double Series, also Double.NaN is accounted as not defined.

Returns

Number of defined (non-null) elements.

See also
Since

0.1.0

Inherited from
Series
def defined: Series[Double]

Keeps only defined elements and removes all index positions with undefined elements.

Keeps only defined elements and removes all index positions with undefined elements.

Returns

Equivalent Series without undefined elements and trimmed index.

Since

0.1.0

Inherited from
Series
def dense: Series[Double]

Converts the Series into a Series with a uniform (dense) index, which equals the base index. Missing indices are replaced by explicit undefined values (masked). The (accessible) data is not changed.

Converts the Series into a Series with a uniform (dense) index, which equals the base index. Missing indices are replaced by explicit undefined values (masked). The (accessible) data is not changed.

Returns

Same Series but with an uniform index.

See also
Since

0.1.0

Inherited from
Series
def display(n: Int, colWidth: Int): Unit

Prints the Series as a table with an index column and annotated column types.

Prints the Series as a table with an index column and annotated column types.

Value Params
colWidth

The width of the column.

n

The maximal numbers of rows.

See also
Since

0.1.0

Inherited from
Series
def distinct: Series[Double]

Series with unique (defined) values in the Series.

Series with unique (defined) values in the Series.

Returns

Series with distinct values.

Since

0.1.0

Inherited from
Series
@nowarn
override def equals(that: Any): Boolean

Indicates if two Series are equal with respect to

Indicates if two Series are equal with respect to

  • name,
  • index and
  • values in all rows.
Value Params
that

Series (or object) to compare with.

Returns

True if equal and false otherwise.

See also
Since

0.1.0

Note
  • Comparing an undefined value (null) with undefined gives true, whereas undefined with not undefined is false.
  • Comparing Double.NaN with Double.NaN gives true, whereas Double.NaN with undefined (null) or any defined value gives false.
  • The method differentiates between a missing index and an undefined (null) value.
  • If the object is not a Series it returns false.
Definition Classes
Series -> Any
Inherited from
Series
def equalsByValue[T2](series: Series[T2]): Boolean

Indicates if two Series are equal with respect to (type and) values in all rows.

Indicates if two Series are equal with respect to (type and) values in all rows.

Value Params
series

Series (or object) to compare with.

See also
Since

0.1.0

Note
  • Comparing an undefined value (null) with undefined gives true, whereas undefined with not undefined is false.
  • Comparing Double.NaN with Double.NaN gives true, whereas Double.NaN with undefined (null) or any defined value gives false.
  • The method does not differentiate between a undefined value in the index or in the data.
  • The comparison ignores different names and indices. The index order is therefore ignored.
  • If the two Series have different base indices the result is false.
Inherited from
Series
def exists(value: Double): Boolean

Indicates if a value is contained in the Series.

Indicates if a value is contained in the Series.

Value Params
value

Value to search for.

Returns

Boolean flag if the the value exists.

Since

0.1.0

Inherited from
Series
def fill(value: Double): Series[Double]

Fills undefined (null) values of a Series with respect to the current index.

Fills undefined (null) values of a Series with respect to the current index.

Value Params
value

Value for filling non-set values.

Returns

Series with undefined values filled. The original index is preserved.

Since

0.1.0

Inherited from
Series
def fill[T2 <: Double](series: Series[T2]): Series[Double]

Replaces undefined (null) values by the values of series for the current index. This is also known as coalesce operation.

Replaces undefined (null) values by the values of series for the current index. This is also known as coalesce operation.

Value Params
series

Series with the same base index.

Returns

Series with data from the first series or if undefined from the second. The original index is not altered.

Throws
BaseIndexException

If the base index are different.

SeriesCastException

If the Series do not have the same type.

Since

0.1.0

Inherited from
Series
def fillAll(value: Double): Series[Double]

Fills undefined (null) values of a Series with respect to the base index.

Fills undefined (null) values of a Series with respect to the base index.

Value Params
value

Value for filling undefined values.

Returns

Series with undefined values filled. The index is expanded to the uniform base index.

Since

0.1.0

Inherited from
Series
def fillAll[T2 <: Double](series: Series[T2]): Series[Double]

Replaces undefined (null) values by the values of series also known as coalesce operation. The index is expanded to the uniform base index.

Replaces undefined (null) values by the values of series also known as coalesce operation. The index is expanded to the uniform base index.

Value Params
series

Series with the same base index.

Returns

Series with data from the first series or if undefined from the second. The index is expanded to the uniform base index.

Throws
BaseIndexException

If the base index are different.

SeriesCastException

If the Series do not have the same type.

Since

0.1.0

Inherited from
Series
def first[T2](series: Series[T2], value: T2, default: => Double): Double

Returns the value at the index position, where a value occurs the first time in another Series or None if the value is not found.

Returns the value at the index position, where a value occurs the first time in another Series or None if the value is not found.

Value Params
default

value if value is not found.

series

Series which is searched for the value.

value

Value to search for.

Returns

Value a the index position or the default value if not found.

Throws
BaseIndexException

If the base indices are not equal.

See also
Since

0.1.0

Note

The result depends on the index order.

Inherited from
Series
def first[T2](series: Series[T2], value: T2): Option[Double]

Returns the value at the index position, where a value occurs the first time in another Series or None if the value is not found.

Returns the value at the index position, where a value occurs the first time in another Series or None if the value is not found.

Value Params
series

Series which is searched for the value.

value

Value to search for.

Returns

Option of the value at the index position.

Throws
BaseIndexException

If the base indices are not equal.

See also
Since

0.1.0

Note

The result depends on the index order.

Inherited from
Series
def first(value: Double): Option[Int]

Returns the index position of the first occurrence of a value or None if not found.

Returns the index position of the first occurrence of a value or None if not found.

Value Params
value

Value to search for.

Returns

Index position or None if not found.

See also
Since

0.1.0

Note

The result depends on the index order.

Inherited from
Series
def first(f: Double => Boolean): Option[Int]

Returns the index position of the first element where the condition is satisfied or None if not found.

Returns the index position of the first element where the condition is satisfied or None if not found.

Value Params
f

Predicate function.

Returns

Index position or None if the predicate is never true.

See also
Since

0.1.0

Note

The result depends on the index order.

Inherited from
Series
def first: Option[Int]

Returns the index position of the first defined (non-null) value and for boolean Series the first occurrence of the value true.

Returns the index position of the first defined (non-null) value and for boolean Series the first occurrence of the value true.

Returns

Index of first non-null entry or None if none of the entries are defined. For boolean Series, the index of the first occurrence of true or None if all values are false.

See also
Since

0.1.0

Note

The result depends on the index order.

Inherited from
Series
def forall(f: Double => Boolean): Boolean

Tests whether the condition holds for all elements.

Tests whether the condition holds for all elements.

Value Params
f

Predicate function to satisfy.

Returns

False if at least one (non-null) element does not satisfy the condition, true otherwise.

See also
Since

0.1.0

Inherited from
Series
def forallStrictly(f: Double => Boolean): Boolean

Tests whether the condition holds for all elements.

Tests whether the condition holds for all elements.

Value Params
f

Predicate function to satisfy.

Returns

False if at least one element does not satisfy the condition or is not set (null), true otherwise.

See also
Since

0.1.0

Inherited from
Series
inline def get(ix: Option[Int]): Double

Returns the value at index ix. Throws an exception if the value is not defined or ix not in the index.

Returns the value at index ix. Throws an exception if the value is not defined or ix not in the index.

Value Params
ix

Option of row index.

Returns

Value for the index.

Throws
NoSuchElementException

If he value is undefined (null), ix is not in the index, ix is None or if ix is not part of the base index.

See also
Since

0.1.0

Inherited from
Series
inline def get(ix: Int): Double

Returns the value at index ix. Throws an exception if the value is not set or not in the index.

Returns the value at index ix. Throws an exception if the value is not set or not in the index.

Value Params
ix

Row index.

Returns

Value for the index.

Throws
NoSuchElementException

If he value is not set (null), ix is not in the index or if ix is not part of the base index.

See also
Since

0.1.0

Inherited from
Series
def hasSameDefined[T2](series: Series[T2]): Boolean

Indicates if two Series have the same defined values as well as the same undefined (null) values, where the values themselves are not compared.

Indicates if two Series have the same defined values as well as the same undefined (null) values, where the values themselves are not compared.

Value Params
series

Series to compare with.

Returns

True if the undefined and defined values are the same for both Series.

See also
Since

0.1.0

Note
  • The method does not differentiate between a missing value in the index and a undefined value (null).
  • The comparison ignores different names and indices.
  • If the two Series have different base indices the result is false.
Inherited from
Series
def hasSameIndex[T2](series: Series[T2]): Boolean

Compares if the indices of two Series are equal.

Compares if the indices of two Series are equal.

Value Params
series

Series to compare with.

Returns

True if indices are equal and false otherwise.

See also
Since

0.1.0

Inherited from
Series
def hasUndefined: Boolean

Returns true if at least one of the elements is undefined or the index has less elements than the base index (slicing of the Series).

Returns true if at least one of the elements is undefined or the index has less elements than the base index (slicing of the Series).

Returns

False if an element is defined for each base index element or otherwise true.

See also

isDefined for negation.

Since

0.1.0

Inherited from
Series
override def hashCode: Int

Hash code.

Hash code.

Returns

Hash code derived from index length and name.

Since

0.1.0

Definition Classes
Series -> Any
Inherited from
Series
def head(n: Int): Series[Double]

Head of object.

Head of object.

Value Params
n

Number of rows.

Returns

First n rows in index.

See also
Since

0.1.0

Inherited from
IndexOps
def headOption: Option[Double]

Returns the first value as an Option, i.e. Some(value) or None if the first value is undefined.

Returns the first value as an Option, i.e. Some(value) or None if the first value is undefined.

Returns

Value as an Option.

Since

0.1.0

Note

The result depends on the index order.

Inherited from
Series
def headValue: Option[Double]

Returns the first (defined) value as an Option, i.e. Some(value) or None if all values are undefined.

Returns the first (defined) value as an Option, i.e. Some(value) or None if all values are undefined.

Returns

Value as an Option, which is None if the Series an no defined values.

Since

0.1.0

Note

The result depends on the index order.

Inherited from
Series
def indexEmpty: Boolean

Indicates if the index is empty.

Indicates if the index is empty.

Returns

True if the index has at least one element or otherwise false.

Since

0.1.0

Inherited from
Series
def indexIterator: Iterator[Int]

Iterator over the index.

Iterator over the index.

Returns

Iterator of index positions.

Since

0.1.0

Note

For better performance consider using methods such as agg or map.

Inherited from
Series
def indexNonEmpty: Boolean

Indicates if the index is not empty.

Indicates if the index is not empty.

Returns

True if the index has no elements or otherwise false.

Since

0.1.0

Inherited from
Series
def info: String

Information string on the Series.

Information string on the Series.

Returns

Info string.

Since

0.1.0

Inherited from
Series
def isDefined: Boolean

Returns true if the data does not contains undefined values and the index includes all index positions of the base index.

Returns true if the data does not contains undefined values and the index includes all index positions of the base index.

Returns

Boolean if elements are defined for all index positions.

See also

hasUndefined for negation.

Since

0.1.0

Inherited from
Series
def isEmpty: Boolean

Indicates if a Series has no defined elements.

Indicates if a Series has no defined elements.

Returns

True if either the index is empty or all values are undefined. Otherwise false is returned.

Since

0.1.0

Inherited from
Series
def isType[T2](implicit evidence$10: Typeable[T2]): Boolean

Checks if the Series is of type T2.

Checks if the Series is of type T2.

Returns

True if values are instance of T2 or false otherwise.

Since

0.1.0

Note

For better performance, the type check is only performed on the head of the Series except for the types Boolean, Double, Int and String. Checking the Series with regards to other types on a Series with mixed data can have misleading results. Use isTypeStrictly for testing.

Inherited from
Series
def isTypeAll[T2](implicit evidence$11: Typeable[T2]): Boolean

Checks if the Series is of type T2 and all values are defined.

Checks if the Series is of type T2 and all values are defined.

Returns

True if values are instance of T2 and all values are defined. False otherwise.

Since

0.1.0

Note

For better performance, the type check is only performed on the head of the Series except for the types Boolean, Double, Int and String. Checking the Series with regards to other types on a Series with mixed data can have misleading results. Use isTypeStrictly for testing.

Inherited from
Series
def isTypeAllStrictly[T2](implicit evidence$12: Typeable[T2]): Boolean

Checks if the Series is of type T2 and all values are defined.

Checks if the Series is of type T2 and all values are defined.

Returns

True if every value is instance of T2 and all values are defined. False otherwise.

Since

0.1.0

Note

The type check is performed on all values with causes a slower performance except for the types Any, Boolean, Double, Int and String.

Inherited from
Series
def isTypeStrictly[T2](implicit evidence$13: Typeable[T2]): Boolean

Checks if the Series is of type T2.

Checks if the Series is of type T2.

Returns

True if every value is instance of T2 or false otherwise.

Since

0.1.0

Note

The type check is performed on all values with causes a slower performance except for the types Any, Boolean, Double, Int and String.

Inherited from
Series
def iterator: Iterator[Option[Double]]

Iterator over the values of the Series ordered by the index.

Iterator over the values of the Series ordered by the index.

Returns

Iterator of type Option[T] returning Some(value) if the value is defined and None if undefined.

Since

0.1.0

Note

For better performance consider using methods such as agg or map.

Inherited from
Series
def last[T2](series: Series[T2], value: T2, default: => Double): Double

Returns the value at the index position, where a value occurs the last time in another Series or None if the value is not found.

Returns the value at the index position, where a value occurs the last time in another Series or None if the value is not found.

Value Params
default

value if value is not found.

series

Series which is searched for the value.

value

Value to search for.

Returns

Value a the index position or the default value if not found.

Throws
BaseIndexException

If the base indices are not equal.

See also
Since

0.1.0

Note

The result depends on the index order.

Inherited from
Series
def last[T2](series: Series[T2], value: T2): Option[Double]

Returns the value at the index position, where a value occurs the last time in another Series or None if the value is not found.

Returns the value at the index position, where a value occurs the last time in another Series or None if the value is not found.

Value Params
series

Series which is searched for the value.

value

Value to search for.

Returns

Option of the value at the index position.

Throws
BaseIndexException

If the base indices are not equal.

See also
Since

0.1.0

Note

The result depends on the index order.

Inherited from
Series
def last(value: Double): Option[Int]

Returns the index position of the last occurrence of a value or None if not found.

Returns the index position of the last occurrence of a value or None if not found.

Value Params
value

Value to search for.

Returns

Index position or None if not found.

See also
Since

0.1.0

Note

The result depends on the index order.

Inherited from
Series
def last: Option[Int]

Returns the index position of the last set (non-null) value and for boolean Series the last occurrence of the value true.

Returns the index position of the last set (non-null) value and for boolean Series the last occurrence of the value true.

Returns

Index of last non-null entry or None if none of the entries are set. For boolean Series, the index of the last occurrence of true or None if all values are false.

See also
Since

0.1.0

Note

The result depends on the index order.

Inherited from
Series
def length: Int

Number of rows.

Number of rows.

Returns

Length of the Series, i.e. number of elements in the index.

See also
Since

0.1.0

Inherited from
Series
def map[T2, R](series: Series[T2], f: (Double, T2) => R)(implicit evidence$15: ClassTag[R]): Series[R]

Applies a row-wise function on two Series.

Applies a row-wise function on two Series.

Value Params
f

Row-wise function which takes as arguments elements of both Series. If one of the elements in a row is undefined the result in undefined.

series

Second Series.

Returns

Transformed Series of type R.

Since

0.1.0

Inherited from
Series
def map[R](f: Double => R)(implicit evidence$14: ClassTag[R]): Series[R]

Applies a function on each element of the Series.

Applies a function on each element of the Series.

Value Params
f

Row-wise function.

Returns

Transformed Series of type R.

See also
Since

0.1.0

Inherited from
Series
def mutable: MutableSeries[Double]

A mutable copy of the Series.

A mutable copy of the Series.

Returns

A MutableSeries.

Since

0.1.0

Note
Series.mutable(1,2,3)

Series(1,2,3).mutable
  • For reference types the copy references the same objects which may cause side effects for mutable objects.
Inherited from
Series
def nonEmpty: Boolean

Indicates if a Series has defined elements.

Indicates if a Series has defined elements.

Returns

True if at least one defined element exists. Otherwise false is returned.

Since

0.1.0

Inherited from
Series
def numRows: Int

Number of rows.

Number of rows.

Returns

Length of the Series, i.e. number of elements in the index.

See also
Since

0.1.0

Inherited from
Series
def numRowsBase: Int

Number of rows of the underlying data vector.

Number of rows of the underlying data vector.

Returns

Number of elements in the base index.

Since

0.1.0

Inherited from
Series
def orElse(value: Double): Series[Double]

Fills undefined (null) values of a Series with respect to the current index. Synonym for fill.

Fills undefined (null) values of a Series with respect to the current index. Synonym for fill.

Value Params
value

Value for filling non-set values.

Returns

Series with undefined values filled. The original index is preserved.

See also
Since

0.1.0

Inherited from
Series
def orElse[T2 <: Double](series: Series[T2]): Series[Double]

Replaces undefined (null) values by the values of series for the current index. Synonym for fill.

Replaces undefined (null) values by the values of series for the current index. Synonym for fill.

Value Params
series

Series with the same base index.

Returns

Series with data from the first series or if undefined from the second. The original index is not altered.

Throws
BaseIndexException

If the base index are different.

SeriesCastException

If the Series do not have the same type.

See also
Since

0.1.0

Inherited from
Series
def resetIndex: Series[Double]

Resets the index to a UniformIndex with index positions 0 to numRows - 1 while keeping the order of the elements. If the current index is not a uniform index, the data is copied into a new vector with the order of the current index.

Resets the index to a UniformIndex with index positions 0 to numRows - 1 while keeping the order of the elements. If the current index is not a uniform index, the data is copied into a new vector with the order of the current index.

Returns

Series with a UniformIndex.

See also

sortIndex for sorting the index by index positions.

Since

0.1.0

Inherited from
Series
def show(n: Int, annotateIndex: Boolean, annotateType: Boolean, colWidth: Int): Unit

Prints the Series as a table.

Prints the Series as a table.

Value Params
annotateIndex

If true, the an index column is displayed.

annotateType

If true, the type for each column in displayed.

colWidth

The width of the column.

n

The maximal numbers of rows.

See also
Since

0.1.0

Inherited from
Series
def showValues(n: Int): Unit

Prints all values of the Series.

Prints all values of the Series.

Value Params
n

The maximal numbers of rows to be printed or -1 (default) for all values.

See also
Since

0.1.0

Inherited from
Series
def sortIndex: Series[Double]

Sorts the index (ascending).

Sorts the index (ascending).

Returns

Object with sorted index.

See also
Since

0.1.0

Inherited from
IndexOps
def sorted(order: Order)(implicit ordering: Ordering[Double]): Series[Double]

Sorts the Series.

Sorts the Series.

Value Params
order

Order for sorting. Possible values are Order.asc, Order.desc, Order.ascNullsFirst and Order.descNullsFirst.

ordering

Implicit ordering that must exist for the type T, i.e. classes must extend the trait Ordered.

Returns

Series with sorted index.

Since

0.1.0

Note
  • The sorting algorithm is stable.
  • String values are sorted lexicographically ignoring case differences (see String.compareToIgnoreCase).
Inherited from
Series
def sorted(implicit ordering: Ordering[Double]): Series[Double]

Sorts the Series in ascending order.

Sorts the Series in ascending order.

Value Params
ordering

Implicit ordering that must exist for the type T, i.e. classes must extend the trait Ordered.

Returns

Series with sorted index.

Since

0.1.0

Note
  • The sorting algorithm is stable.
  • String values are sorted lexicographically ignoring case differences (see String.compareToIgnoreCase).
Inherited from
Series
def str: Series[String]

Converts the Series row-wise into a String Series.

Converts the Series row-wise into a String Series.

Returns

Series of type String.

Since

0.1.0

Note
  • The operation maps each element via toString to a String.
  • If the Series is of type String the Series is returned.
Inherited from
Series
def tail(n: Int): Series[Double]

Tail of object.

Tail of object.

Value Params
n

Number of rows.

Returns

Last n rows in index.

See also
Since

0.1.0

Inherited from
IndexOps
def toAny: Series[Any]

Series as instance of Series[Any].

Series as instance of Series[Any].

Returns

Series of type Any.

Since

0.1.0

Note

Only the outer type of the Series is altered.

Inherited from
Series
def toArray: Array[Option[Double]]

Copies the Series into an array.

Copies the Series into an array.

Returns

Array of type Option[T] with numRows elements.

Since

0.1.0

Inherited from
Series
def toFlatArray: Array[Double]

Copies the Series into an array.

Copies the Series into an array.

Returns

Array of type T. If T is a native type, a native array is returned.

Since

0.1.0

Inherited from
Series
def toFlatList: List[Double]

Copies the Series into a List.

Copies the Series into a List.

Returns

List of type T.

Since

0.1.0

Inherited from
Series
def toFlatSeq: Seq[Double]

Copies the Series into a sequence.

Copies the Series into a sequence.

Returns

Sequence of type T.

Since

0.1.0

Inherited from
Series
def toList: List[Option[Double]]

Copies the Series into a List.

Copies the Series into a List.

Returns

List of type Option[T] with numRows elements.

Since

0.1.0

Inherited from
Series
def toSeq: Seq[Option[Double]]

Copies the Series into a sequence with numRows elements.

Copies the Series into a sequence with numRows elements.

Returns

Sequence of type Option[T].

Since

0.1.0

Inherited from
Series
def toString(n: Int, colWidth: Int, annotateIndex: Boolean, annotateType: Boolean): String

Renders the Series as a table.

Renders the Series as a table.

Value Params
annotateIndex

If true, the an index column is displayed.

annotateType

If true, the type for each column in displayed.

colWidth

The width of each column.

n

The maximal numbers of rows.

Returns

Formatted table.

Since

0.1.0

Inherited from
Series
override def toString: String

Renders the Series as a table using default parameters.

Renders the Series as a table using default parameters.

Returns

Formatted table.

Since

0.1.0

Definition Classes
Series -> Any
Inherited from
Series
def typeString: String

Returns the (internal) runtime Scala type of the Series.

Returns the (internal) runtime Scala type of the Series.

Returns

Type name such as "Int", "MyClass", "Any", "Array[Double]", "List", "Seq", etc.

Since

0.1.0

Note
  • There is no deep type reflection for 2nd order types except for Array.
  • When casting a Series to Any (via toAny), the internal type of the Series does not change.
Inherited from
Series
def union[T2 <: Double](series: Series[T2]*): Series[Double]

Appends row-wise one or multiple Series. The method materializes all indices into a uniform index.

Appends row-wise one or multiple Series. The method materializes all indices into a uniform index.

Value Params
series

Series to be appended.

Returns

Series with a uniform index.

Throws
SeriesCastException

If the underlying types are not a subtype.

Since

0.1.0

Inherited from
Series
def unique: Array[Double]

Array with unique (defined) values in the Series.

Array with unique (defined) values in the Series.

Returns

Array with distinct values.

Since

0.1.0

Inherited from
Series
def update[T2 <: Double](series: Series[T2]): Series[Double]

Updates the series with values from the second series if the values are defined.

Updates the series with values from the second series if the values are defined.

Value Params
series

Series with the same base index.

Returns

Series with data from parameter series or if a value is undefined in series from the original series. The original index is not altered.

Since

0.1.0

Inherited from
Series
@targetName("concat")
def |(series: Series[_]): DataFrame

Concatenates Series on the left and right hand side.

Concatenates Series on the left and right hand side.

Value Params
series

Series.

Returns

DataFrame with two columns, where series is the last column.

Throws
MergeIndexException

If indices are not compatible.

See also
Since

0.1.0

Note
  • Columns with the same name are replaced by the rightmost column.
  • The index of the right Series must be included in the left one.
  • Data on the right hand side might be copied if indices are not equivalent.
  • The resulting index is equivalent to the left operand.
Inherited from
Series
@targetName("concat")
def |(df: DataFrame): DataFrame

Concatenates the Series on the left and the DataFrame on the right hand side.

Concatenates the Series on the left and the DataFrame on the right hand side.

Value Params
df

DataFrame.

Returns

DataFrame, where the Series is the first column.

Throws
MergeIndexException

If indices are not compatible.

See also
Since

0.1.0

Note
  • Columns with the same name are replaced by the rightmost column.
  • The index of the right DataFrame must be included in the left Series.
  • Data on the right hand side might be copied if indices are not equivalent.
  • The resulting index is equivalent to the left operand.
Inherited from
Series