Fit::ScalarFunctionAdapter Class Reference

Inheritance diagram for Fit::ScalarFunctionAdapter:

Collaboration diagram for Fit::ScalarFunctionAdapter:

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

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

Detailed 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 36 of file ScalarFunctionAdapter.h.

Constructor & Destructor Documentation

ScalarFunctionAdapter()

ScalarFunctionAdapter::ScalarFunctionAdapter	(	fcn_scalar_t	func,
		const Parameters &	parameters
	)

Definition at line 20 of file ScalarFunctionAdapter.cpp.

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

Member Function Documentation

rootObjectiveFunction()

const RootScalarFunction * ScalarFunctionAdapter::rootObjectiveFunction

(

)

Definition at line 25 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, Fit::IFunctionAdapter::m_number_of_calls, m_parameters, m_root_objective, Fit::Parameters::setValues(), and Fit::Parameters::size().

Here is the call graph for this function:

numberOfCalls()

int IFunctionAdapter::numberOfCalls ( ) const

inherited

Definition at line 23 of file IFunctionAdapter.cpp.

{
    return m_number_of_calls;
}

References Fit::IFunctionAdapter::m_number_of_calls.

numberOfGradientCalls()

int IFunctionAdapter::numberOfGradientCalls ( ) const

inherited

Definition at line 28 of file IFunctionAdapter.cpp.

{
    return m_number_of_gradient_calls;
}

References Fit::IFunctionAdapter::m_number_of_gradient_calls.

Member Data Documentation

m_fcn

fcn_scalar_t Fit::ScalarFunctionAdapter::m_fcn

private

Definition at line 44 of file ScalarFunctionAdapter.h.

Referenced by rootObjectiveFunction().

m_parameters

Parameters Fit::ScalarFunctionAdapter::m_parameters

private

Definition at line 45 of file ScalarFunctionAdapter.h.

Referenced by rootObjectiveFunction().

m_root_objective

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

private

Definition at line 46 of file ScalarFunctionAdapter.h.

Referenced by rootObjectiveFunction().

m_number_of_calls

int Fit::IFunctionAdapter::m_number_of_calls

protectedinherited

Definition at line 34 of file IFunctionAdapter.h.

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

m_number_of_gradient_calls

int Fit::IFunctionAdapter::m_number_of_gradient_calls

protectedinherited

Definition at line 35 of file IFunctionAdapter.h.

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

---

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

• /home/www/ba/Fit/RootAdapter/ScalarFunctionAdapter.h
• /home/www/ba/Fit/RootAdapter/ScalarFunctionAdapter.cpp