ytilities.lists

Copyright (c) 2023 Anthony Mugendi

This software is released under the MIT License. https://opensource.org/licenses/MIT

Module Contents

Functions

listify(→ list)	Convert a value into a list.
__flatten(→ iter)	Flatten a nested list/set/tuple/numpy array into a single iterable .
flatten(→ Union[set, list, tuple, numpy.ndarray])	Flattens a list/set/tuple/numpy array to a 1D list/set/tuple/numpy array .
chunk_arr(→ list)	Chunk an array into n - sized chunks .

ytilities.lists.listify(val: Any) → list

Convert a value into a list.

Parameters:

v (Any) – your value

Returns:

list either containing your input value or value if it was already a list

Return type:

list

ytilities.lists.__flatten(val: set | list | tuple | numpy.ndarray) → iter

Flatten a nested list/set/tuple/numpy array into a single iterable .

Parameters:

val (set, list, tuple, np.ndarray) –

Raises:

TypeError – if val is one of list/set/tuple/numpy array

Returns:

iterabable

Return type:

iter

Yields:

Iterator[iter] – iterabable

ytilities.lists.flatten(val: set | list | tuple | numpy.ndarray) → set | list | tuple | numpy.ndarray

Flattens a list/set/tuple/numpy array to a 1D list/set/tuple/numpy array .

Parameters:

val (set, list, tuple, np.ndarray) – your value

Raises:

TypeError – if val is one of list/set/tuple/numpy array

Returns:

[description]

Return type:

Union[set, list, tuple, np.ndarray]

ytilities.lists.chunk_arr(arr: list, n: int = 4) → list

Chunk an array into n - sized chunks .

Parameters:

• arr (list) – list/array to chunk

• n (int, optional) – length of each chunk. Defaults to 4.

Returns:

chunked array

Return type:

list