Hyperiso 1.0.3
Modular flavour-physics calculations, Wilson coefficients and statistical inference
Loading...
Searching...
No Matches
ProfiledLikelihood2D Class Reference

Evaluates a profiled NLL as a function of two scan coordinates. More...

#include <ProfiledLikelihood2D.h>

Public Member Functions

 ProfiledLikelihood2D ()=default
 Default constructor.
 
 ProfiledLikelihood2D (std::shared_ptr< ILikelihood > base, std::shared_ptr< Profiler > profiler, std::shared_ptr< IProfilingStrategy > profiling_strategy)
 Constructs a two-dimensional profiled likelihood wrapper.
 
double profiled_nll (double px, double py)
 Evaluates the profiled NLL at one 2D scan point.
 
std::array< fit_app::ParameterDefinition, 2 > get_param_defs () const
 Returns the parameter definitions for the two scan coordinates.
 

Detailed Description

Evaluates a profiled NLL as a function of two scan coordinates.

The class combines:

  • a base likelihood,
  • a profiler backend,
  • a profiling strategy defining which parameters are fixed or free.

The last successful profiled point is retained as a warm start for the next evaluation, which improves stability and performance in grid scans.

Definition at line 33 of file ProfiledLikelihood2D.h.

Constructor & Destructor Documentation

◆ ProfiledLikelihood2D() [1/2]

ProfiledLikelihood2D::ProfiledLikelihood2D ( )
default

Default constructor.

Creates an empty wrapper. The object must be assigned or reconstructed with valid dependencies before profiled_nll is called.

◆ ProfiledLikelihood2D() [2/2]

ProfiledLikelihood2D::ProfiledLikelihood2D ( std::shared_ptr< ILikelihood base,
std::shared_ptr< Profiler profiler,
std::shared_ptr< IProfilingStrategy profiling_strategy 
)

Constructs a two-dimensional profiled likelihood wrapper.

Parameters
baseBase likelihood to evaluate.
profilerProfiler used to minimize over free dimensions.
profiling_strategyStrategy used to build profile requests for each 2D scan point.

Definition at line 3 of file ProfiledLikelihood2D.cpp.

Member Function Documentation

◆ get_param_defs()

std::array< fit_app::ParameterDefinition, 2 > ProfiledLikelihood2D::get_param_defs ( ) const

Returns the parameter definitions for the two scan coordinates.

Returns
Array containing the definitions of the first and second scanned parameters, in that order.

Definition at line 33 of file ProfiledLikelihood2D.cpp.

◆ profiled_nll()

double ProfiledLikelihood2D::profiled_nll ( double  px,
double  py 
)

Evaluates the profiled NLL at one 2D scan point.

Parameters
pxValue of the first scanned coordinate.
pyValue of the second scanned coordinate.
Returns
Profiled NLL value. A large penalty is returned if profiling fails without producing a finite NLL.

Definition at line 15 of file ProfiledLikelihood2D.cpp.


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