csnlp.nlps.HasParameters#

class csnlp.nlps.HasParameters(sym_type='SX')[source]#

Bases: Generic[SymType]

Class for the creation and storage of symbolic parameters in an NLP problem.

Parameters:

sym_type{“SX”, “MX”}, optional: The CasADi symbolic variable type to use in the NLP, by default "SX".

Methods

parameter(name[, shape])

Adds a parameter to the NLP scheme.

Attributes

`np`	Number of parameters in the NLP scheme.
`p`	Gets the parameters of the NLP scheme.
`parameters`	Gets the parameters of the NLP scheme.

parameter(name, shape=(1, 1))[source]#

Adds a parameter to the NLP scheme.

Parameters:

namestr: Name of the new parameter. Must not be already in use.
shapetuple of 2 ints, optional: Shape of the new parameter. By default a scalar, i.e., (1, 1).

Returns:

Raises:

ValueError: Raises if there is already another parameter with the same name name.

Return type:

TypeVar(SymType, SX, MX)

property parameters: dict[str, SymType]#: Gets the parameters of the NLP scheme.

Examples using `csnlp.nlps.HasParameters`#

Comparison of CasADi's and csnlp's sensitivity computations