Concrete mutator that directly sets the value of parameters. More...

#include <ParameterSetter.h>

Inheritance diagram for ParameterSetter:

Collaboration diagram for ParameterSetter:

Public Member Functions
void	mutate (const ParamId &pid, scalar_t value) override
	Sets the value of a parameter.

void	change_mode (const ParamId &pid, ParameterMode mode) override
	Changes the mode of a parameter (e.g., from FIXED to SHIFTABLE).

Public Member Functions inherited from IDataMutator< ParamId, scalar_t, ParameterMode >
virtual	~IDataMutator ()=default
	Virtual destructor for interface.

Detailed Description

Concrete mutator that directly sets the value of parameters.

ParameterSetter is a thin adapter on top of the Parameters singleton:

mutate() calls Parameters::setBlockValue(),
change_mode() calls Parameters::changeParameterMode().

It additionally enforces some high-level consistency rules, such as preventing changes to EW_SCALE when Wilson coefficients are provided by the user (HAS_WILSON_INPUT).

Examples: param_mutation_example.cpp.

Definition at line 35 of file ParameterSetter.h.

Member Function Documentation

◆ change_mode()

void ParameterSetter::change_mode	(	const ParamId &	pid,
		ParameterMode	mode
	)

overridevirtual

Changes the mode of a parameter (e.g., from FIXED to SHIFTABLE).

Delegates to Parameters::changeParameterMode on the appropriate Parameters instance, as determined by pid.type.

Parameters

pid	The parameter ID.
mode	The new parameter mode.

Implements IDataMutator< ParamId, scalar_t, ParameterMode >.

Examples: param_mutation_example.cpp.

Definition at line 16 of file ParameterSetter.cpp.

◆ mutate()

void ParameterSetter::mutate	(	const ParamId &	pid,
		scalar_t	value
	)

overridevirtual

Sets the value of a parameter.

If the ParamId has no type set, an error is logged since the Parameters instance to target cannot be determined.

Special case:

If the block is "EW_SCALE" and the flag ExternalFlag::HAS_WILSON_INPUT is true in MemoryManager's cache, the change is refused and a warning is logged.

Parameters

pid	The parameter ID.
value	The new central value to set.

Implements IDataMutator< ParamId, scalar_t, ParameterMode >.

Examples: param_mutation_example.cpp.

Definition at line 3 of file ParameterSetter.cpp.

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

/home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/core/src/Core/adapters/ParameterSetter.h
/home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/core/src/Core/adapters/ParameterSetter.cpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ change_mode()

◆ mutate()