View Source Explorer.Backend.Series behaviour (Explorer v0.4.0)

The behaviour for series backends.

Link to this section Summary

Types

df()

dtype()

lazy_s()

s()

t()

valid_types()

window_option()

Callbacks

add(arg1, arg2)

all_equal(s, s)

argsort(s, descending?, nils_last)

at(s, idx)

at_every(s, integer)

binary_and(s, s)

binary_or(s, s)

bintype(s)

cast(s, dtype)

coalesce(s, s)

concat(s, s)

count(s)

cumulative_max(s, reverse?)

cumulative_min(s, reverse?)

cumulative_sum(s, reverse?)

distinct(s)

divide(arg1, arg2)

dtype(s)

equal(arg1, arg2)

fill_missing(s, strategy)

first(s)

frequencies(s)

from_binary(binary, dtype)

from_list(list, dtype)

greater(arg1, arg2)

greater_equal(arg1, arg2)

head(s, n)

inspect(s, opts)

is_nil(s)

is_not_nil(s)

last(s)

less(arg1, arg2)

less_equal(arg1, arg2)

mask(s, mask)

max(s)

mean(s)

median(s)

min(s)

multiply(arg1, arg2)

n_distinct(s)

not s

not_equal(arg1, arg2)

peaks(s, arg2)

pow(arg1, arg2)

quantile(s, float)

quotient(arg1, arg2)

remainder(arg1, arg2)

reverse(s)

sample(s, n_or_frac, replacement, seed)

select(predicate, s, s)

shift(s, offset, default)

size(s)

slice(s, indices)

slice(s, offset, length)

sort(s, descending?, nils_last)

standard_deviation(s)

subtract(arg1, arg2)

sum(s)

tail(s, n)

to_iovec(s)

to_list(s)

transform(s, function)

unordered_distinct(s)

variance(s)

window_max(s, window_size, list)

window_mean(s, window_size, list)

window_min(s, window_size, list)

window_sum(s, window_size, list)

Functions

inspect(series, backend, n_rows, inspect_opts, opts \\ [])

Default inspect implementation for backends.

new(data, dtype)

Create a new Series.

Link to this section Types

df()

@type df() :: Explorer.DataFrame.t()

dtype()

@type dtype() :: Explorer.Series.dtype()

lazy_s()

@type lazy_s() :: Explorer.Series.lazy_t()

s()

@type s() :: Explorer.Series.t()

t()

@type t() :: struct()

valid_types()

@type valid_types() ::
  number() | boolean() | String.t() | Date.t() | NaiveDateTime.t()

window_option()

@type window_option() ::
  {:weights, [float()] | nil}
  | {:min_periods, integer() | nil}
  | {:center, boolean()}

Link to this section Callbacks

add(arg1, arg2)

@callback add(s() | number(), s() | number()) :: s()

all_equal(s, s)

@callback all_equal(s(), s()) :: boolean() | lazy_s()

argsort(s, descending?, nils_last)

@callback argsort(s(), descending? :: boolean(), nils_last :: boolean()) :: s()

at(s, idx)

@callback at(s(), idx :: integer()) :: s()

at_every(s, integer)

@callback at_every(s(), integer()) :: s()

binary_and(s, s)

@callback binary_and(s(), s()) :: s()

binary_or(s, s)

@callback binary_or(s(), s()) :: s()

bintype(s)

@callback bintype(s()) :: :uft8 | :binary | {:s | :u | :f, non_neg_integer()}

cast(s, dtype)

@callback cast(s(), dtype()) :: s()

coalesce(s, s)

@callback coalesce(s(), s()) :: s()

concat(s, s)

@callback concat(s(), s()) :: s()

count(s)

@callback count(s()) :: number() | lazy_s()

cumulative_max(s, reverse?)

@callback cumulative_max(s(), reverse? :: boolean()) :: s()

cumulative_min(s, reverse?)

@callback cumulative_min(s(), reverse? :: boolean()) :: s()

cumulative_sum(s, reverse?)

@callback cumulative_sum(s(), reverse? :: boolean()) :: s()

distinct(s)

@callback distinct(s()) :: s()

divide(arg1, arg2)

@callback divide(s() | number(), s() | number()) :: s()

dtype(s)

@callback dtype(s()) :: dtype()

equal(arg1, arg2)

@callback equal(s() | valid_types(), s() | valid_types()) :: s()

fill_missing(s, strategy)

@callback fill_missing(
  s(),
  strategy :: :backward | :forward | :min | :max | :mean | valid_types()
) :: s()

first(s)

@callback first(s()) :: valid_types() | lazy_s()

frequencies(s)

@callback frequencies(s()) :: df()

from_binary(binary, dtype)

@callback from_binary(binary(), dtype()) :: s()

from_list(list, dtype)

@callback from_list(list(), dtype()) :: s()

greater(arg1, arg2)

@callback greater(s() | valid_types(), s() | valid_types()) :: s()

greater_equal(arg1, arg2)

@callback greater_equal(s() | valid_types(), s() | valid_types()) :: s()

head(s, n)

@callback head(s(), n :: integer()) :: s()

inspect(s, opts)

@callback inspect(s(), opts :: Inspect.Opts.t()) :: Inspect.Algebra.t()

is_nil(s)

@callback is_nil(s()) :: s()

is_not_nil(s)

@callback is_not_nil(s()) :: s()

last(s)

@callback last(s()) :: valid_types() | lazy_s()

less(arg1, arg2)

@callback less(s() | valid_types(), s() | valid_types()) :: s()

less_equal(arg1, arg2)

@callback less_equal(s() | valid_types(), s() | valid_types()) :: s()

mask(s, mask)

@callback mask(s(), mask :: s()) :: s()

max(s)

@callback max(s()) :: number() | Date.t() | NaiveDateTime.t() | lazy_s() | nil

mean(s)

@callback mean(s()) :: float() | lazy_s() | nil

median(s)

@callback median(s()) :: float() | lazy_s() | nil

min(s)

@callback min(s()) :: number() | Date.t() | NaiveDateTime.t() | lazy_s() | nil

multiply(arg1, arg2)

@callback multiply(s() | number(), s() | number()) :: s()

n_distinct(s)

@callback n_distinct(s()) :: integer() | lazy_s()

not s

@callback not s() :: s()

not_equal(arg1, arg2)

@callback not_equal(s() | valid_types(), s() | valid_types()) :: s()

peaks(s, arg2)

@callback peaks(s(), :max | :min) :: s()

pow(arg1, arg2)

@callback pow(s() | number(), s() | number()) :: s()

quantile(s, float)

@callback quantile(s(), float()) ::
  number() | Date.t() | NaiveDateTime.t() | lazy_s() | nil

quotient(arg1, arg2)

@callback quotient(
  s() | neg_integer() | pos_integer(),
  s() | neg_integer() | pos_integer()
) :: s()

remainder(arg1, arg2)

@callback remainder(
  s() | neg_integer() | pos_integer(),
  s() | neg_integer() | pos_integer()
) :: s()

reverse(s)

@callback reverse(s()) :: s()

sample(s, n_or_frac, replacement, seed)

@callback sample(s(), n_or_frac :: number(), replacement :: boolean(), seed :: integer()) ::
  s()

select(predicate, s, s)

@callback select(predicate :: s(), s(), s()) :: s()

shift(s, offset, default)

@callback shift(s(), offset :: integer(), default :: nil) :: s()

size(s)

@callback size(s()) :: non_neg_integer() | lazy_s()

slice(s, indices)

@callback slice(s(), indices :: list()) :: s()

slice(s, offset, length)

@callback slice(s(), offset :: integer(), length :: integer()) :: s()

sort(s, descending?, nils_last)

@callback sort(s(), descending? :: boolean(), nils_last :: boolean()) :: s()

standard_deviation(s)

@callback standard_deviation(s()) :: float() | lazy_s() | nil

subtract(arg1, arg2)

@callback subtract(s() | number(), s() | number()) :: s()

sum(s)

@callback sum(s()) :: number() | lazy_s() | nil

tail(s, n)

@callback tail(s(), n :: integer()) :: s()

to_iovec(s)

@callback to_iovec(s()) :: [binary()]

to_list(s)

@callback to_list(s()) :: list()

transform(s, function)

@callback transform(s(), (... -> any())) :: s() | list()

unordered_distinct(s)

@callback unordered_distinct(s()) :: s()

variance(s)

@callback variance(s()) :: float() | lazy_s() | nil

window_max(s, window_size, list)

@callback window_max(s(), window_size :: integer(), [window_option()]) :: s()

window_mean(s, window_size, list)

@callback window_mean(s(), window_size :: integer(), [window_option()]) :: s()

window_min(s, window_size, list)

@callback window_min(s(), window_size :: integer(), [window_option()]) :: s()

window_sum(s, window_size, list)

@callback window_sum(s(), window_size :: integer(), [window_option()]) :: s()

Link to this section Functions

inspect(series, backend, n_rows, inspect_opts, opts \\ [])

Default inspect implementation for backends.

new(data, dtype)

Create a new Series.

Settings View Source Explorer.Backend.Series behaviour (Explorer v0.4.0)

Link to this section Summary

Types

Callbacks

Functions

Link to this section Types

df()

dtype()

lazy_s()

s()

t()

valid_types()

window_option()

Link to this section Callbacks

add(arg1, arg2)

all_equal(s, s)

argsort(s, descending?, nils_last)

at(s, idx)

at_every(s, integer)

binary_and(s, s)

binary_or(s, s)

bintype(s)

cast(s, dtype)

coalesce(s, s)

concat(s, s)

count(s)

cumulative_max(s, reverse?)

cumulative_min(s, reverse?)

cumulative_sum(s, reverse?)

distinct(s)

divide(arg1, arg2)

dtype(s)

equal(arg1, arg2)

fill_missing(s, strategy)

first(s)

frequencies(s)

from_binary(binary, dtype)

from_list(list, dtype)

greater(arg1, arg2)

greater_equal(arg1, arg2)

head(s, n)

inspect(s, opts)

is_nil(s)

is_not_nil(s)

last(s)

less(arg1, arg2)

less_equal(arg1, arg2)

mask(s, mask)

max(s)

mean(s)

median(s)

min(s)

multiply(arg1, arg2)

n_distinct(s)

not s

not_equal(arg1, arg2)

peaks(s, arg2)

pow(arg1, arg2)

quantile(s, float)

quotient(arg1, arg2)

remainder(arg1, arg2)

reverse(s)

sample(s, n_or_frac, replacement, seed)

select(predicate, s, s)

shift(s, offset, default)

size(s)

slice(s, indices)

slice(s, offset, length)

sort(s, descending?, nils_last)

standard_deviation(s)

subtract(arg1, arg2)

sum(s)

tail(s, n)

to_iovec(s)

to_list(s)

transform(s, function)

unordered_distinct(s)

variance(s)

window_max(s, window_size, list)

window_mean(s, window_size, list)

View Source Explorer.Backend.Series behaviour (Explorer v0.4.0)