pymloc.model.variables.container

Classes

InputOutputStateVariables(n_states, …[, time])	VariablesContainer with states, inputs and outputs.
InputStateVariables(n_states, m_inputs, **kwargs)	VariablesContainer with states and inputs.
ParameterContainer(p_parameters, domain)	“VariablesContainer for parameters
StateVariablesContainer(n_states, **kwargs)	VariablesContainer with states.
UniqueVariablesContainer()	Subclass, with only one variable object in the container
VariablesContainer()	Base class for all variable containers.

class pymloc.model.variables.container.InputOutputStateVariables(n_states, m_inputs, p_outputs, time=<pymloc.model.variables.time_function.Time object>)

Bases: pymloc.model.variables.container.VariablesContainer

VariablesContainer with states, inputs and outputs.

Parameters

• n_states (int) –

• m_inputs (int) –

• p_outputs (int) –

• time (Time) –

property inputs

link_variable(variable, overwrite=False)

Parameters

• variable (pymloc.model.variables.container.InputOutputStateVariables) –

• overwrite (bool) –

Return type

None

property m_inputs

property n_states

property outputs

property p_outputs

property states

property time

class pymloc.model.variables.container.InputStateVariables(n_states, m_inputs, **kwargs)

Bases: pymloc.model.variables.container.InputOutputStateVariables

VariablesContainer with states and inputs.

class pymloc.model.variables.container.ParameterContainer(p_parameters, domain)

Bases: pymloc.model.variables.container.UniqueVariablesContainer

“VariablesContainer for parameters

Parameters

• p_parameters (int) –

• domain ('pymloc.model.domains.RNDomain') –

property parameters

class pymloc.model.variables.container.StateVariablesContainer(n_states, **kwargs)

Bases: pymloc.model.variables.container.InputStateVariables

VariablesContainer with states.

property shape

class pymloc.model.variables.container.UniqueVariablesContainer

Bases: pymloc.model.variables.container.VariablesContainer, abc.ABC

Subclass, with only one variable object in the container

property current_values

get_random_values()

class pymloc.model.variables.container.VariablesContainer

Bases: abc.ABC

Base class for all variable containers.

property associated_problem

property current_values

get_random_values()

Return type

np.ndarrray

get_sensitivities(**kwargs)

Return type

numpy.ndarray

property linked_variable

merge(*args)

Parameters

args (pymloc.model.variables.variables.Variables) –

Return type

None

property sensitivity_problem

update_values(**kwargs)

Return type

Optional[pymloc.solvers.Solution]

property variables