ExPolars.Series (ExPolars v0.2.1-dev) View Source

Documentation for Series.

Link to this section Summary

Functions

Append a Series to this one.

Filter elements by a boolean mask

Take n elements from this Series.

Get the number of chunks that this Series contains.

Set masked values.

Get a slice of this Series

Reduce this Series to the sum value.

Link to this section Types

Specs

s() :: ExPolars.Series

Specs

t() :: ExPolars.DataFrame

Link to this section Functions

Specs

(s() | {:ok, s()}) * (s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

(s() | {:ok, s()}) + (s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

(s() | {:ok, s()}) - (s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

(s() | {:ok, s()}) / (s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

(s() | {:ok, s()}) < (s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

(s() | {:ok, s()}) <= (s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

(s() | {:ok, s()}) <> (s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

(s() | {:ok, s()}) == (s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

(s() | {:ok, s()}) > (s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

(s() | {:ok, s()}) >= (s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

add(s() | {:ok, s()}, s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_add/2.

Specs

append(s() | {:ok, s()}, s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Append a Series to this one.

Parameters

other

Series to append

Specs

arg_true(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_arg_true/1.

Specs

arg_unique(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_arg_unique/1.

Link to this function

argsort(s, reverse \\ false)

View Source

Specs

argsort(s() | {:ok, s()}, boolean()) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_argsort/2.

Specs

as_duration(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_as_duration/1.

Specs

cast(s() | {:ok, s()}, :integer | :float | :str) ::
  {:ok, s()} | {:error, term()}

Specs

chunk_lengths(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_chunk_lengths/1.

Specs

clone(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_clone/1.

Link to this function

datetime_str_fmt(s, fmt)

View Source

Specs

datetime_str_fmt(s() | {:ok, s()}, String.t()) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_datetime_str_fmt/2.

Specs

day(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_day/1.

Specs

divide(s() | {:ok, s()}, s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_div/2.

Specs

drop_nulls(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_drop_nulls/1.

Specs

dtype(s() | {:ok, s()}) :: {:ok, integer()} | {:error, term()}

See ExPolars.Native.s_dtype/1.

Specs

dtype_str(s() | {:ok, s()}) :: String.t()

Specs

eq(s() | {:ok, s()}, s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_eq/2.

Specs

explode(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_explode/1.

Specs

fill_none(s() | {:ok, s()}, String.t()) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_fill_none/2.

Specs

filter(s() | {:ok, s()}, s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Filter elements by a boolean mask

Parameters

filter

Boolean mask

Specs

get(s() | {:ok, s()}, float() | integer()) :: {:ok, s()} | {:error, term()}

Specs

get_list(s() | {:ok, s()}, integer()) :: s() | {:ok, s()} | nil

See ExPolars.Native.s_get_list/2.

Specs

gt(s() | {:ok, s()}, s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_gt/2.

Specs

gt_eq(s() | {:ok, s()}, s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_gt_eq/2.

Specs

head(s() | {:ok, s()}, integer()) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_head/2.

Specs

hour(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_hour/1.

Specs

is_duplicated(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_is_duplicated/1.

Specs

is_not_null(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_is_not_null/1.

Specs

is_null(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_is_null/1.

Specs

is_unique(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_is_unique/1.

Specs

len(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_len/1.

Specs

limit(s() | {:ok, s()}, integer()) :: {:ok, s()} | {:error, term()}

Take n elements from this Series.

Parameters

num_elements

Amount of elements to take.

Specs

lt(s() | {:ok, s()}, s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_lt/2.

Specs

lt_eq(s() | {:ok, s()}, s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_lt_eq/2.

Specs

max(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

mean(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

min(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

minute(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_minute/1.

Specs

month(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_month/1.

Specs

mul(s() | {:ok, s()}, s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_mul/2.

Specs

n_chunks(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Get the number of chunks that this Series contains.

Specs

name(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_name/1.

Specs

nanosecond(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_nanosecond/1.

Specs

neq(s() | {:ok, s()}, s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_neq/2.

Specs

new(String.t(), [String.t() | integer() | float() | boolean()]) ::
  {:ok, s()} | {:error, term()}
Link to this function

new_duration_ns(name, data)

View Source

Specs

new_duration_ns(String.t(), [integer()]) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_new_duration_ns/2.

Specs

not_(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_not/1.

Specs

null_count(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_null_count/1.

Specs

ordinal_day(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_ordinal_day/1.

Specs

rechunk(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_rechunk/1.

Specs

rename(s() | {:ok, s()}, String.t()) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_rename/2.

Link to this function

rolling_max(s, window_size, weight \\ nil, ignore_null \\ false)

View Source

Specs

rolling_max(s() | {:ok, s()}, integer(), nil | [float()], boolean()) ::
  {:ok, s()} | {:error, term()}

See ExPolars.Native.s_rolling_max/4.

Link to this function

rolling_mean(s, window_size, weight \\ nil, ignore_null \\ false)

View Source

Specs

rolling_mean(s() | {:ok, s()}, integer(), nil | [float()], boolean()) ::
  {:ok, s()} | {:error, term()}

See ExPolars.Native.s_rolling_mean/4.

Link to this function

rolling_min(s, window_size, weight \\ nil, ignore_null \\ false)

View Source

Specs

rolling_min(s() | {:ok, s()}, integer(), nil | [float()], boolean()) ::
  {:ok, s()} | {:error, term()}

See ExPolars.Native.s_rolling_min/4.

Link to this function

rolling_sum(s, window_size, weight \\ nil, ignore_null \\ false)

View Source

Specs

rolling_sum(s() | {:ok, s()}, integer(), nil | [float()], boolean()) ::
  {:ok, s()} | {:error, term()}

See ExPolars.Native.s_rolling_sum/4.

Link to this function

sample(s, n_or_frac, with_replacement \\ false)

View Source

Specs

sample(s() | {:ok, s()}, integer() | float(), boolean()) ::
  {:ok, s()} | {:error, term()}

Specs

second(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_second/1.

Link to this function

series_equal(s, other, null_equal \\ false)

View Source

Specs

series_equal(s() | {:ok, s()}, s() | {:ok, s()}, boolean()) ::
  {:ok, s()} | {:error, term()}

See ExPolars.Native.s_series_equal/3.

Specs

set(s() | {:ok, s()}, s() | {:ok, s()}, float() | integer()) ::
  {:ok, s()} | {:error, term()}

Set masked values.

Parameters

filter

Boolean mask

value

Value to replace the the masked values with.

Specs

shift(s() | {:ok, s()}, integer()) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_shift/2.

Link to this function

slice(s, offset, length)

View Source

Specs

slice(s() | {:ok, s()}, integer(), integer()) :: {:ok, s()} | {:error, term()}

Get a slice of this Series

Parameters

offset

Offset index.

length

Length of the slice.
Link to this function

sort(s, reverse \\ false)

View Source

Specs

sort(s() | {:ok, s()}, boolean()) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_sort/2.

Specs

std(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

str_contains(s() | {:ok, s()}, String.t()) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_str_contains/2.

Specs

str_lengths(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_str_lengths/1.

Link to this function

str_parse_date32(s, fmt)

View Source

Specs

str_parse_date32(s() | {:ok, s()}, String.t()) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_str_parse_date32/2.

Link to this function

str_parse_date64(s, fmt)

View Source

Specs

str_parse_date64(s() | {:ok, s()}, String.t()) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_str_parse_date64/2.

Link to this function

str_replace(s, pat, val)

View Source

Specs

str_replace(s() | {:ok, s()}, String.t(), String.t()) ::
  {:ok, s()} | {:error, term()}

See ExPolars.Native.s_str_replace/3.

Link to this function

str_replace_all(s, pat, val)

View Source

Specs

str_replace_all(s() | {:ok, s()}, String.t(), String.t()) ::
  {:ok, s()} | {:error, term()}

See ExPolars.Native.s_str_replace_all/3.

Specs

str_to_lowercase(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_str_to_lowercase/1.

Specs

str_to_uppercase(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_str_to_uppercase/1.

Specs

sub(s() | {:ok, s()}, s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_sub/2.

Specs

sum(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Reduce this Series to the sum value.

Specs

tail(s() | {:ok, s()}, integer()) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_tail/2.

Specs

take(s() | {:ok, s()}, [integer()]) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_take/2.

Specs

take_every(s() | {:ok, s()}, integer()) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_take_every/2.

Link to this function

take_with_series(s, indeces)

View Source

Specs

take_with_series(s() | {:ok, s()}, s() | {:ok, s()}) ::
  {:ok, s()} | {:error, term()}

See ExPolars.Native.s_take_with_series/2.

Specs

to_dummies(s() | {:ok, s()}) :: {:ok, t()} | {:error, term()}

See ExPolars.Native.s_to_dummies/1.

Specs

to_list(s() | {:ok, s()}) :: {:ok, list()} | {:error, term()}

Specs

unique(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_unique/1.

Specs

value_counts(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_value_counts/1.

Specs

var(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

Specs

year(s() | {:ok, s()}) :: {:ok, s()} | {:error, term()}

See ExPolars.Native.s_year/1.

Link to this function

zip_with(s, mask, other)

View Source

Specs

zip_with(s() | {:ok, s()}, s() | {:ok, s()}, s() | {:ok, s()}) ::
  {:ok, s()} | {:error, term()}

See ExPolars.Native.s_zip_with/3.