Series.Array (SeriesArrayNameSpace)

Namespace: Polars.FSharp

Namespace containing array operations for a Series.

Instance Methods

Agg

Run any Polars aggregation expression on each array element.

member Agg(expr: Expr) : Series

Parameters

Name	Type	Description
expr	Expr	-

---

All

Evaluate whether all boolean values are true for each array element.

member All(?ignoreNulls: bool) : Series

Parameters

Name	Type	Description
ignoreNulls	bool (optional)	-

---

Any

Evaluate whether any boolean value is true for each array element.

member Any(?ignoreNulls: bool) : Series

Parameters

Name	Type	Description
ignoreNulls	bool (optional)	-

---

ArgMax

Retrieve the index of the maximum value in each array element.

member ArgMax : unit -> Series

---

ArgMin

Retrieve the index of the minimum value in each array element.

member ArgMin : unit -> Series

---

Contains

Check if array contains an Item (Expr).

Check if array contains a literal string.

Check if array contains a literal int.

member Contains(item: Expr, ?nullsEqual: bool) : Series
member Contains(item: string, ?nullsEqual: bool) : Series
member Contains(item: int, ?nullsEqual: bool) : Series

Parameters

Name	Type	Description
item	Expr / string / int	-
nullsEqual	bool (optional)	-

---

CountMatches

Count how often the given expression matches in each array element.

member CountMatches(expr: Expr) : Series

Parameters

Name	Type	Description
expr	Expr	-

---

Eval

Run any Polars expression on each array element.

member Eval(expr: Expr, ?asList: bool) : Series

Parameters

Name	Type	Description
expr	Expr	-
asList	bool (optional)	-

---

Explode

Explode the array into multiple rows.

member Explode(?emptyAsNull: bool, ?keepNulls: bool) : Series

Parameters

Name	Type	Description
emptyAsNull	bool (optional)	-
keepNulls	bool (optional)	-

---

First

Get the first element of each array.

member First : unit -> Series

---

Get

Get the element at the given index from each array.

member Get(index: int, ?nullOnOob: bool) : Series

Parameters

Name	Type	Description
index	int	-
nullOnOob	bool (optional)	-

---

Join

Join all string items in the array into a single string using a delimiter.

member Join(separator: string, ?ignoreNulls: bool) : Series

Parameters

Name	Type	Description
separator	string	-
ignoreNulls	bool (optional)	-

---

Last

Get the last element of each array.

member Last : unit -> Series

---

Len

Compute the length (number of elements) of each array element.

member Len : unit -> Series

---

Max

Compute the maximum value in each array element.

member Max : unit -> Series

---

Mean

Compute the mean of values in each array element.

member Mean : unit -> Series

---

Median

Compute the median of values in each array element.

member Median : unit -> Series

---

Min

Compute the minimum value in each array element.

member Min : unit -> Series

---

NUnique

Count the number of unique values in each array element.

member NUnique : unit -> Series

---

Reverse

Reverse the elements of each array.

member Reverse : unit -> Series

---

Sort

Sort the elements of each array.

member Sort(?descending: bool, ?nullsLast: bool, ?maintainOrder: bool) : Series

Parameters

Name	Type	Description
descending	bool (optional)	-
nullsLast	bool (optional)	-
maintainOrder	bool (optional)	-

---

Std

Compute the standard deviation of each array element.

member Std(?ddof: int) : Series

Parameters

Name	Type	Description
ddof	int (optional)	-

---

Sum

Compute the sum of values in each array element.

member Sum : unit -> Series

---

ToList

Convert to variable length List.

member ToList : unit -> Series

---

ToStruct

Convert to Struct.

member ToStruct : unit -> Series

---

Unique

Get unique values from each array element.

member Unique(?maintainOrder: bool) : Series

Parameters

Name	Type	Description
maintainOrder	bool (optional)	-

---

Var

Compute the variance of each array element.

member Var(?ddof: int) : Series

Parameters

Name	Type	Description
ddof	int (optional)	-

---