Builds slice-profile requests with fixed parameters of interest. More...

#include <IProfilingStrategy.h>

Inheritance diagram for SliceProfilingStrategy:

Collaboration diagram for SliceProfilingStrategy:

[legend]

Public Member Functions
	SliceProfilingStrategy (std::size_t x_id, std::size_t y_id, const FitResult &fr)
	Constructs a slice profiling strategy.

ProfileRequest	build_request (double px, double py, const std::map< std::size_t, double > &current_argmin) const override
	Builds a profiler request for one 2D scan point.

std::map< std::size_t, double >	init_warm_start () const override
	Creates the initial warm-start map for the strategy.

Public Member Functions inherited from IProfilingStrategy
	IProfilingStrategy (std::size_t x_id, std::size_t y_id, const FitResult &fr)
	Constructs a profiling strategy.

virtual	~IProfilingStrategy ()=default
	Virtual destructor.

std::size_t	get_x_id ()
	Returns the global index of the first scanned coordinate.

std::size_t	get_y_id ()
	Returns the global index of the second scanned coordinate.

Additional Inherited Members
Protected Attributes inherited from IProfilingStrategy
std::size_t	x_id

std::size_t	y_id
	Global indices of the two profiled scan coordinates.

FitResult	fr
	Reference global fit used for central values and warm starts.

Detailed Description

Builds slice-profile requests with fixed parameters of interest.

In this strategy, all parameters of interest are fixed to their global best-fit values, except the two scanned coordinates which are fixed to the requested scan values. Only nuisance parameters are profiled.

Definition at line 115 of file IProfilingStrategy.h.

Constructor & Destructor Documentation

◆ SliceProfilingStrategy()

SliceProfilingStrategy::SliceProfilingStrategy	(	std::size_t	x_id,
		std::size_t	y_id,
		const FitResult &	fr
	)

inline

Constructs a slice profiling strategy.

Parameters

x_id	Global index of the first scan coordinate.
y_id	Global index of the second scan coordinate.
fr	Reference global fit result.

Definition at line 124 of file IProfilingStrategy.h.

Member Function Documentation

◆ build_request()

ProfileRequest SliceProfilingStrategy::build_request	(	double	px,
		double	py,
		const std::map< std::size_t, double > &	current_argmin
	)		const

overridevirtual

Builds a profiler request for one 2D scan point.

Parameters

px	Value assigned to the first scanned coordinate.
py	Value assigned to the second scanned coordinate.
current_argmin	Warm-start map from free parameter indices to their last profiled values.

Returns: Fully specified profiling request with fixed parameters, free parameters and starting values.

Exceptions

std::runtime_error if required warm-start values are missing.

Implements IProfilingStrategy.

Definition at line 7 of file IProfilingStrategy.cpp.

◆ init_warm_start()

std::map< std::size_t, double > SliceProfilingStrategy::init_warm_start ( ) const

overridevirtual

Creates the initial warm-start map for the strategy.

Returns: Map from free parameter indices to their initial values.

Implements IProfilingStrategy.

Definition at line 43 of file IProfilingStrategy.cpp.

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

/home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/core/src/Statistic/domain/Likelihood/IProfilingStrategy.h
/home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/core/src/Statistic/domain/Likelihood/IProfilingStrategy.cpp