IParamOptimizer Class Reference

Interface for batched parameter modifications. More...

#include <IParamOptimizer.h>

Inheritance diagram for IParamOptimizer:

Public Member Functions
virtual	~IParamOptimizer ()=default
	Virtual destructor for interface.
virtual void	set_value (const BlockName &block, const LhaID &id, scalar_t v)=0
	Stage a change of central value for a parameter.
virtual void	set_param (const BlockName &block, const LhaID &id, std::shared_ptr< Parameter > p)=0
	Stage a full replacement of a parameter object.
virtual void	remove (const BlockName &block, const LhaID &id)=0
	Stage the removal of a parameter.
virtual void	commit (bool coalesce=true)=0
	Commit all staged operations.
virtual void	clear ()=0
	Clears all currently staged operations without applying them.

Detailed Description

Interface for batched parameter modifications.

IParamOptimizer defines an abstract API for:

• staging updates of individual parameters (by value or by full Parameter),
• removing parameters,
• committing staged operations (optionally coalescing multiple changes),
• clearing the queued operations without applying them.

Definition at line 42 of file IParamOptimizer.h.

Constructor & Destructor Documentation

~IParamOptimizer()

virtual IParamOptimizer::~IParamOptimizer ( )

virtualdefault

Virtual destructor for interface.

Member Function Documentation

clear()

virtual void IParamOptimizer::clear ( )

pure virtual

Clears all currently staged operations without applying them.

Implemented in ParamOptimizerAdapter.

commit()

virtual void IParamOptimizer::commit ( bool  coalesce = true )

pure virtual

Commit all staged operations.

Implementations may:

• coalesce multiple operations on the same (block, id) into a single effective update,
• freeze/unfreeze affected blocks during the update,
• notify observers only once per block.

Parameters

coalesce

If true, coalesce multiple operations on the same parameter.

Implemented in ParamOptimizerAdapter.

remove()

virtual void IParamOptimizer::remove ( const BlockName &  block, const LhaID &  id  )

pure virtual

Stage the removal of a parameter.

Parameters

block	Block name where the parameter resides.
id	LhaID of the parameter to remove.

Implemented in ParamOptimizerAdapter.

set_param()

virtual void IParamOptimizer::set_param ( const BlockName &  block, const LhaID &  id, std::shared_ptr< Parameter >  p  )

pure virtual

Stage a full replacement of a parameter object.

Parameters

block	Block name where the parameter resides.
id	LhaID of the parameter.
p	Shared pointer to the new Parameter.

Implemented in ParamOptimizerAdapter.

set_value()

virtual void IParamOptimizer::set_value ( const BlockName &  block, const LhaID &  id, scalar_t  v  )

pure virtual

Stage a change of central value for a parameter.

Parameters

block	Block name where the parameter resides.
id	LhaID of the parameter.
v	New value to set.

Implemented in ParamOptimizerAdapter.

---

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

• /home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/core/src/Core/ports/IParamOptimizer.h