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++ ``ParameterShifter``.

This class exposes the same Python surface as ``ParameterSetter`` but is
backed by the C++ shifter object. It is useful for workflows that treat
parameter changes as shifts rather than direct value replacement in the C++
parameter layer.

Definition at line 13 of file ParameterShifter.py.

Constructor & Destructor Documentation

◆ init()

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

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

Definition at line 22 of file ParameterShifter.py.

Member Function Documentation

◆ change_mode()

None pyhyperiso.core.Core.ParameterShifter.ParameterShifter.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 35 of file ParameterShifter.py.

◆ mutate()

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

Apply a new shifted value to a parameter.

Args:
    pid: Parameter to shift.
    value: Shifted value. Numeric inputs are converted to ``Scalar``.

Definition at line 26 of file ParameterShifter.py.

Member Data Documentation

◆ _cpp_obj

pyhyperiso.core.Core.ParameterShifter.ParameterShifter._cpp_obj

protected

Definition at line 24 of file ParameterShifter.py.

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

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

Public Member Functions

Protected Attributes