Parameter Dictionary

ParameterDict

A dictionary-like class for storing parameters.

ParameterDict

class mrmustard.parameters.parameter_dict.ParameterDict(*args, **kwargs)

A dictionary-like class for storing parameters.

>>> c1 = Constant(1.2345, "const1")
>>> c2 = Constant(2.3456, "const2")
>>> v1 = Variable(3.4567, "var1")
>>> pd = ParameterDict(c1, c2, some_name=v1)
>>> assert pd.names == ['const1', 'const2', 'some_name']
>>> assert pd.constants == {"const1": c1, "const2": c2}
>>> assert pd.variables == {"some_name": v1}

Parameters:

• *args (Constant | Variable) – Constant or Variable parameters.

• **kwargs (Constant | Variable) – Constant or Variable parameters by name.

property constants: ParameterDict

Returns a ParameterDict of constant parameters in this ParameterDict.

property variables: ParameterDict

Returns a ParameterDict of variable parameters in this ParameterDict.

to_string(decimals)

Returns a string representation of the parameter values, separated by commas and rounded to the specified number of decimals.

Parameters:

decimals (int) – number of decimals to round to

Returns:

string representation of the parameter values

Return type:

str

code/parameters/parameter_dict

 

Download Python script

 

Download Notebook

 

View on GitHub