pyhyperiso.core.Core.Parameter.PyDependentParameter Class Reference

Inheritance diagram for pyhyperiso.core.Core.Parameter.PyDependentParameter:

Collaboration diagram for pyhyperiso.core.Core.Parameter.PyDependentParameter:

Public Member Functions
None	__init__ (self, _CppDependentParameter cpp_obj)
bool	depends_on (self, ParamId pid)
None	init (self)
None	update (self)
None	freeze (self)
None	unfreeze (self)
Public Member Functions inherited from pyhyperiso.core.Core.Parameter.Parameter
Scalar	value (self)
Tuple[Scalar, Scalar]	std (self)
Scalar	combined_std (self)
ParamId	pid (self)
None	set_expected (self, Union[float, complex, Scalar] val)
None	set_std (self, Union[float, complex, Scalar] stat, Union[float, complex, Scalar] syst)
None	set_shift (self, Union[float, complex, Scalar] shift)
None	set_mode (self, ParameterMode mode)
str	__repr__ (self)

Protected Attributes
	_cpp_obj
Protected Attributes inherited from pyhyperiso.core.Core.Parameter.Parameter
	_cpp_obj

Additional Inherited Members
Static Public Member Functions inherited from pyhyperiso.core.Core.Parameter.Parameter
"Parameter"	from_cpp (cpp_obj)

Detailed Description

Python wrapper around a C++ ``DependentParameter``.

Dependent parameters can update their value from other parameters, and can
be frozen to avoid repeated recomputation in workflows that scan many
points.

Definition at line 150 of file Parameter.py.

Constructor & Destructor Documentation

__init__()

None pyhyperiso.core.Core.Parameter.PyDependentParameter.__init__	(		self,
		_CppDependentParameter	cpp_obj
	)

Wrap an existing C++ dependent parameter.

Reimplemented from pyhyperiso.core.Core.Parameter.Parameter.

Definition at line 158 of file Parameter.py.

Member Function Documentation

depends_on()

bool pyhyperiso.core.Core.Parameter.PyDependentParameter.depends_on	(		self,
		ParamId	pid
	)

Return whether this parameter depends on ``pid``.

Definition at line 162 of file Parameter.py.

freeze()

None pyhyperiso.core.Core.Parameter.PyDependentParameter.freeze

(

self

)

Freeze updates for the dependent parameter.

Definition at line 174 of file Parameter.py.

init()

None pyhyperiso.core.Core.Parameter.PyDependentParameter.init

(

self

)

Initialize the underlying dependent parameter.

Definition at line 166 of file Parameter.py.

unfreeze()

None pyhyperiso.core.Core.Parameter.PyDependentParameter.unfreeze

(

self

)

Re-enable updates for the dependent parameter.

Definition at line 178 of file Parameter.py.

update()

None pyhyperiso.core.Core.Parameter.PyDependentParameter.update

(

self

)

Recompute the parameter value from its dependencies.

Definition at line 170 of file Parameter.py.

Member Data Documentation

_cpp_obj

pyhyperiso.core.Core.Parameter.PyDependentParameter._cpp_obj

protected

Definition at line 160 of file Parameter.py.

---

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

• /home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/pyhyperiso/core/Core/Parameter.py