mumufit::ScalarFunctionAdapter Class Reference

Description

Converts user objective function to chi2 like function which ROOT expects.

More precisely, ROOT call to std::function<double(const double*)> will cause the call of user function std::function<double(std::vector<double>)>, where function input parameters will be current values fit parameters.

Definition at line 40 of file ScalarFunctionAdapter.h.

Inheritance diagram for mumufit::ScalarFunctionAdapter:

Collaboration diagram for mumufit::ScalarFunctionAdapter:

Public Member Functions
	ScalarFunctionAdapter (fcn_scalar_t func, Parameters parameters)
int	numberOfCalls () const
int	numberOfGradientCalls () const
const RootScalarFunction *	rootObjectiveFunction ()

Protected Attributes
int	m_number_of_calls
int	m_number_of_gradient_calls

Private Attributes
fcn_scalar_t	m_fcn
Parameters	m_parameters
std::unique_ptr< RootScalarFunction >	m_root_objective

Constructor & Destructor Documentation

ScalarFunctionAdapter()

ScalarFunctionAdapter::ScalarFunctionAdapter	(	fcn_scalar_t	func,
		Parameters	parameters
	)

Definition at line 22 of file ScalarFunctionAdapter.cpp.

    : m_fcn(std::move(func))
    , m_parameters(std::move(parameters))
{
}

Member Function Documentation

numberOfCalls()

int IFunctionAdapter::numberOfCalls ( ) const

inherited

Definition at line 27 of file IFunctionAdapter.cpp.

{
    return m_number_of_calls;
}

References mumufit::IFunctionAdapter::m_number_of_calls.

numberOfGradientCalls()

int IFunctionAdapter::numberOfGradientCalls ( ) const

inherited

Definition at line 32 of file IFunctionAdapter.cpp.

{
    return m_number_of_gradient_calls;
}

References mumufit::IFunctionAdapter::m_number_of_gradient_calls.

rootObjectiveFunction()

const RootScalarFunction * ScalarFunctionAdapter::rootObjectiveFunction

(

)

Definition at line 28 of file ScalarFunctionAdapter.cpp.

{
    root_scalar_t rootfun = [&](const double* pars) {
        std::vector<double> vec;
        vec.resize(m_parameters.size(), 0.0);
        std::copy(pars, pars + m_parameters.size(), vec.begin());
        m_parameters.setValues(vec);
        ++m_number_of_calls;
        return m_fcn(m_parameters);
    };
 
    m_root_objective =
        std::make_unique<RootScalarFunction>(rootfun, static_cast<int>(m_parameters.size()));
    return m_root_objective.get();
}

References m_fcn, mumufit::IFunctionAdapter::m_number_of_calls, m_parameters, m_root_objective, mumufit::Parameters::setValues(), and mumufit::Parameters::size().

Here is the call graph for this function:

Member Data Documentation

m_fcn

fcn_scalar_t mumufit::ScalarFunctionAdapter::m_fcn

private

Definition at line 47 of file ScalarFunctionAdapter.h.

Referenced by rootObjectiveFunction().

m_number_of_calls

int mumufit::IFunctionAdapter::m_number_of_calls

protectedinherited

Definition at line 37 of file IFunctionAdapter.h.

Referenced by mumufit::ResidualFunctionAdapter::chi2(), mumufit::IFunctionAdapter::numberOfCalls(), and rootObjectiveFunction().

m_number_of_gradient_calls

int mumufit::IFunctionAdapter::m_number_of_gradient_calls

protectedinherited

Definition at line 38 of file IFunctionAdapter.h.

Referenced by mumufit::ResidualFunctionAdapter::calculate_gradients(), and mumufit::IFunctionAdapter::numberOfGradientCalls().

m_parameters

Parameters mumufit::ScalarFunctionAdapter::m_parameters

private

Definition at line 48 of file ScalarFunctionAdapter.h.

Referenced by rootObjectiveFunction().

m_root_objective

std::unique_ptr<RootScalarFunction> mumufit::ScalarFunctionAdapter::m_root_objective

private

Definition at line 49 of file ScalarFunctionAdapter.h.

Referenced by rootObjectiveFunction().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Adapter/ScalarFunctionAdapter.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Adapter/ScalarFunctionAdapter.cpp