Public Member Functions
None	__init__ (self)

None	mutate (self, ParamId pid, Union[float, complex, Scalar] value)

None	change_mode (self, ParamId pid, ParameterMode mode)

Protected Attributes
	_cpp_obj

Detailed Description

Python wrapper around the C++ ``ParameterSetter``.

``ParameterSetter`` mutates stored parameter values directly. For workflows
that require recomputing observables after mutation, remember to call the
relevant reload/update method on the observable or statistic interface.

Examples:
    >>> setter = ParameterSetter()
    >>> setter.mutate(ParamId(ParameterType.SM, "MASS", 24), 80.379)

Definition at line 13 of file ParameterSetter.py.

Constructor & Destructor Documentation

◆ init()

None pyhyperiso.core.Core.ParameterSetter.ParameterSetter.__init__ ( self )

Create a setter bound to the current C++ parameter storage.

Definition at line 25 of file ParameterSetter.py.

Member Function Documentation

◆ change_mode()

None pyhyperiso.core.Core.ParameterSetter.ParameterSetter.change_mode	(		self,
		ParamId	pid,
		ParameterMode	mode
	)

Change a parameter update mode.

Args:
    pid: Parameter to update.
    mode: New mode, such as ``ParameterMode.FIXED`` or
        ``ParameterMode.SHIFTABLE``.

Definition at line 38 of file ParameterSetter.py.

◆ mutate()

None pyhyperiso.core.Core.ParameterSetter.ParameterSetter.mutate	(		self,
		ParamId	pid,
		Union[float, complex, Scalar]	value
	)

Set a parameter value.

Args:
    pid: Parameter to mutate.
    value: New value. Numeric inputs are converted to ``Scalar``.

Definition at line 29 of file ParameterSetter.py.

Member Data Documentation

◆ _cpp_obj

pyhyperiso.core.Core.ParameterSetter.ParameterSetter._cpp_obj

protected

Definition at line 27 of file ParameterSetter.py.

The documentation for this class was generated from the following file:

/home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/pyhyperiso/core/Core/ParameterSetter.py

Public Member Functions

Protected Attributes