Series.List (SeriesListNameSpace)

Namespace: Polars.FSharp

Instance Methods

Agg

Aggregate elements in list.

member Agg(expr: Expr) : Series

Parameters

Name	Type	Description
expr	Expr	-

---

All

Check if all elements in list are true.

member All(?ignoreNulls: bool) : Series

Parameters

Name	Type	Description
ignoreNulls	bool (optional)	-

---

Any

Check if any element in list is true.

member Any(?ignoreNulls: bool) : Series

Parameters

Name	Type	Description
ignoreNulls	bool (optional)	-

---

ArgMax

Get the index of the maximum element in list.

member ArgMax : unit -> Series

---

ArgMin

Get the index of the minimum element in list.

member ArgMin : unit -> Series

---

Concat

Concat with another Series. Logic: [this_val, other_val]

member Concat(other: Series) : Series

Parameters

Name	Type	Description
other	Series	-

---

Contains

Check if list contains item.

member Contains(item: Expr) : Series
member Contains(item: int) : Series
member Contains(item: string) : Series

Parameters

Name	Type	Description
item	Expr / int / string	-

---

Diff

Diff elements in list.

member Diff(?n: int64, ?nullBehavior: NullBehavior) : Series

Parameters

Name	Type	Description
n	int64 (optional)	-
nullBehavior	NullBehavior (optional)	-

---

DropNulls

Drop nulls from list.

member DropNulls : unit -> Series

---

Eval

Evaluate an expression on the list.

member Eval(expr: Expr) : Series

Parameters

Name	Type	Description
expr	Expr	-

---

Explode

Explode list.

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

Parameters

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

---

First

Get the first element of the list.

member First : unit -> Series

---

Gather

Gather elements by indices.

member Gather(indices: Expr, ?nullOnOob: bool) : Series

Parameters

Name	Type	Description
indices	Expr	-
nullOnOob	bool (optional)	-

---

GatherEvery

Gather every n-th element.

member GatherEvery(n: Expr, ?offset: Expr) : Series

Parameters

Name	Type	Description
n	Expr	-
offset	Expr (optional)	-

---

Get

Get the element at the given index.

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

Parameters

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

---

Head

Get the first n elements of the list.

member Head(?n: Expr) : Series

Parameters

Name	Type	Description
n	Expr (optional)	-

---

Join

Join list elements with separator.

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

Parameters

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

---

Last

Get the last element of the list.

member Last : unit -> Series

---

Len

Get the length of the list.

member Len : unit -> Series

---

Max

Get the maximum of the list.

member Max : unit -> Series

---

Mean

Get the mean of the list.

member Mean : unit -> Series

---

Median

Get the median of the list.

member Median : unit -> Series

---

Min

Get the minimum of the list.

member Min : unit -> Series

---

NUnique

Get the number of unique elements in list.

member NUnique : unit -> Series

---

Reverse

Reverse the list.

member Reverse : unit -> Series

---

SampleFrac

Sample fraction of elements from list.

member SampleFrac(
    fraction: Expr,
    ?withReplacement: bool,
    ?shuffle: bool,
    ?seed: uint64
) : Series

Parameters

Name	Type	Description
fraction	Expr	-
withReplacement	bool (optional)	-
shuffle	bool (optional)	-
seed	uint64 (optional)	-

---

SampleN

Sample n elements from list.

member SampleN(
    ?n: Expr,
    ?withReplacement: bool,
    ?shuffle: bool,
    ?seed: uint64
) : Series

Parameters

Name	Type	Description
n	Expr (optional)	-
withReplacement	bool (optional)	-
shuffle	bool (optional)	-
seed	uint64 (optional)	-

---

SetDifference

Set difference of lists.

member SetDifference(other: Expr) : Series

Parameters

Name	Type	Description
other	Expr	-

---

SetIntersection

Set intersection of lists.

member SetIntersection(other: Expr) : Series

Parameters

Name	Type	Description
other	Expr	-

---

SetSymmetricDifference

Set symmetric difference of lists.

member SetSymmetricDifference(other: Expr) : Series

Parameters

Name	Type	Description
other	Expr	-

---

SetUnion

Set union of lists.

member SetUnion(other: Expr) : Series

Parameters

Name	Type	Description
other	Expr	-

---

Shift

Shift elements in list.

member Shift(?n: Expr) : Series

Parameters

Name	Type	Description
n	Expr (optional)	-

---

Slice

Slice the list.

member Slice(offset: Expr, ?length: Expr) : Series

Parameters

Name	Type	Description
offset	Expr	-
length	Expr (optional)	-

---

Sort

Sort the list.

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

Parameters

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

---

Std

Get the standard deviation of the list.

member Std(?ddof: byte) : Series

Parameters

Name	Type	Description
ddof	byte (optional)	-

---

Sum

Get the sum of the list.

member Sum : unit -> Series

---

Tail

Get the last n elements of the list.

member Tail(?n: Expr) : Series

Parameters

Name	Type	Description
n	Expr (optional)	-

---

ToArray

Convert list to array.

member ToArray(width: int64) : Series

Parameters

Name	Type	Description
width	int64	-

---

ToStruct

Convert list to struct.

member ToStruct(fields: seq<string>) : Series
member ToStruct(nameGenerator: (int -> string), fieldCount: int) : Series
member ToStruct(upperBound: int) : Series

Parameters

Name	Type	Description
fields	seq<string>	-
nameGenerator	(int -> string)	-
fieldCount	int	-
upperBound	int	-

---

Unique

Get the unique elements of the list.

member Unique(?maintainOrder: bool) : Series

Parameters

Name	Type	Description
maintainOrder	bool (optional)	-

---

Var

Get the variance of the list.

member Var(?ddof: byte) : Series

Parameters

Name	Type	Description
ddof	byte (optional)	-

---