Skip to content

flixOpt.utils

This module contains several utility functions used throughout the flixOpt framework.

Functions

as_vector 

as_vector(value: Union[int, float, ndarray, List], length: int) -> np.ndarray

Macht aus Skalar einen Vektor. Vektor bleibt Vektor. -> Idee dahinter: Aufruf aus abgespeichertem Vektor schneller, als für jede i-te Gleichung zu Checken ob Vektor oder Skalar)

Parameters:

Name Type Description Default
aValue
required
aLen
required

is_number 

is_number(number_alias: Union[int, float, str])

Returns True is string is a number.

label_is_valid 

label_is_valid(label: str) -> bool

Function to make sure '__' is reserved for internal splitting of labels

convert_numeric_lists_to_arrays 

convert_numeric_lists_to_arrays(d: Union[Dict[str, Any], List[Any], tuple]) -> Union[Dict[str, Any], List[Any], tuple]

Recursively converts all lists of numeric values in a nested dictionary to numpy arrays. Handles nested lists, tuples, and dictionaries. Does not alter the original dictionary.