View Source Explorer.Series (Explorer v0.5.2)

The Series struct and API.

A series can be of the following data types:

:binary - Binary
:boolean - Boolean
:category - UTF-8 encoded binary but represented internally as integers
:date - Date type that unwraps to Elixir.Date
:datetime - DateTime type that unwraps to Elixir.NaiveDateTime
:float - 64-bit floating point number
:integer - 64-bit signed integer
:string - UTF-8 encoded binary
:time - Time type that unwraps to Elixir.Time

A series must consist of a single data type only. Series may have nil values in them. The series dtype can be retrieved via the dtype/1 function or directly accessed as series.dtype. A series.name field is also available, but it is always nil unless the series is retrieved from a dataframe.

Many functions only apply to certain dtypes. These functions may appear on distinct categories on the sidebar. Other functions may work on several datatypes, such as comparison functions. In such cases, a "Supported dtypes" section will be available in the function documentation.

creating-series
Creating series

Series can be created using from_list/2, from_binary/3, and friends:

Series can be made of numbers:

iex> Explorer.Series.from_list([1, 2, 3])
#Explorer.Series<
  Polars[3]
  integer [1, 2, 3]
>

Series are nullable, so you may also include nils:

iex> Explorer.Series.from_list([1.0, nil, 2.5, 3.1])
#Explorer.Series<
  Polars[4]
  float [1.0, nil, 2.5, 3.1]
>

Any of the dtypes above are supported, such as strings:

iex> Explorer.Series.from_list(["foo", "bar", "baz"])
#Explorer.Series<
  Polars[3]
  string ["foo", "bar", "baz"]
>

Link to this section Summary

Types

dtype()

lazy_t()

t()

Functions: Conversion

from_binary(binary, dtype, opts \\ [])

Builds a series of dtype from binary.

from_list(list, opts \\ [])

Creates a new series from a list.

from_tensor(tensor, opts \\ [])

Converts a Nx.Tensor.t/0 to a series.

replace(series, tensor_or_list)

Replaces the contents of the given series by the one given in a tensor or list.

to_binary(series)

Returns a series as a fixed-width binary.

to_enum(series)

Converts a series to an enumerable.

to_iovec(series)

Returns a series as a list of fixed-width binaries.

to_list(series)

Converts a series to a list.

to_tensor(series, tensor_opts \\ [])

Converts a series to a Nx.Tensor.t/0.

Functions: Aggregation

count(series)

Counts the number of elements in a series.

frequencies(series)

Creates a new dataframe with unique values and the frequencies of each.

max(series)

Gets the maximum value of the series.

mean(series)

Gets the mean value of the series.

median(series)

Gets the median value of the series.

min(series)

Gets the minimum value of the series.

n_distinct(series)

Returns the number of unique values in the series.

nil_count(series)

Counts the number of null elements in a series.

quantile(series, quantile)

Gets the given quantile of the series.

standard_deviation(series)

Gets the standard deviation of the series.

sum(series)

Gets the sum of the series.

variance(series)

Gets the variance of the series.

Functions: Element-wise

add(left, right)

Adds right to left, element-wise.

all_equal(left, right)

Checks equality between two entire series.

left and right

Returns a boolean mask of left and right, element-wise.

cast(series, dtype)

Cast the series to another type.

categorise(series, categories)

Apply categories to a series of integers.

coalesce(list)

Finds the first non-missing element at each position.

coalesce(s1, s2)

Finds the first non-missing element at each position.

divide(left, right)

Divides left by right, element-wise.

equal(left, right)

Returns boolean mask of left == right, element-wise.

greater(left, right)

Returns boolean mask of left > right, element-wise.

greater_equal(left, right)

Returns boolean mask of left >= right, element-wise.

left in right

Checks if each element of the series in the left exists in the series in the right, returning a boolean mask.

is_nil(series)

Returns a mask of nil values.

is_not_nil(series)

Returns a mask of not nil values.

less(left, right)

Returns boolean mask of left < right, element-wise.

less_equal(left, right)

Returns boolean mask of left <= right, element-wise.

mask(series, mask)

Filters a series with a mask.

multiply(left, right)

Multiplies left and right, element-wise.

not series

Negate the elements of a boolean series.

not_equal(left, right)

Returns boolean mask of left != right, element-wise.

left or right

Returns a boolean mask of left or right, element-wise.

peaks(series, max_or_min \\ :max)

Returns a boolean mask with true where the 'peaks' (series max or min, default max) are.

pow(left, right)

Raises a numeric series to the power of the exponent.

quotient(left, right)

Element-wise integer division.

remainder(left, right)

Computes the remainder of an element-wise integer division.

select(predicate, on_true, on_false)

Returns a series from two series, based on a predicate.

subtract(left, right)

Subtracts right from left, element-wise.

transform(series, fun)

Returns an Explorer.Series where each element is the result of invoking fun on each corresponding element of series.

Functions: Datetime ops

day_of_week(series)

Returns a day-of-week number starting from Monday = 1. (ISO 8601 weekday number)

to_date(series)

Returns date component from the datetime series

to_time(series)

Returns time component from the datetime series

Functions: Float ops

ceil(series)

Ceil floating point series to highest integers smaller or equal to the float value.

floor(series)

Floor floating point series to lowest integers smaller or equal to the float value.

is_finite(series)

Returns a mask of finite values.

is_infinite(series)

Returns a mask of infinite values.

is_nan(series)

Returns a mask of infinite values.

round(series, decimals)

Round floating point series to given decimal places.

Functions: String ops

contains(series, pattern)

Detects whether a string contains a substring.

downcase(series)

Converts all characters to lowercase.

trim(series)

Returns a string where all leading and trailing Unicode whitespaces have been removed.

trim_leading(series)

Returns a string where all leading Unicode whitespaces have been removed.

trim_trailing(series)

Returns a string where all trailing Unicode whitespaces have been removed.

upcase(series)

Converts all characters to uppercase.

Functions: Introspection

categories(series)

Return a series with the category names of a categorical series.

dtype(series)

Returns the data type of the series.

iotype(series)

Returns the type of the underlying fixed-width binary representation.

size(series)

Returns the size of the series.

Functions: Shape

argsort(series, opts \\ [])

Returns the indices that would sort the series.

at(series, idx)

Returns the value of the series at the given index.

at_every(series, every_n)

Takes every nth value in this series, returned as a new series.

concat(series)

Concatenate one or more series.

concat(s1, s2)

Concatenate two series.

distinct(series)

Returns the unique values of the series.

first(series)

Returns the first element of the series.

format(list)

Returns a string series with all values concatenated.

head(series, n_elements \\ 10)

Returns the first N elements of the series.

last(series)

Returns the last element of the series.

reverse(series)

Reverses the series order.

sample(series, n_or_frac, opts \\ [])

Returns a random sample of the series.

shift(series, offset)

Shifts series by offset with nil values.

shuffle(series, opts \\ [])

Change the elements order randomly.

slice(series, indices)

Slices the elements at the given indices as a new series.

slice(series, offset, size)

Returns a slice of the series, with size elements starting at offset.

sort(series, opts \\ [])

Sorts the series.

tail(series, n_elements \\ 10)

Returns the last N elements of the series.

unordered_distinct(series)

Returns the unique values of the series, but does not maintain order.

Functions: Window

cumulative_max(series, opts \\ [])

Calculates the cumulative maximum of the series.

cumulative_min(series, opts \\ [])

Calculates the cumulative minimum of the series.

cumulative_sum(series, opts \\ [])

Calculates the cumulative sum of the series.

fill_missing(series, value)

Fill missing values with the given strategy. If a scalar value is provided instead of a strategy atom, nil will be replaced with that value. It must be of the same dtype as the series.

window_max(series, window_size, opts \\ [])

Calculate the rolling max, given a window size and optional list of weights.

window_mean(series, window_size, opts \\ [])

Calculate the rolling mean, given a window size and optional list of weights.

window_min(series, window_size, opts \\ [])

Calculate the rolling min, given a window size and optional list of weights.

window_sum(series, window_size, opts \\ [])

Calculate the rolling sum, given a window size and optional list of weights.

Link to this section Types

dtype()

@type dtype() ::
  :binary
  | :boolean
  | :category
  | :date
  | :time
  | :datetime
  | :float
  | :integer
  | :string

lazy_t()

@type lazy_t() :: %Explorer.Series{
  data: Explorer.Backend.LazySeries.t(),
  dtype: dtype(),
  name: term()
}

t()

@type t() :: %Explorer.Series{
  data: Explorer.Backend.Series.t(),
  dtype: dtype(),
  name: term()
}

Link to this section Functions: Conversion

from_binary(binary, dtype, opts \\ [])

@spec from_binary(
  binary(),
  :float | :integer | :boolean | :date | :time | :datetime,
  keyword()
) :: t()

Builds a series of dtype from binary.

All binaries must be in native endianness.

options
Options

:backend - The backend to allocate the series on.

examples
Examples

Integers and floats follow their native encoding:

iex> Explorer.Series.from_binary(<<1.0::float-64-native, 2.0::float-64-native>>, :float)
#Explorer.Series<
  Polars[2]
  float [1.0, 2.0]
>

iex> Explorer.Series.from_binary(<<-1::signed-64-native, 1::signed-64-native>>, :integer)
#Explorer.Series<
  Polars[2]
  integer [-1, 1]
>

Booleans are unsigned integers:

iex> Explorer.Series.from_binary(<<1, 0, 1>>, :boolean)
#Explorer.Series<
  Polars[3]
  boolean [true, false, true]
>

Dates are encoded as i32 representing days from the Unix epoch (1970-01-01):

iex> binary = <<-719162::signed-32-native, 0::signed-32-native, 6129::signed-32-native>>
iex> Explorer.Series.from_binary(binary, :date)
#Explorer.Series<
  Polars[3]
  date [0001-01-01, 1970-01-01, 1986-10-13]
>

Times are encoded as i64 representing microseconds from midnight:

iex> binary = <<0::signed-64-native, 86399999999::signed-64-native>>
iex> Explorer.Series.from_binary(binary, :time)
#Explorer.Series<
  Polars[2]
  time [00:00:00.000000, 23:59:59.999999]
>

Datetimes are encoded as i64 representing microseconds from the Unix epoch (1970-01-01):

iex> binary = <<0::signed-64-native, 529550625987654::signed-64-native>>
iex> Explorer.Series.from_binary(binary, :datetime)
#Explorer.Series<
  Polars[2]
  datetime [1970-01-01 00:00:00.000000, 1986-10-13 01:23:45.987654]
>

from_list(list, opts \\ [])

@spec from_list(list :: list(), opts :: Keyword.t()) :: t()

Creates a new series from a list.

The list must consist of a single data type and nils. It is possible to have a list of only nil values. In this case, the list will have the :dtype of float.

options
Options

:backend - The backend to allocate the series on.
:dtype - Cast the series to a given :dtype. By default this is nil, which means that Explorer will infer the type from the values in the list.

examples
Examples

Explorer will infer the type from the values in the list:

iex> Explorer.Series.from_list([1, 2, 3])
#Explorer.Series<
  Polars[3]
  integer [1, 2, 3]
>

Series are nullable, so you may also include nils:

iex> Explorer.Series.from_list([1.0, nil, 2.5, 3.1])
#Explorer.Series<
  Polars[4]
  float [1.0, nil, 2.5, 3.1]
>

A mix of integers and floats will be cast to a float:

iex> Explorer.Series.from_list([1, 2.0])
#Explorer.Series<
  Polars[2]
  float [1.0, 2.0]
>

Floats series can accept NaN, Inf, and -Inf values:

iex> Explorer.Series.from_list([1.0, 2.0, :nan, 4.0])
#Explorer.Series<
  Polars[4]
  float [1.0, 2.0, NaN, 4.0]
>

iex> Explorer.Series.from_list([1.0, 2.0, :infinity, 4.0])
#Explorer.Series<
  Polars[4]
  float [1.0, 2.0, Inf, 4.0]
>

iex> Explorer.Series.from_list([1.0, 2.0, :neg_infinity, 4.0])
#Explorer.Series<
  Polars[4]
  float [1.0, 2.0, -Inf, 4.0]
>

Trying to create a "nil" series will, by default, result in a series of floats:

iex> Explorer.Series.from_list([nil, nil])
#Explorer.Series<
  Polars[2]
  float [nil, nil]
>

You can specify the desired dtype for a series with the :dtype option.

iex> Explorer.Series.from_list([nil, nil], dtype: :integer)
#Explorer.Series<
  Polars[2]
  integer [nil, nil]
>

iex> Explorer.Series.from_list([1, nil], dtype: :string)
#Explorer.Series<
  Polars[2]
  string ["1", nil]
>

The dtype option is particulary important if a :binary series is desired, because by default binary series will have the dtype of :string:

iex> Explorer.Series.from_list([<<228, 146, 51>>, <<42, 209, 236>>], dtype: :binary)
#Explorer.Series<
  Polars[2]
  binary [<<228, 146, 51>>, <<42, 209, 236>>]
>

A series mixing UTF8 strings and binaries is possible:

iex> Explorer.Series.from_list([<<228, 146, 51>>, "Elixir"], dtype: :binary)
#Explorer.Series<
  Polars[2]
  binary [<<228, 146, 51>>, "Elixir"]
>

Another option is to create a categorical series from a list of strings:

iex> Explorer.Series.from_list(["EUA", "Brazil", "Poland"], dtype: :category)
#Explorer.Series<
  Polars[3]
  category ["EUA", "Brazil", "Poland"]
>

It is possible to create a series of :datetime from a list of microseconds since Unix Epoch.

iex> Explorer.Series.from_list([1649883642 * 1_000 * 1_000], dtype: :datetime)
#Explorer.Series<
  Polars[1]
  datetime [2022-04-13 21:00:42.000000]
>

It is possible to create a series of :time from a list of microseconds since midnight.

iex> Explorer.Series.from_list([123 * 1_000 * 1_000], dtype: :time)
#Explorer.Series<
  Polars[1]
  time [00:02:03.000000]
>

Mixing non-numeric data types will raise an ArgumentError:

iex> Explorer.Series.from_list([1, "a"])
** (ArgumentError) the value "a" does not match the inferred series dtype :integer

from_tensor(tensor, opts \\ [])

@spec from_tensor(tensor :: Nx.Tensor.t(), opts :: Keyword.t()) :: t()

Converts a Nx.Tensor.t/0 to a series.

Warning
Nx is an optional dependency. You will need to ensure it's installed to use this function.

options
Options

:backend - The backend to allocate the series on.
:dtype - The dtype of the series, it must match the underlying tensor type.

examples
Examples

Integers and floats:

iex> tensor = Nx.tensor([1, 2, 3])
iex> Explorer.Series.from_tensor(tensor)
#Explorer.Series<
  Polars[3]
  integer [1, 2, 3]
>

iex> tensor = Nx.tensor([1.0, 2.0, 3.0], type: :f64)
iex> Explorer.Series.from_tensor(tensor)
#Explorer.Series<
  Polars[3]
  float [1.0, 2.0, 3.0]
>

Unsigned 8-bit tensors are assumed to be booleans:

iex> tensor = Nx.tensor([1, 0, 1], type: :u8)
iex> Explorer.Series.from_tensor(tensor)
#Explorer.Series<
  Polars[3]
  boolean [true, false, true]
>

Signed 32-bit tensors are assumed to be dates:

iex> tensor = Nx.tensor([-719162, 0, 6129], type: :s32)
iex> Explorer.Series.from_tensor(tensor)
#Explorer.Series<
  Polars[3]
  date [0001-01-01, 1970-01-01, 1986-10-13]
>

Times are signed 64-bit and therefore must have their dtype explicitly given:

iex> tensor = Nx.tensor([0, 86399999999])
iex> Explorer.Series.from_tensor(tensor, dtype: :time)
#Explorer.Series<
  Polars[2]
  time [00:00:00.000000, 23:59:59.999999]
>

Datetimes are signed 64-bit and therefore must have their dtype explicitly given:

iex> tensor = Nx.tensor([0, 529550625987654])
iex> Explorer.Series.from_tensor(tensor, dtype: :datetime)
#Explorer.Series<
  Polars[2]
  datetime [1970-01-01 00:00:00.000000, 1986-10-13 01:23:45.987654]
>

replace(series, tensor_or_list)

@spec replace(t(), Nx.Tensor.t() | list()) :: t()

Replaces the contents of the given series by the one given in a tensor or list.

The new series will have the same dtype and backend as the current series, but the size may not necessarily match.

tensor-examples
Tensor examples

iex> s = Explorer.Series.from_list([0, 1, 2])
iex> Explorer.Series.replace(s, Nx.tensor([1, 2, 3]))
#Explorer.Series<
  Polars[3]
  integer [1, 2, 3]
>

This is particularly useful for categorical columns:

iex> s = Explorer.Series.from_list(["foo", "bar", "baz"], dtype: :category)
iex> Explorer.Series.replace(s, Nx.tensor([2, 1, 0]))
#Explorer.Series<
  Polars[3]
  category ["baz", "bar", "foo"]
>

list-examples
List examples

Similar to tensors, we can also replace by lists:

iex> s = Explorer.Series.from_list([0, 1, 2])
iex> Explorer.Series.replace(s, [1, 2, 3, 4, 5])
#Explorer.Series<
  Polars[5]
  integer [1, 2, 3, 4, 5]
>

The same considerations as above apply.

to_binary(series)

@spec to_binary(series :: t()) :: binary()

Returns a series as a fixed-width binary.

This is a shortcut around to_iovec/1. If possible, prefer to use to_iovec/1 as that avoids copying binaries.

examples
Examples

iex> series = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.to_binary(series)
<<1::signed-64-native, 2::signed-64-native, 3::signed-64-native>>

iex> series = Explorer.Series.from_list([true, false, true])
iex> Explorer.Series.to_binary(series)
<<1, 0, 1>>

to_enum(series)

@spec to_enum(series :: t()) :: Enumerable.t()

Converts a series to an enumerable.

The enumerable will lazily traverse the series.

Warning
You must avoid converting a series to enum, as that will copy the whole series in memory as you traverse it. Prefer to use the operations in this module rather than the ones in Enum whenever possible, as this module is optimized for large series.

examples
Examples

iex> series = Explorer.Series.from_list([1, 2, 3])
iex> series |> Explorer.Series.to_enum() |> Enum.to_list()
[1, 2, 3]

to_iovec(series)

@spec to_iovec(series :: t()) :: [binary()]

Returns a series as a list of fixed-width binaries.

An io vector (iovec) is the Erlang VM term for a flat list of binaries. This is typically a reference to the in-memory representation of the series. If the whole series in contiguous in memory, then the list will have a single element. All binaries are in native endianness.

This operation fails if the series has nil values. Use fill_missing/1 to handle them accordingly.

To retrieve the type of the underlying io vector, use iotype/1. To convert an iovec to a binary, you can use IO.iodata_to_binary/1.

examples
Examples

Integers and floats follow their native encoding:

iex> series = Explorer.Series.from_list([-1, 0, 1])
iex> Explorer.Series.to_iovec(series)
[<<-1::signed-64-native, 0::signed-64-native, 1::signed-64-native>>]

iex> series = Explorer.Series.from_list([1.0, 2.0, 3.0])
iex> Explorer.Series.to_iovec(series)
[<<1.0::float-64-native, 2.0::float-64-native, 3.0::float-64-native>>]

Booleans are encoded as 0 and 1:

iex> series = Explorer.Series.from_list([true, false, true])
iex> Explorer.Series.to_iovec(series)
[<<1, 0, 1>>]

Dates are encoded as i32 representing days from the Unix epoch (1970-01-01):

iex> series = Explorer.Series.from_list([~D[0001-01-01], ~D[1970-01-01], ~D[1986-10-13]])
iex> Explorer.Series.to_iovec(series)
[<<-719162::signed-32-native, 0::signed-32-native, 6129::signed-32-native>>]

Times are encoded as i64 representing microseconds from midnight:

iex> series = Explorer.Series.from_list([~T[00:00:00.000000], ~T[23:59:59.999999]])
iex> Explorer.Series.to_iovec(series)
[<<0::signed-64-native, 86399999999::signed-64-native>>]

Datetimes are encoded as i64 representing microseconds from the Unix epoch (1970-01-01):

iex> series = Explorer.Series.from_list([~N[0001-01-01 00:00:00], ~N[1970-01-01 00:00:00], ~N[1986-10-13 01:23:45.987654]])
iex> Explorer.Series.to_iovec(series)
[<<-62135596800000000::signed-64-native, 0::signed-64-native, 529550625987654::signed-64-native>>]

The operation raises for binaries and strings, as they do not provide a fixed-width binary representation:

iex> s = Explorer.Series.from_list(["a", "b", "c", "b"])
iex> Explorer.Series.to_iovec(s)
** (ArgumentError) cannot convert series of dtype :string into iovec

However, if appropriate, you can convert them to categorical types, which will then return the index of each category:

iex> series = Explorer.Series.from_list(["a", "b", "c", "b"], dtype: :category)
iex> Explorer.Series.to_iovec(series)
[<<0::unsigned-32-native, 1::unsigned-32-native, 2::unsigned-32-native, 1::unsigned-32-native>>]

to_list(series)

@spec to_list(series :: t()) :: list()

Converts a series to a list.

Warning
You must avoid converting a series to list, as that requires copying the whole series in memory. Prefer to use the operations in this module rather than the ones in Enum whenever possible, as this module is optimized for large series.

examples
Examples

iex> series = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.to_list(series)
[1, 2, 3]

to_tensor(series, tensor_opts \\ [])

@spec to_tensor(series :: t(), tensor_opts :: Keyword.t()) :: Nx.Tensor.t()

Converts a series to a Nx.Tensor.t/0.

Note that Explorer.Series are automatically converted to tensors once give to numerical definitions. The tensor type is given by iotype/1.

Warning
Nx is an optional dependency. You will need to ensure it's installed to use this function.

options
Options

:backend - the Nx backend to allocate the tensor on

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.to_tensor(s)
#Nx.Tensor<
  s64[3]
  [1, 2, 3]
>

iex> s = Explorer.Series.from_list([true, false, true])
iex> Explorer.Series.to_tensor(s)
#Nx.Tensor<
  u8[3]
  [1, 0, 1]
>

Link to this section Functions: Aggregation

count(series)

Counts the number of elements in a series.

In the context of lazy series and Explorer.Query, count/1 counts the elements inside the same group. If no group is in use, then count is going to return the size of the series.

examples
Examples

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.count(s)
3

frequencies(series)

Creates a new dataframe with unique values and the frequencies of each.

examples
Examples

iex> s = Explorer.Series.from_list(["a", "a", "b", "c", "c", "c"])
iex> Explorer.Series.frequencies(s)
#Explorer.DataFrame<
  Polars[3 x 2]
  values string ["c", "a", "b"]
  counts integer [3, 2, 1]
>

max(series)

@spec max(series :: t()) :: number() | Date.t() | Time.t() | NaiveDateTime.t() | nil

Gets the maximum value of the series.

supported-dtypes
Supported dtypes

:integer
:float
:date
:time
:datetime

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, nil, 3])
iex> Explorer.Series.max(s)
3

iex> s = Explorer.Series.from_list([1.0, 2.0, nil, 3.0])
iex> Explorer.Series.max(s)
3.0

iex> s = Explorer.Series.from_list([~D[2021-01-01], ~D[1999-12-31]])
iex> Explorer.Series.max(s)
~D[2021-01-01]

iex> s = Explorer.Series.from_list([~N[2021-01-01 00:00:00], ~N[1999-12-31 00:00:00]])
iex> Explorer.Series.max(s)
~N[2021-01-01 00:00:00.000000]

iex> s = Explorer.Series.from_list([~T[00:02:03.000000], ~T[00:05:04.000000]])
iex> Explorer.Series.max(s)
~T[00:05:04.000000]

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.max(s)
** (ArgumentError) Explorer.Series.max/1 not implemented for dtype :string. Valid dtypes are [:integer, :float, :date, :time, :datetime]

mean(series)

@spec mean(series :: t()) :: float() | nil

Gets the mean value of the series.

supported-dtypes
Supported dtypes

:integer
:float

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, nil, 3])
iex> Explorer.Series.mean(s)
2.0

iex> s = Explorer.Series.from_list([1.0, 2.0, nil, 3.0])
iex> Explorer.Series.mean(s)
2.0

iex> s = Explorer.Series.from_list([~D[2021-01-01], ~D[1999-12-31]])
iex> Explorer.Series.mean(s)
** (ArgumentError) Explorer.Series.mean/1 not implemented for dtype :date. Valid dtypes are [:integer, :float]

median(series)

@spec median(series :: t()) :: float() | nil

Gets the median value of the series.

supported-dtypes
Supported dtypes

:integer
:float

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, nil, 3])
iex> Explorer.Series.median(s)
2.0

iex> s = Explorer.Series.from_list([1.0, 2.0, nil, 3.0])
iex> Explorer.Series.median(s)
2.0

iex> s = Explorer.Series.from_list([~D[2021-01-01], ~D[1999-12-31]])
iex> Explorer.Series.median(s)
** (ArgumentError) Explorer.Series.median/1 not implemented for dtype :date. Valid dtypes are [:integer, :float]

min(series)

@spec min(series :: t()) :: number() | Date.t() | Time.t() | NaiveDateTime.t() | nil

Gets the minimum value of the series.

supported-dtypes
Supported dtypes

:integer
:float
:date
:time
:datetime

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, nil, 3])
iex> Explorer.Series.min(s)
1

iex> s = Explorer.Series.from_list([1.0, 2.0, nil, 3.0])
iex> Explorer.Series.min(s)
1.0

iex> s = Explorer.Series.from_list([~D[2021-01-01], ~D[1999-12-31]])
iex> Explorer.Series.min(s)
~D[1999-12-31]

iex> s = Explorer.Series.from_list([~N[2021-01-01 00:00:00], ~N[1999-12-31 00:00:00]])
iex> Explorer.Series.min(s)
~N[1999-12-31 00:00:00.000000]

iex> s = Explorer.Series.from_list([~T[00:02:03.000000], ~T[00:05:04.000000]])
iex> Explorer.Series.min(s)
~T[00:02:03.000000]

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.min(s)
** (ArgumentError) Explorer.Series.min/1 not implemented for dtype :string. Valid dtypes are [:integer, :float, :date, :time, :datetime]

n_distinct(series)

Returns the number of unique values in the series.

examples
Examples

iex> s = Explorer.Series.from_list(["a", "b", "a", "b"])
iex> Explorer.Series.n_distinct(s)
2

nil_count(series)

Counts the number of null elements in a series.

examples
Examples

iex> s = Explorer.Series.from_list(["a", nil, "c", nil, nil])
iex> Explorer.Series.nil_count(s)
3

quantile(series, quantile)

@spec quantile(series :: t(), quantile :: float()) :: any()

Gets the given quantile of the series.

supported-dtypes
Supported dtypes

:integer
:float
:date
:time
:datetime

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, nil, 3])
iex> Explorer.Series.quantile(s, 0.2)
1

iex> s = Explorer.Series.from_list([1.0, 2.0, nil, 3.0])
iex> Explorer.Series.quantile(s, 0.5)
2.0

iex> s = Explorer.Series.from_list([~D[2021-01-01], ~D[1999-12-31]])
iex> Explorer.Series.quantile(s, 0.5)
~D[2021-01-01]

iex> s = Explorer.Series.from_list([~N[2021-01-01 00:00:00], ~N[1999-12-31 00:00:00]])
iex> Explorer.Series.quantile(s, 0.5)
~N[2021-01-01 00:00:00.000000]

iex> s = Explorer.Series.from_list([~T[01:55:00.000000], ~T[15:35:00.000000], ~T[23:00:00.000000]])
iex> Explorer.Series.quantile(s, 0.5)
~T[15:35:00.000000]

iex> s = Explorer.Series.from_list([true, false, true])
iex> Explorer.Series.quantile(s, 0.5)
** (ArgumentError) Explorer.Series.quantile/2 not implemented for dtype :boolean. Valid dtypes are [:integer, :float, :date, :time, :datetime]

standard_deviation(series)

@spec standard_deviation(series :: t()) :: float() | nil

Gets the standard deviation of the series.

supported-dtypes
Supported dtypes

:integer
:float

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, nil, 3])
iex> Explorer.Series.standard_deviation(s)
1.0

iex> s = Explorer.Series.from_list([1.0, 2.0, nil, 3.0])
iex> Explorer.Series.standard_deviation(s)
1.0

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.standard_deviation(s)
** (ArgumentError) Explorer.Series.standard_deviation/1 not implemented for dtype :string. Valid dtypes are [:integer, :float]

sum(series)

@spec sum(series :: t()) :: number() | nil

Gets the sum of the series.

supported-dtypes
Supported dtypes

:integer
:float
:boolean

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, nil, 3])
iex> Explorer.Series.sum(s)
6

iex> s = Explorer.Series.from_list([1.0, 2.0, nil, 3.0])
iex> Explorer.Series.sum(s)
6.0

iex> s = Explorer.Series.from_list([true, false, true])
iex> Explorer.Series.sum(s)
2

iex> s = Explorer.Series.from_list([~D[2021-01-01], ~D[1999-12-31]])
iex> Explorer.Series.sum(s)
** (ArgumentError) Explorer.Series.sum/1 not implemented for dtype :date. Valid dtypes are [:integer, :float, :boolean]

variance(series)

@spec variance(series :: t()) :: float() | nil

Gets the variance of the series.

supported-dtypes
Supported dtypes

:integer
:float

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, nil, 3])
iex> Explorer.Series.variance(s)
1.0

iex> s = Explorer.Series.from_list([1.0, 2.0, nil, 3.0])
iex> Explorer.Series.variance(s)
1.0

iex> s = Explorer.Series.from_list([~N[2021-01-01 00:00:00], ~N[1999-12-31 00:00:00]])
iex> Explorer.Series.variance(s)
** (ArgumentError) Explorer.Series.variance/1 not implemented for dtype :datetime. Valid dtypes are [:integer, :float]

Link to this section Functions: Element-wise

add(left, right)

@spec add(left :: t() | number(), right :: t() | number()) :: t()

Adds right to left, element-wise.

When mixing floats and integers, the resulting series will have dtype :float.

At least one of the arguments must be a series. If both sizes are series, the series must have the same size or at last one of them must have size of 1.

supported-dtypes
Supported dtypes

:integer
:float

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> s2 = Explorer.Series.from_list([4, 5, 6])
iex> Explorer.Series.add(s1, s2)
#Explorer.Series<
  Polars[3]
  integer [5, 7, 9]
>

You can also use scalar values on both sides:

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.add(s1, 2)
#Explorer.Series<
  Polars[3]
  integer [3, 4, 5]
>

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.add(2, s1)
#Explorer.Series<
  Polars[3]
  integer [3, 4, 5]
>

all_equal(left, right)

Checks equality between two entire series.

examples
Examples

iex> s1 = Explorer.Series.from_list(["a", "b"])
iex> s2 = Explorer.Series.from_list(["a", "b"])
iex> Explorer.Series.all_equal(s1, s2)
true

iex> s1 = Explorer.Series.from_list(["a", "b"])
iex> s2 = Explorer.Series.from_list(["a", "c"])
iex> Explorer.Series.all_equal(s1, s2)
false

iex> s1 = Explorer.Series.from_list(["a", "b"])
iex> s2 = Explorer.Series.from_list([1, 2])
iex> Explorer.Series.all_equal(s1, s2)
false

left and right

Returns a boolean mask of left and right, element-wise.

Both sizes must be series, the series must have the same size or at last one of them must have size of 1.

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> mask1 = Explorer.Series.greater(s1, 1)
iex> mask2 = Explorer.Series.less(s1, 3)
iex> Explorer.Series.and(mask1, mask2)
#Explorer.Series<
  Polars[3]
  boolean [false, true, false]
>

cast(series, dtype)

@spec cast(series :: t(), dtype :: dtype()) :: t()

Cast the series to another type.

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.cast(s, :string)
#Explorer.Series<
  Polars[3]
  string ["1", "2", "3"]
>

iex> s = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.cast(s, :float)
#Explorer.Series<
  Polars[3]
  float [1.0, 2.0, 3.0]
>

iex> s = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.cast(s, :date)
#Explorer.Series<
  Polars[3]
  date [1970-01-02, 1970-01-03, 1970-01-04]
>

Note that time is represented as an integer of microseconds since midnight.

iex> s = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.cast(s, :time)
#Explorer.Series<
  Polars[3]
  time [00:00:00.000001, 00:00:00.000002, 00:00:00.000003]
>

iex> s = Explorer.Series.from_list([86399 * 1_000 * 1_000])
iex> Explorer.Series.cast(s, :time)
#Explorer.Series<
  Polars[1]
  time [23:59:59.000000]
>

Note that datetime is represented as an integer of microseconds since Unix Epoch (1970-01-01 00:00:00).

iex> s = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.cast(s, :datetime)
#Explorer.Series<
  Polars[3]
  datetime [1970-01-01 00:00:00.000001, 1970-01-01 00:00:00.000002, 1970-01-01 00:00:00.000003]
>

iex> s = Explorer.Series.from_list([1649883642 * 1_000 * 1_000])
iex> Explorer.Series.cast(s, :datetime)
#Explorer.Series<
  Polars[1]
  datetime [2022-04-13 21:00:42.000000]
>

You can also use cast/2 to categorise a string:

iex> s = Explorer.Series.from_list(["apple", "banana",  "apple", "lemon"])
iex> Explorer.Series.cast(s, :category)
#Explorer.Series<
  Polars[4]
  category ["apple", "banana", "apple", "lemon"]
>

cast/2 will return the series as a no-op if you try to cast to the same dtype.

iex> s = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.cast(s, :integer)
#Explorer.Series<
  Polars[3]
  integer [1, 2, 3]
>

categorise(series, categories)

Apply categories to a series of integers.

The first argument is a series of integers which are indexes into the second argument. The second argument can be one of:

a series with dtype :category. The integers will be indexes into the categories of the given series (returned by categories/1)
a series with dtype :string. The integers will be indexes into the series itself
a list of strings. The integers will be indexes into the list

examples
Examples

iex> categories = Explorer.Series.from_list(["a", "b", "c"], dtype: :category)
iex> indexes = Explorer.Series.from_list([0, 2, 1, 0, 2])
iex> Explorer.Series.categorise(indexes, categories)
#Explorer.Series<
  Polars[5]
  category ["a", "c", "b", "a", "c"]
>

iex> indexes = Explorer.Series.from_list([0, 2, 1, 0, 2])
iex> Explorer.Series.categorise(indexes, ["a", "b", "c"])
#Explorer.Series<
  Polars[5]
  category ["a", "c", "b", "a", "c"]
>

Elements that are not mapped to a category will become nil:

iex> indexes = Explorer.Series.from_list([0, 2, 1, 0, 2, 7])
iex> Explorer.Series.categorise(indexes, ["a", "b", "c"])
#Explorer.Series<
  Polars[6]
  category ["a", "c", "b", "a", "c", nil]
>

A categorical series can have duplicated and nil values:

iex> categories = Explorer.Series.from_list(["a", "b", "c", nil, "a"], dtype: :category)
iex> indexes = Explorer.Series.from_list([0, 2, 1, 0, 2])
iex> Explorer.Series.categorise(indexes, categories)
#Explorer.Series<
  Polars[5]
  category ["a", "c", "b", "a", "c"]
>

coalesce(list)

@spec coalesce([t()]) :: t()

Finds the first non-missing element at each position.

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, nil, nil])
iex> s2 = Explorer.Series.from_list([1, 2, nil, 4])
iex> s3 = Explorer.Series.from_list([nil, nil, 3, 4])
iex> Explorer.Series.coalesce([s1, s2, s3])
#Explorer.Series<
  Polars[4]
  integer [1, 2, 3, 4]
>

coalesce(s1, s2)

@spec coalesce(s1 :: t(), s2 :: t()) :: t()

Finds the first non-missing element at each position.

coalesce(s1, s2) is equivalent to coalesce([s1, s2]).

examples
Examples

iex> s1 = Explorer.Series.from_list([1, nil, 3, nil])
iex> s2 = Explorer.Series.from_list([1, 2, nil, 4])
iex> Explorer.Series.coalesce(s1, s2)
#Explorer.Series<
  Polars[4]
  integer [1, 2, 3, 4]
>

iex> s1 = Explorer.Series.from_list(["foo", nil, "bar", nil])
iex> s2 = Explorer.Series.from_list([1, 2, nil, 4])
iex> Explorer.Series.coalesce(s1, s2)
** (ArgumentError) cannot invoke Explorer.Series.coalesce/2 with mismatched dtypes: :string and :integer

divide(left, right)

@spec divide(left :: t() | number(), right :: t() | number()) :: t()

Divides left by right, element-wise.

The resulting series will have the dtype as :float.

At least one of the arguments must be a series. If both sizes are series, the series must have the same size or at last one of them must have size of 1.

supported-dtypes
Supported dtypes

:integer
:float

examples
Examples

iex> s1 = [10, 10, 10] |> Explorer.Series.from_list()
iex> s2 = [2, 2, 2] |> Explorer.Series.from_list()
iex> Explorer.Series.divide(s1, s2)
#Explorer.Series<
  Polars[3]
  float [5.0, 5.0, 5.0]
>

iex> s1 = [10, 10, 10] |> Explorer.Series.from_list()
iex> Explorer.Series.divide(s1, 2)
#Explorer.Series<
  Polars[3]
  float [5.0, 5.0, 5.0]
>

iex> s1 = [10, 52 ,10] |> Explorer.Series.from_list()
iex> Explorer.Series.divide(s1, 2.5)
#Explorer.Series<
  Polars[3]
  float [4.0, 20.8, 4.0]
>

iex> s1 = [10, 10, 10] |> Explorer.Series.from_list()
iex> s2 = [2, 0, 2] |> Explorer.Series.from_list()
iex> Explorer.Series.divide(s1, s2)
#Explorer.Series<
  Polars[3]
  float [5.0, Inf, 5.0]
>

equal(left, right)

@spec equal(
  left ::
    t() | number() | Date.t() | NaiveDateTime.t() | boolean() | String.t(),
  right ::
    t() | number() | Date.t() | NaiveDateTime.t() | boolean() | String.t()
) :: t()

Returns boolean mask of left == right, element-wise.

At least one of the arguments must be a series. If both sizes are series, the series must have the same size or at last one of them must have size of 1.

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> s2 = Explorer.Series.from_list([1, 2, 4])
iex> Explorer.Series.equal(s1, s2)
#Explorer.Series<
  Polars[3]
  boolean [true, true, false]
>

iex> s = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.equal(s, 1)
#Explorer.Series<
  Polars[3]
  boolean [true, false, false]
>

iex> s = Explorer.Series.from_list([true, true, false])
iex> Explorer.Series.equal(s, true)
#Explorer.Series<
  Polars[3]
  boolean [true, true, false]
>

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.equal(s, "a")
#Explorer.Series<
  Polars[3]
  boolean [true, false, false]
>

iex> s = Explorer.Series.from_list([~D[2021-01-01], ~D[1999-12-31]])
iex> Explorer.Series.equal(s, ~D[1999-12-31])
#Explorer.Series<
  Polars[2]
  boolean [false, true]
>

iex> s = Explorer.Series.from_list([~N[2022-01-01 00:00:00], ~N[2022-01-01 23:00:00]])
iex> Explorer.Series.equal(s, ~N[2022-01-01 00:00:00])
#Explorer.Series<
  Polars[2]
  boolean [true, false]
>

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.equal(s, false)
** (ArgumentError) cannot invoke Explorer.Series.equal/2 with mismatched dtypes: :string and false

greater(left, right)

@spec greater(
  left :: t() | number() | Date.t() | NaiveDateTime.t(),
  right :: t() | number() | Date.t() | NaiveDateTime.t()
) :: t()

Returns boolean mask of left > right, element-wise.

At least one of the arguments must be a series. If both sizes are series, the series must have the same size or at last one of them must have size of 1.

supported-dtypes
Supported dtypes

:integer
:float
:date
:time
:datetime

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> s2 = Explorer.Series.from_list([1, 2, 4])
iex> Explorer.Series.greater(s1, s2)
#Explorer.Series<
  Polars[3]
  boolean [false, false, false]
>

greater_equal(left, right)

@spec greater_equal(
  left :: t() | number() | Date.t() | NaiveDateTime.t(),
  right :: t() | number() | Date.t() | NaiveDateTime.t()
) :: t()

Returns boolean mask of left >= right, element-wise.

At least one of the arguments must be a series. If both sizes are series, the series must have the same size or at last one of them must have size of 1.

supported-dtypes
Supported dtypes

:integer
:float
:date
:time
:datetime

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> s2 = Explorer.Series.from_list([1, 2, 4])
iex> Explorer.Series.greater_equal(s1, s2)
#Explorer.Series<
  Polars[3]
  boolean [true, true, false]
>

left in right

Checks if each element of the series in the left exists in the series in the right, returning a boolean mask.

The series sizes do not have to match.

examples
Examples

iex> left = Explorer.Series.from_list([1, 2, 3])
iex> right = Explorer.Series.from_list([1, 2])
iex> Series.in(left, right)
#Explorer.Series<
  Polars[3]
  boolean [true, true, false]
>

iex> left = Explorer.Series.from_list([~D[1970-01-01], ~D[2000-01-01], ~D[2010-04-17]])
iex> right = Explorer.Series.from_list([~D[1970-01-01], ~D[2010-04-17]])
iex> Series.in(left, right)
#Explorer.Series<
  Polars[3]
  boolean [true, false, true]
>

is_nil(series)

@spec is_nil(t()) :: t()

Returns a mask of nil values.

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, nil, 4])
iex> Explorer.Series.is_nil(s)
#Explorer.Series<
  Polars[4]
  boolean [false, false, true, false]
>

is_not_nil(series)

@spec is_not_nil(t()) :: t()

Returns a mask of not nil values.

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, nil, 4])
iex> Explorer.Series.is_not_nil(s)
#Explorer.Series<
  Polars[4]
  boolean [true, true, false, true]
>

less(left, right)

@spec less(
  left :: t() | number() | Date.t() | NaiveDateTime.t(),
  right :: t() | number() | Date.t() | NaiveDateTime.t()
) :: t()

Returns boolean mask of left < right, element-wise.

At least one of the arguments must be a series. If both sizes are series, the series must have the same size or at last one of them must have size of 1.

supported-dtypes
Supported dtypes

:integer
:float
:date
:time
:datetime

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> s2 = Explorer.Series.from_list([1, 2, 4])
iex> Explorer.Series.less(s1, s2)
#Explorer.Series<
  Polars[3]
  boolean [false, false, true]
>

less_equal(left, right)

@spec less_equal(
  left :: t() | number() | Date.t() | NaiveDateTime.t(),
  right :: t() | number() | Date.t() | NaiveDateTime.t()
) :: t()

Returns boolean mask of left <= right, element-wise.

At least one of the arguments must be a series. If both sizes are series, the series must have the same size or at last one of them must have size of 1.

supported-dtypes
Supported dtypes

:integer
:float
:date
:time
:datetime

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> s2 = Explorer.Series.from_list([1, 2, 4])
iex> Explorer.Series.less_equal(s1, s2)
#Explorer.Series<
  Polars[3]
  boolean [true, true, true]
>

mask(series, mask)

@spec mask(series :: t(), mask :: t()) :: t()

Filters a series with a mask.

examples
Examples

iex> s1 = Explorer.Series.from_list([1,2,3])
iex> s2 = Explorer.Series.from_list([true, false, true])
iex> Explorer.Series.mask(s1, s2)
#Explorer.Series<
  Polars[2]
  integer [1, 3]
>

multiply(left, right)

@spec multiply(left :: t() | number(), right :: t() | number()) :: t()

Multiplies left and right, element-wise.

When mixing floats and integers, the resulting series will have dtype :float.

At least one of the arguments must be a series. If both sizes are series, the series must have the same size or at last one of them must have size of 1.

supported-dtypes
Supported dtypes

:integer
:float

examples
Examples

iex> s1 = 1..10 |> Enum.to_list() |> Explorer.Series.from_list()
iex> s2 = 11..20 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.multiply(s1, s2)
#Explorer.Series<
  Polars[10]
  integer [11, 24, 39, 56, 75, 96, 119, 144, 171, 200]
>

iex> s1 = 1..5 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.multiply(s1, 2)
#Explorer.Series<
  Polars[5]
  integer [2, 4, 6, 8, 10]
>

not series

Negate the elements of a boolean series.

examples
Examples

iex> s1 = Explorer.Series.from_list([true, false, false])
iex> Explorer.Series.not(s1)
#Explorer.Series<
  Polars[3]
  boolean [false, true, true]
>

not_equal(left, right)

@spec not_equal(
  left ::
    t() | number() | Date.t() | NaiveDateTime.t() | boolean() | String.t(),
  right ::
    t() | number() | Date.t() | NaiveDateTime.t() | boolean() | String.t()
) :: t()

Returns boolean mask of left != right, element-wise.

At least one of the arguments must be a series. If both sizes are series, the series must have the same size or at last one of them must have size of 1.

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> s2 = Explorer.Series.from_list([1, 2, 4])
iex> Explorer.Series.not_equal(s1, s2)
#Explorer.Series<
  Polars[3]
  boolean [false, false, true]
>

iex> s = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.not_equal(s, 1)
#Explorer.Series<
  Polars[3]
  boolean [false, true, true]
>

iex> s = Explorer.Series.from_list([true, true, false])
iex> Explorer.Series.not_equal(s, true)
#Explorer.Series<
  Polars[3]
  boolean [false, false, true]
>

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.not_equal(s, "a")
#Explorer.Series<
  Polars[3]
  boolean [false, true, true]
>

iex> s = Explorer.Series.from_list([~D[2021-01-01], ~D[1999-12-31]])
iex> Explorer.Series.not_equal(s, ~D[1999-12-31])
#Explorer.Series<
  Polars[2]
  boolean [true, false]
>

iex> s = Explorer.Series.from_list([~N[2022-01-01 00:00:00], ~N[2022-01-01 23:00:00]])
iex> Explorer.Series.not_equal(s, ~N[2022-01-01 00:00:00])
#Explorer.Series<
  Polars[2]
  boolean [false, true]
>

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.not_equal(s, false)
** (ArgumentError) cannot invoke Explorer.Series.not_equal/2 with mismatched dtypes: :string and false

left or right

Returns a boolean mask of left or right, element-wise.

Both sizes must be series, the series must have the same size or at last one of them must have size of 1.

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> mask1 = Explorer.Series.less(s1, 2)
iex> mask2 = Explorer.Series.greater(s1, 2)
iex> Explorer.Series.or(mask1, mask2)
#Explorer.Series<
  Polars[3]
  boolean [true, false, true]
>

peaks(series, max_or_min \\ :max)

@spec peaks(series :: t(), max_or_min :: :max | :min) :: t()

Returns a boolean mask with true where the 'peaks' (series max or min, default max) are.

supported-dtypes
Supported dtypes

:integer
:float
:date
:time
:datetime

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, 4, 1, 4])
iex> Explorer.Series.peaks(s)
#Explorer.Series<
  Polars[5]
  boolean [false, false, true, false, true]
>

iex> s = [~T[03:00:02.000000], ~T[13:24:56.000000], ~T[02:04:19.000000]] |> Explorer.Series.from_list()
iex> Explorer.Series.peaks(s)
#Explorer.Series<
  Polars[3]
  boolean [false, true, false]
>

pow(left, right)

@spec pow(left :: t() | number(), right :: t() | number()) :: t()

Raises a numeric series to the power of the exponent.

At least one of the arguments must be a series. If both sizes are series, the series must have the same size or at last one of them must have size of 1.

supported-dtypes
Supported dtypes

:integer
:float

examples
Examples

iex> s = [8, 16, 32] |> Explorer.Series.from_list()
iex> Explorer.Series.pow(s, 2.0)
#Explorer.Series<
  Polars[3]
  float [64.0, 256.0, 1024.0]
>

iex> s = [2, 4, 6] |> Explorer.Series.from_list()
iex> Explorer.Series.pow(s, 3)
#Explorer.Series<
  Polars[3]
  integer [8, 64, 216]
>

iex> s = [2, 4, 6] |> Explorer.Series.from_list()
iex> Explorer.Series.pow(s, -3.0)
#Explorer.Series<
  Polars[3]
  float [0.125, 0.015625, 0.004629629629629629]
>

iex> s = [1.0, 2.0, 3.0] |> Explorer.Series.from_list()
iex> Explorer.Series.pow(s, 3.0)
#Explorer.Series<
  Polars[3]
  float [1.0, 8.0, 27.0]
>

iex> s = [2.0, 4.0, 6.0] |> Explorer.Series.from_list()
iex> Explorer.Series.pow(s, 2)
#Explorer.Series<
  Polars[3]
  float [4.0, 16.0, 36.0]
>

quotient(left, right)

@spec quotient(left :: t(), right :: t() | integer()) :: t()

Element-wise integer division.

At least one of the arguments must be a series. If both sizes are series, the series must have the same size or at last one of them must have size of 1.

supported-dtype
Supported dtype

:integer

Returns nil if there is a zero in the right-hand side.

examples
Examples

iex> s1 = [10, 11, 10] |> Explorer.Series.from_list()
iex> s2 = [2, 2, 2] |> Explorer.Series.from_list()
iex> Explorer.Series.quotient(s1, s2)
#Explorer.Series<
  Polars[3]
  integer [5, 5, 5]
>

iex> s1 = [10, 11, 10] |> Explorer.Series.from_list()
iex> s2 = [2, 2, 0] |> Explorer.Series.from_list()
iex> Explorer.Series.quotient(s1, s2)
#Explorer.Series<
  Polars[3]
  integer [5, 5, nil]
>

iex> s1 = [10, 12, 15] |> Explorer.Series.from_list()
iex> Explorer.Series.quotient(s1, 3)
#Explorer.Series<
  Polars[3]
  integer [3, 4, 5]
>

remainder(left, right)

@spec remainder(left :: t(), right :: t() | integer()) :: t()

Computes the remainder of an element-wise integer division.

At least one of the arguments must be a series. If both sizes are series, the series must have the same size or at last one of them must have size of 1.

supported-dtype
Supported dtype

:integer

Returns nil if there is a zero in the right-hand side.

examples
Examples

iex> s1 = [10, 11, 10] |> Explorer.Series.from_list()
iex> s2 = [2, 2, 2] |> Explorer.Series.from_list()
iex> Explorer.Series.remainder(s1, s2)
#Explorer.Series<
  Polars[3]
  integer [0, 1, 0]
>

iex> s1 = [10, 11, 10] |> Explorer.Series.from_list()
iex> s2 = [2, 2, 0] |> Explorer.Series.from_list()
iex> Explorer.Series.remainder(s1, s2)
#Explorer.Series<
  Polars[3]
  integer [0, 1, nil]
>

iex> s1 = [10, 11, 9] |> Explorer.Series.from_list()
iex> Explorer.Series.remainder(s1, 3)
#Explorer.Series<
  Polars[3]
  integer [1, 2, 0]
>

select(predicate, on_true, on_false)

@spec select(predicate :: t(), on_true :: t(), on_false :: t()) :: t()

Returns a series from two series, based on a predicate.

The resulting series is built by evaluating each element of predicate and returning either the corresponding element from on_true or on_false.

predicate must be a boolean series. on_true and on_false must be a series of the same length as pred.

subtract(left, right)

@spec subtract(left :: t() | number(), right :: t() | number()) :: t()

Subtracts right from left, element-wise.

When mixing floats and integers, the resulting series will have dtype :float.

At least one of the arguments must be a series. If both sizes are series, the series must have the same size or at last one of them must have size of 1.

supported-dtypes
Supported dtypes

:integer
:float

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> s2 = Explorer.Series.from_list([4, 5, 6])
iex> Explorer.Series.subtract(s1, s2)
#Explorer.Series<
  Polars[3]
  integer [-3, -3, -3]
>

You can also use scalar values on both sides:

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.subtract(s1, 2)
#Explorer.Series<
  Polars[3]
  integer [-1, 0, 1]
>

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.subtract(2, s1)
#Explorer.Series<
  Polars[3]
  integer [1, 0, -1]
>

transform(series, fun)

Returns an Explorer.Series where each element is the result of invoking fun on each corresponding element of series.

This is an expensive operation meant to enable the use of arbitrary Elixir functions against any backend. The implementation will vary by backend but in most (all?) cases will require converting to an Elixir.List, applying Enum.map/2, and then converting back to an Explorer.Series.

examples
Examples

iex> s = Explorer.Series.from_list(["this ", " is", "great   "])
iex> Explorer.Series.transform(s, &String.trim/1)
#Explorer.Series<
  Polars[3]
  string ["this", "is", "great"]
>

iex> s = Explorer.Series.from_list(["this", "is", "great"])
iex> Explorer.Series.transform(s, &String.length/1)
#Explorer.Series<
  Polars[3]
  integer [4, 2, 5]
>

Link to this section Functions: Datetime ops

day_of_week(series)

@spec day_of_week(t()) :: t()

Returns a day-of-week number starting from Monday = 1. (ISO 8601 weekday number)

examples
Examples

iex> s = Explorer.Series.from_list([~D[2023-01-15], ~D[2023-01-16], ~D[2023-01-20], nil])
iex> Explorer.Series.day_of_week(s)
#Explorer.Series<
  Polars[4]
  integer [7, 1, 5, nil]
>

It can also be called on a datetime series.

iex> s = Explorer.Series.from_list([~N[2023-01-15 00:00:00], ~N[2023-01-16 23:59:59.999999], ~N[2023-01-20 12:00:00], nil])
iex> Explorer.Series.day_of_week(s)
#Explorer.Series<
  Polars[4]
  integer [7, 1, 5, nil]
>

to_date(series)

@spec to_date(t()) :: t()

Returns date component from the datetime series

examples
Examples

iex> s = Explorer.Series.from_list([~N[2023-01-15 00:00:00.000000], ~N[2023-01-16 23:59:59.999999], ~N[2023-01-20 12:00:00.000000], nil])
iex> Explorer.Series.to_date(s)
#Explorer.Series<
  Polars[4]
  date [2023-01-15, 2023-01-16, 2023-01-20, nil]
>

to_time(series)

@spec to_time(t()) :: t()

Returns time component from the datetime series

examples
Examples

iex> s = Explorer.Series.from_list([~N[2023-01-15 00:00:00.000000], ~N[2023-01-16 23:59:59.999999], ~N[2023-01-20 12:00:00.000000], nil])
iex> Explorer.Series.to_time(s)
#Explorer.Series<
  Polars[4]
  time [00:00:00.000000, 23:59:59.999999, 12:00:00.000000, nil]
>

Link to this section Functions: Float ops

ceil(series)

@spec ceil(t()) :: t()

Ceil floating point series to highest integers smaller or equal to the float value.

examples
Examples

iex> s = Explorer.Series.from_list([1.124993, 2.555321, 3.995001])
iex> Explorer.Series.ceil(s)
#Explorer.Series<
  Polars[3]
  float [2.0, 3.0, 4.0]
>

floor(series)

@spec floor(t()) :: t()

Floor floating point series to lowest integers smaller or equal to the float value.

examples
Examples

iex> s = Explorer.Series.from_list([1.124993, 2.555321, 3.995001])
iex> Explorer.Series.floor(s)
#Explorer.Series<
  Polars[3]
  float [1.0, 2.0, 3.0]
>

is_finite(series)

@spec is_finite(t()) :: t()

Returns a mask of finite values.

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, 0, nil])
iex> s2 = Explorer.Series.from_list([0, 2, 0, nil])
iex> s3 = Explorer.Series.divide(s1, s2)
iex> Explorer.Series.is_finite(s3)
#Explorer.Series<
  Polars[4]
  boolean [false, true, false, nil]
>

is_infinite(series)

@spec is_infinite(t()) :: t()

Returns a mask of infinite values.

examples
Examples

iex> s1 = Explorer.Series.from_list([1, -1, 2, 0, nil])
iex> s2 = Explorer.Series.from_list([0, 0, 2, 0, nil])
iex> s3 = Explorer.Series.divide(s1, s2)
iex> Explorer.Series.is_infinite(s3)
#Explorer.Series<
  Polars[5]
  boolean [true, true, false, false, nil]
>

is_nan(series)

@spec is_nan(t()) :: t()

Returns a mask of infinite values.

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, 0, nil])
iex> s2 = Explorer.Series.from_list([0, 2, 0, nil])
iex> s3 = Explorer.Series.divide(s1, s2)
iex> Explorer.Series.is_nan(s3)
#Explorer.Series<
  Polars[4]
  boolean [false, false, true, nil]
>

round(series, decimals)

@spec round(t(), non_neg_integer()) :: t()

Round floating point series to given decimal places.

examples
Examples

iex> s = Explorer.Series.from_list([1.124993, 2.555321, 3.995001])
iex> Explorer.Series.round(s, 2)
#Explorer.Series<
  Polars[3]
  float [1.12, 2.56, 4.0]
>

Link to this section Functions: String ops

contains(series, pattern)

@spec contains(t(), String.t() | Regex.t()) :: t()

Detects whether a string contains a substring.

examples
Examples

iex> s = Explorer.Series.from_list(["abc", "def", "bcd"])
iex> Explorer.Series.contains(s, "bc")
#Explorer.Series<
  Polars[3]
  boolean [true, false, true]
>

downcase(series)

@spec downcase(t()) :: t()

Converts all characters to lowercase.

examples
Examples

iex> s = Explorer.Series.from_list(["ABC", "DEF", "BCD"])
iex> Explorer.Series.downcase(s)
#Explorer.Series<
  Polars[3]
  string ["abc", "def", "bcd"]
>

trim(series)

@spec trim(t()) :: t()

Returns a string where all leading and trailing Unicode whitespaces have been removed.

examples
Examples

iex> s = Explorer.Series.from_list(["  abc", "def  ", "  bcd"])
iex> Explorer.Series.trim(s)
#Explorer.Series<
  Polars[3]
  string ["abc", "def", "bcd"]
>

trim_leading(series)

@spec trim_leading(t()) :: t()

Returns a string where all leading Unicode whitespaces have been removed.

examples
Examples

iex> s = Explorer.Series.from_list(["  abc", "def  ", "  bcd"])
iex> Explorer.Series.trim_leading(s)
#Explorer.Series<
  Polars[3]
  string ["abc", "def  ", "bcd"]
>

trim_trailing(series)

@spec trim_trailing(t()) :: t()

Returns a string where all trailing Unicode whitespaces have been removed.

examples
Examples

iex> s = Explorer.Series.from_list(["  abc", "def  ", "  bcd"])
iex> Explorer.Series.trim_trailing(s)
#Explorer.Series<
  Polars[3]
  string ["  abc", "def", "  bcd"]
>

upcase(series)

@spec upcase(t()) :: t()

Converts all characters to uppercase.

examples
Examples

iex> s = Explorer.Series.from_list(["abc", "def", "bcd"])
iex> Explorer.Series.upcase(s)
#Explorer.Series<
  Polars[3]
  string ["ABC", "DEF", "BCD"]
>

Link to this section Functions: Introspection

categories(series)

@spec categories(series :: t()) :: t()

Return a series with the category names of a categorical series.

Each category has the index equal to its position. No order for the categories is guaranteed.

examples
Examples

iex> s = Explorer.Series.from_list(["a", "b", "c", nil, "a", "c"], dtype: :category)
iex> Explorer.Series.categories(s)
#Explorer.Series<
  Polars[3]
  string ["a", "b", "c"]
>

iex> s = Explorer.Series.from_list(["c", "a", "b"], dtype: :category)
iex> Explorer.Series.categories(s)
#Explorer.Series<
  Polars[3]
  string ["c", "a", "b"]
>

dtype(series)

@spec dtype(series :: t()) :: dtype()

Returns the data type of the series.

A series can be of the following data types:

:float - 64-bit floating point number
:integer - 64-bit signed integer
:boolean - Boolean
:string - UTF-8 encoded binary
:date - Date type that unwraps to Elixir.Date
:time - Time type that unwraps to Elixir.Time
:datetime - DateTime type that unwraps to Elixir.NaiveDateTime

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, 3])
iex> Explorer.Series.dtype(s)
:integer

iex> s = Explorer.Series.from_list(["a", nil, "b", "c"])
iex> Explorer.Series.dtype(s)
:string

iotype(series)

@spec iotype(series :: t()) :: {:s | :u | :f, non_neg_integer()} | :none

Returns the type of the underlying fixed-width binary representation.

It returns something in the shape of {atom(), bits_size} or :none. It is often used in conjunction with to_iovec/1 and to_binary/1.

The possible iotypes are:

:u for unsigned integers.
:s for signed integers.
:f for floats.

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, 3, 4])
iex> Explorer.Series.iotype(s)
{:s, 64}

iex> s = Explorer.Series.from_list([~D[1999-12-31], ~D[1989-01-01]])
iex> Explorer.Series.iotype(s)
{:s, 32}

iex> s = Explorer.Series.from_list([~T[00:00:00.000000], ~T[23:59:59.999999]])
iex> Explorer.Series.iotype(s)
{:s, 64}

iex> s = Explorer.Series.from_list([1.2, 2.3, 3.5, 4.5])
iex> Explorer.Series.iotype(s)
{:f, 64}

iex> s = Explorer.Series.from_list([true, false, true])
iex> Explorer.Series.iotype(s)
{:u, 8}

The operation returns :none for strings and binaries, as they do not provide a fixed-width binary representation:

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.iotype(s)
:none

However, if appropriate, you can convert them to categorical types, which will then return the index of each category:

iex> s = Explorer.Series.from_list(["a", "b", "c"], dtype: :category)
iex> Explorer.Series.iotype(s)
{:u, 32}

size(series)

@spec size(series :: t()) :: non_neg_integer() | lazy_t()

Returns the size of the series.

This is not allowed inside a lazy series. Use count/1 instead.

examples
Examples

iex> s = Explorer.Series.from_list([~D[1999-12-31], ~D[1989-01-01]])
iex> Explorer.Series.size(s)
2

Link to this section Functions: Shape

argsort(series, opts \\ [])

Returns the indices that would sort the series.

options
Options

:direction - :asc or :desc, meaning "ascending" or "descending", respectively. By default it sorts in acending order.
:nils - :first or :last. By default it is :last if direction is :asc, and :first otherwise.

examples
Examples

iex> s = Explorer.Series.from_list([9, 3, 7, 1])
iex> Explorer.Series.argsort(s)
#Explorer.Series<
  Polars[4]
  integer [3, 1, 2, 0]
>

iex> s = Explorer.Series.from_list([9, 3, 7, 1])
iex> Explorer.Series.argsort(s, direction: :desc)
#Explorer.Series<
  Polars[4]
  integer [0, 2, 1, 3]
>

at(series, idx)

@spec at(series :: t(), idx :: integer()) :: any()

Returns the value of the series at the given index.

This function will raise an error in case the index is out of bounds.

examples
Examples

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.at(s, 2)
"c"

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.at(s, 4)
** (ArgumentError) index 4 out of bounds for series of size 3

at_every(series, every_n)

@spec at_every(series :: t(), every_n :: integer()) :: t()

Takes every nth value in this series, returned as a new series.

examples
Examples

iex> s = 1..10 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.at_every(s, 2)
#Explorer.Series<
  Polars[5]
  integer [1, 3, 5, 7, 9]
>

If n is bigger than the size of the series, the result is a new series with only the first value of the supplied series.

iex> s = 1..10 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.at_every(s, 20)
#Explorer.Series<
  Polars[1]
  integer [1]
>

concat(series)

@spec concat([t()]) :: t()

Concatenate one or more series.

The dtypes must match unless all are numeric, in which case all series will be downcast to float.

examples
Examples

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> s2 = Explorer.Series.from_list([4, 5, 6])
iex> Explorer.Series.concat([s1, s2])
#Explorer.Series<
  Polars[6]
  integer [1, 2, 3, 4, 5, 6]
>

iex> s1 = Explorer.Series.from_list([1, 2, 3])
iex> s2 = Explorer.Series.from_list([4.0, 5.0, 6.4])
iex> Explorer.Series.concat([s1, s2])
#Explorer.Series<
  Polars[6]
  float [1.0, 2.0, 3.0, 4.0, 5.0, 6.4]
>

concat(s1, s2)

@spec concat(s1 :: t(), s2 :: t()) :: t()

Concatenate two series.

concat(s1, s2) is equivalent to concat([s1, s2]).

distinct(series)

Returns the unique values of the series.

examples
Examples

iex> s = [1, 1, 2, 2, 3, 3] |> Explorer.Series.from_list()
iex> Explorer.Series.distinct(s)
#Explorer.Series<
  Polars[3]
  integer [1, 2, 3]
>

first(series)

@spec first(series :: t()) :: any()

Returns the first element of the series.

examples
Examples

iex> s = 1..100 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.first(s)
1

format(list)

@spec format([t() | String.t()]) :: t()

Returns a string series with all values concatenated.

examples
Examples

iex> s1 = Explorer.Series.from_list(["a", "b", "c"])
iex> s2 = Explorer.Series.from_list(["d", "e", "f"])
iex> s3 = Explorer.Series.from_list(["g", "h", "i"])
iex> Explorer.Series.format([s1, s2, s3])
#Explorer.Series<
  Polars[3]
  string ["adg", "beh", "cfi"]
>

iex> s1 = Explorer.Series.from_list(["a", "b", "c", "d"])
iex> s2 = Explorer.Series.from_list([1, 2, 3, 4])
iex> s3 = Explorer.Series.from_list([1.5, :nan, :infinity, :neg_infinity])
iex> Explorer.Series.format([s1, "/", s2, "/", s3])
#Explorer.Series<
  Polars[4]
  string ["a/1/1.5", "b/2/NaN", "c/3/inf", "d/4/-inf"]
>

iex> s1 = Explorer.Series.from_list([<<1>>, <<239, 191, 19>>], dtype: :binary)
iex> s2 = Explorer.Series.from_list([<<3>>, <<4>>], dtype: :binary)
iex> Explorer.Series.format([s1, s2])
** (RuntimeError) External error: invalid utf-8 sequence

head(series, n_elements \\ 10)

@spec head(series :: t(), n_elements :: integer()) :: t()

Returns the first N elements of the series.

examples
Examples

iex> s = 1..100 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.head(s)
#Explorer.Series<
  Polars[10]
  integer [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
>

last(series)

@spec last(series :: t()) :: any()

Returns the last element of the series.

examples
Examples

iex> s = 1..100 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.last(s)
100

reverse(series)

Reverses the series order.

example
Example

iex> s = [1, 2, 3] |> Explorer.Series.from_list()
iex> Explorer.Series.reverse(s)
#Explorer.Series<
  Polars[3]
  integer [3, 2, 1]
>

sample(series, n_or_frac, opts \\ [])

@spec sample(series :: t(), n_or_frac :: number(), opts :: Keyword.t()) :: t()

Returns a random sample of the series.

If given an integer as the second argument, it will return N samples. If given a float, it will return that proportion of the series.

Can sample with or without replace.

options
Options

:replace - If set to true, each sample will be independent and therefore values may repeat. Required to be true for n greater then the number of rows in the series or frac > 1.0. (default: false)
:seed - An integer to be used as a random seed. If nil, a random value between 0 and 2^64 − 1 will be used. (default: nil)
:shuffle - In case the sample is equal to the size of the series, shuffle tells if the resultant series should be shuffled or if it should return the same series. (default: false).

examples
Examples

iex> s = 1..100 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.sample(s, 10, seed: 100)
#Explorer.Series<
  Polars[10]
  integer [55, 51, 33, 26, 5, 32, 62, 31, 9, 25]
>

iex> s = 1..100 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.sample(s, 0.05, seed: 100)
#Explorer.Series<
  Polars[5]
  integer [49, 77, 96, 19, 18]
>

iex> s = 1..5 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.sample(s, 7, seed: 100, replace: true)
#Explorer.Series<
  Polars[7]
  integer [4, 1, 3, 4, 3, 4, 2]
>

iex> s = 1..5 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.sample(s, 1.2, seed: 100, replace: true)
#Explorer.Series<
  Polars[6]
  integer [4, 1, 3, 4, 3, 4]
>

iex> s = 0..9 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.sample(s, 1.0, seed: 100, shuffle: false)
#Explorer.Series<
  Polars[10]
  integer [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
>

iex> s = 0..9 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.sample(s, 1.0, seed: 100, shuffle: true)
#Explorer.Series<
  Polars[10]
  integer [7, 9, 2, 0, 4, 1, 3, 8, 5, 6]
>

shift(series, offset)

@spec shift(series :: t(), offset :: integer()) :: t()

Shifts series by offset with nil values.

Positive offset shifts from first, negative offset shifts from last.

examples
Examples

iex> s = 1..5 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.shift(s, 2)
#Explorer.Series<
  Polars[5]
  integer [nil, nil, 1, 2, 3]
>

iex> s = 1..5 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.shift(s, -2)
#Explorer.Series<
  Polars[5]
  integer [3, 4, 5, nil, nil]
>

shuffle(series, opts \\ [])

@spec shuffle(series :: t(), opts :: Keyword.t()) :: t()

Change the elements order randomly.

options
Options

:seed - An integer to be used as a random seed. If nil, a random value between 0 and 2^64 − 1 will be used. (default: nil)

examples
Examples

iex> s = 1..10 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.shuffle(s, seed: 100)
#Explorer.Series<
  Polars[10]
  integer [8, 10, 3, 1, 5, 2, 4, 9, 6, 7]
>

slice(series, indices)

@spec slice(series :: t(), indices :: [integer()] | Range.t()) :: t()

Slices the elements at the given indices as a new series.

The indices may be either a list of indices or a range. A list of indices does not support negative numbers. Ranges may be negative on either end, which are then normalized. Note ranges in Elixir are inclusive.

examples
Examples

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.slice(s, [0, 2])
#Explorer.Series<
  Polars[2]
  string ["a", "c"]
>

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.slice(s, 1..2)
#Explorer.Series<
  Polars[2]
  string ["b", "c"]
>

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.slice(s, -2..-1)
#Explorer.Series<
  Polars[2]
  string ["b", "c"]
>

iex> s = Explorer.Series.from_list(["a", "b", "c"])
iex> Explorer.Series.slice(s, 3..2)
#Explorer.Series<
  Polars[0]
  string []
>

slice(series, offset, size)

@spec slice(series :: t(), offset :: integer(), size :: integer()) :: t()

Returns a slice of the series, with size elements starting at offset.

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, 3, 4, 5])
iex> Explorer.Series.slice(s, 1, 2)
#Explorer.Series<
  Polars[2]
  integer [2, 3]
>

Negative offsets count from the end of the series:

iex> s = Explorer.Series.from_list([1, 2, 3, 4, 5])
iex> Explorer.Series.slice(s, -3, 2)
#Explorer.Series<
  Polars[2]
  integer [3, 4]
>

If the offset runs past the end of the series, the series is empty:

iex> s = Explorer.Series.from_list([1, 2, 3, 4, 5])
iex> Explorer.Series.slice(s, 10, 3)
#Explorer.Series<
  Polars[0]
  integer []
>

If the size runs past the end of the series, the result may be shorter than the size:

iex> s = Explorer.Series.from_list([1, 2, 3, 4, 5])
iex> Explorer.Series.slice(s, -3, 4)
#Explorer.Series<
  Polars[3]
  integer [3, 4, 5]
>

sort(series, opts \\ [])

Sorts the series.

options
Options

:direction - :asc or :desc, meaning "ascending" or "descending", respectively. By default it sorts in acending order.
:nils - :first or :last. By default it is :last if direction is :asc, and :first otherwise.

examples
Examples

iex> s = Explorer.Series.from_list([9, 3, 7, 1])
iex> Explorer.Series.sort(s)
#Explorer.Series<
  Polars[4]
  integer [1, 3, 7, 9]
>

iex> s = Explorer.Series.from_list([9, 3, 7, 1])
iex> Explorer.Series.sort(s, direction: :desc)
#Explorer.Series<
  Polars[4]
  integer [9, 7, 3, 1]
>

tail(series, n_elements \\ 10)

@spec tail(series :: t(), n_elements :: integer()) :: t()

Returns the last N elements of the series.

examples
Examples

iex> s = 1..100 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.tail(s)
#Explorer.Series<
  Polars[10]
  integer [91, 92, 93, 94, 95, 96, 97, 98, 99, 100]
>

unordered_distinct(series)

Returns the unique values of the series, but does not maintain order.

Faster than distinct/1.

examples
Examples

iex> s = [1, 1, 2, 2, 3, 3] |> Explorer.Series.from_list()
iex> Explorer.Series.unordered_distinct(s)

Link to this section Functions: Window

cumulative_max(series, opts \\ [])

@spec cumulative_max(series :: t(), opts :: Keyword.t()) :: t()

Calculates the cumulative maximum of the series.

Optionally, can accumulate in reverse.

Does not fill nil values. See fill_missing/2.

supported-dtypes
Supported dtypes

:integer
:float
:date
:time
:datetime

examples
Examples

iex> s = [1, 2, 3, 4] |> Explorer.Series.from_list()
iex> Explorer.Series.cumulative_max(s)
#Explorer.Series<
  Polars[4]
  integer [1, 2, 3, 4]
>

iex> s = [1, 2, nil, 4] |> Explorer.Series.from_list()
iex> Explorer.Series.cumulative_max(s)
#Explorer.Series<
  Polars[4]
  integer [1, 2, nil, 4]
>

iex> s = [~T[03:00:02.000000], ~T[02:04:19.000000], nil, ~T[13:24:56.000000]] |> Explorer.Series.from_list()
iex> Explorer.Series.cumulative_max(s)
#Explorer.Series<
  Polars[4]
  time [03:00:02.000000, 03:00:02.000000, nil, 13:24:56.000000]
>

cumulative_min(series, opts \\ [])

@spec cumulative_min(series :: t(), opts :: Keyword.t()) :: t()

Calculates the cumulative minimum of the series.

Optionally, can accumulate in reverse.

Does not fill nil values. See fill_missing/2.

supported-dtypes
Supported dtypes

:integer
:float
:date
:time
:datetime

examples
Examples

iex> s = [1, 2, 3, 4] |> Explorer.Series.from_list()
iex> Explorer.Series.cumulative_min(s)
#Explorer.Series<
  Polars[4]
  integer [1, 1, 1, 1]
>

iex> s = [1, 2, nil, 4] |> Explorer.Series.from_list()
iex> Explorer.Series.cumulative_min(s)
#Explorer.Series<
  Polars[4]
  integer [1, 1, nil, 1]
>

iex> s = [~T[03:00:02.000000], ~T[02:04:19.000000], nil, ~T[13:24:56.000000]] |> Explorer.Series.from_list()
iex> Explorer.Series.cumulative_min(s)
#Explorer.Series<
  Polars[4]
  time [03:00:02.000000, 02:04:19.000000, nil, 02:04:19.000000]
>

cumulative_sum(series, opts \\ [])

@spec cumulative_sum(series :: t(), opts :: Keyword.t()) :: t()

Calculates the cumulative sum of the series.

Optionally, can accumulate in reverse.

Does not fill nil values. See fill_missing/2.

supported-dtypes
Supported dtypes

:integer
:float
:boolean

examples
Examples

iex> s = [1, 2, 3, 4] |> Explorer.Series.from_list()
iex> Explorer.Series.cumulative_sum(s)
#Explorer.Series<
  Polars[4]
  integer [1, 3, 6, 10]
>

iex> s = [1, 2, nil, 4] |> Explorer.Series.from_list()
iex> Explorer.Series.cumulative_sum(s)
#Explorer.Series<
  Polars[4]
  integer [1, 3, nil, 7]
>

fill_missing(series, value)

@spec fill_missing(
  t(),
  :forward
  | :backward
  | :max
  | :min
  | :mean
  | :nan
  | :infinity
  | :neg_infinity
  | Explorer.Backend.Series.valid_types()
) :: t()

Fill missing values with the given strategy. If a scalar value is provided instead of a strategy atom, nil will be replaced with that value. It must be of the same dtype as the series.

strategies
Strategies

:forward - replace nil with the previous value
:backward - replace nil with the next value
:max - replace nil with the series maximum
:min - replace nil with the series minimum
:mean - replace nil with the series mean
:nan (float only) - replace nil with NaN

examples
Examples

iex> s = Explorer.Series.from_list([1, 2, nil, 4])
iex> Explorer.Series.fill_missing(s, :forward)
#Explorer.Series<
  Polars[4]
  integer [1, 2, 2, 4]
>

iex> s = Explorer.Series.from_list([1, 2, nil, 4])
iex> Explorer.Series.fill_missing(s, :backward)
#Explorer.Series<
  Polars[4]
  integer [1, 2, 4, 4]
>

iex> s = Explorer.Series.from_list([1, 2, nil, 4])
iex> Explorer.Series.fill_missing(s, :max)
#Explorer.Series<
  Polars[4]
  integer [1, 2, 4, 4]
>

iex> s = Explorer.Series.from_list([1, 2, nil, 4])
iex> Explorer.Series.fill_missing(s, :min)
#Explorer.Series<
  Polars[4]
  integer [1, 2, 1, 4]
>

iex> s = Explorer.Series.from_list([1, 2, nil, 4])
iex> Explorer.Series.fill_missing(s, :mean)
#Explorer.Series<
  Polars[4]
  integer [1, 2, 2, 4]
>

Values that belong to the series itself can also be added as missing:

iex> s = Explorer.Series.from_list([1, 2, nil, 4])
iex> Explorer.Series.fill_missing(s, 3)
#Explorer.Series<
  Polars[4]
  integer [1, 2, 3, 4]
>

iex> s = Explorer.Series.from_list(["a", "b", nil, "d"])
iex> Explorer.Series.fill_missing(s, "c")
#Explorer.Series<
  Polars[4]
  string ["a", "b", "c", "d"]
>

Mismatched types will raise:

iex> s = Explorer.Series.from_list([1, 2, nil, 4])
iex> Explorer.Series.fill_missing(s, "foo")
** (ArgumentError) cannot invoke Explorer.Series.fill_missing/2 with mismatched dtypes: :integer and "foo"

Floats in particular accept missing values to be set to NaN, Inf, and -Inf:

iex> s = Explorer.Series.from_list([1.0, 2.0, nil, 4.0])
iex> Explorer.Series.fill_missing(s, :nan)
#Explorer.Series<
  Polars[4]
  float [1.0, 2.0, NaN, 4.0]
>

iex> s = Explorer.Series.from_list([1.0, 2.0, nil, 4.0])
iex> Explorer.Series.fill_missing(s, :infinity)
#Explorer.Series<
  Polars[4]
  float [1.0, 2.0, Inf, 4.0]
>

iex> s = Explorer.Series.from_list([1.0, 2.0, nil, 4.0])
iex> Explorer.Series.fill_missing(s, :neg_infinity)
#Explorer.Series<
  Polars[4]
  float [1.0, 2.0, -Inf, 4.0]
>

window_max(series, window_size, opts \\ [])

Calculate the rolling max, given a window size and optional list of weights.

options
Options

:weights - An optional list of weights with the same length as the window that will be multiplied elementwise with the values in the window. Defaults to nil.
:min_periods - The number of values in the window that should be non-nil before computing a result. If nil, it will be set equal to window size. Defaults to 1.
:center - Set the labels at the center of the window. Defaults to false.

examples
Examples

iex> s = 1..10 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.window_max(s, 4)
#Explorer.Series<
  Polars[10]
  integer [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
>

iex> s = 1..10 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.window_max(s, 2, weights: [1.0, 2.0])
#Explorer.Series<
  Polars[10]
  float [1.0, 4.0, 6.0, 8.0, 10.0, 12.0, 14.0, 16.0, 18.0, 20.0]
>

window_mean(series, window_size, opts \\ [])

Calculate the rolling mean, given a window size and optional list of weights.

options
Options

:weights - An optional list of weights with the same length as the window that will be multiplied elementwise with the values in the window. Defaults to nil.
:min_periods - The number of values in the window that should be non-nil before computing a result. If nil, it will be set equal to window size. Defaults to 1.
:center - Set the labels at the center of the window. Defaults to false.

examples
Examples

iex> s = 1..10 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.window_mean(s, 4)
#Explorer.Series<
  Polars[10]
  float [1.0, 1.5, 2.0, 2.5, 3.5, 4.5, 5.5, 6.5, 7.5, 8.5]
>

iex> s = 1..10 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.window_mean(s, 2, weights: [1.0, 2.0])
#Explorer.Series<
  Polars[10]
  float [1.0, 2.5, 4.0, 5.5, 7.0, 8.5, 10.0, 11.5, 13.0, 14.5]
>

window_min(series, window_size, opts \\ [])

Calculate the rolling min, given a window size and optional list of weights.

options
Options

:weights - An optional list of weights with the same length as the window that will be multiplied elementwise with the values in the window. Defaults to nil.
:min_periods - The number of values in the window that should be non-nil before computing a result. If nil, it will be set equal to window size. Defaults to 1.
:center - Set the labels at the center of the window. Defaults to false.

examples
Examples

iex> s = 1..10 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.window_min(s, 4)
#Explorer.Series<
  Polars[10]
  integer [1, 1, 1, 1, 2, 3, 4, 5, 6, 7]
>

iex> s = 1..10 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.window_min(s, 2, weights: [1.0, 2.0])
#Explorer.Series<
  Polars[10]
  float [1.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0]
>

window_sum(series, window_size, opts \\ [])

Calculate the rolling sum, given a window size and optional list of weights.

options
Options

:weights - An optional list of weights with the same length as the window that will be multiplied elementwise with the values in the window. Defaults to nil.
:min_periods - The number of values in the window that should be non-nil before computing a result. If nil, it will be set equal to window size. Defaults to 1.
:center - Set the labels at the center of the window. Defaults to false.

examples
Examples

iex> s = 1..10 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.window_sum(s, 4)
#Explorer.Series<
  Polars[10]
  integer [1, 3, 6, 10, 14, 18, 22, 26, 30, 34]
>

iex> s = 1..10 |> Enum.to_list() |> Explorer.Series.from_list()
iex> Explorer.Series.window_sum(s, 2, weights: [1.0, 2.0])
#Explorer.Series<
  Polars[10]
  float [1.0, 5.0, 8.0, 11.0, 14.0, 17.0, 20.0, 23.0, 26.0, 29.0]
>

Settings View Source Explorer.Series (Explorer v0.5.2)

creating-series Creating series

Link to this section Summary

Link to this section Types

dtype()

lazy_t()

t()

Link to this section Functions: Conversion

from_binary(binary, dtype, opts \\ [])

options Options

examples Examples

from_list(list, opts \\ [])

options Options

examples Examples

from_tensor(tensor, opts \\ [])

Warning

options Options

examples Examples

replace(series, tensor_or_list)

tensor-examples Tensor examples

list-examples List examples

to_binary(series)

examples Examples

to_enum(series)

Warning

examples Examples

to_iovec(series)

examples Examples

to_list(series)

Warning

examples Examples

to_tensor(series, tensor_opts \\ [])

Warning

options Options

examples Examples

Link to this section Functions: Aggregation

count(series)

examples Examples

frequencies(series)

examples Examples

max(series)

supported-dtypes Supported dtypes

examples Examples

mean(series)

supported-dtypes Supported dtypes

examples Examples

median(series)

supported-dtypes Supported dtypes

examples Examples

min(series)

supported-dtypes Supported dtypes

examples Examples

n_distinct(series)

examples Examples

nil_count(series)

examples Examples

quantile(series, quantile)

supported-dtypes Supported dtypes

examples Examples

standard_deviation(series)

supported-dtypes Supported dtypes

examples Examples

sum(series)

supported-dtypes Supported dtypes

examples Examples

variance(series)

supported-dtypes Supported dtypes

examples Examples

Link to this section Functions: Element-wise

add(left, right)

supported-dtypes Supported dtypes

examples Examples

all_equal(left, right)

examples Examples

left and right

examples Examples

cast(series, dtype)

examples Examples

categorise(series, categories)

examples Examples

View Source Explorer.Series (Explorer v0.5.2)

creating-series
Creating series

options
Options

examples
Examples

options
Options

examples
Examples

options
Options

examples
Examples

tensor-examples
Tensor examples

list-examples
List examples

examples
Examples

examples
Examples

examples
Examples

examples
Examples

options
Options

examples
Examples

examples
Examples

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

examples
Examples

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

examples
Examples

examples
Examples

examples
Examples

examples
Examples

examples
Examples

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

examples
Examples

examples
Examples

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

examples
Examples

examples
Examples

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

supported-dtype
Supported dtype

examples
Examples

supported-dtype
Supported dtype

examples
Examples

supported-dtypes
Supported dtypes

examples
Examples

examples
Examples

examples
Examples