Fit::ObjectiveFunctionAdapter Class Reference

Collaboration diagram for Fit::ObjectiveFunctionAdapter:

Public Member Functions
	ObjectiveFunctionAdapter ()
	~ObjectiveFunctionAdapter ()
const RootScalarFunction *	rootObjectiveFunction (fcn_scalar_t fcn, const Parameters &parameters)
const RootResidualFunction *	rootResidualFunction (fcn_residual_t fcn, const Parameters &parameters)
int	numberOfCalls () const
int	numberOfGradientCalls () const

Private Attributes
std::unique_ptr< IFunctionAdapter >	m_adapter

Detailed Description

Converts user objective function to function ROOT expects.

Handles time of life of function objects.

Definition at line 33 of file ObjectiveFunctionAdapter.h.

Constructor & Destructor Documentation

ObjectiveFunctionAdapter()

ObjectiveFunctionAdapter::ObjectiveFunctionAdapter ( )

default

~ObjectiveFunctionAdapter()

ObjectiveFunctionAdapter::~ObjectiveFunctionAdapter ( )

default

Member Function Documentation

rootObjectiveFunction()

const RootScalarFunction * ObjectiveFunctionAdapter::rootObjectiveFunction	(	fcn_scalar_t	fcn,
		const Parameters &	parameters
	)

Definition at line 28 of file ObjectiveFunctionAdapter.cpp.

{
    std::unique_ptr<ScalarFunctionAdapter> temp_adapter(new ScalarFunctionAdapter(fcn, parameters));
    auto result = temp_adapter->rootObjectiveFunction();
    m_adapter.reset(temp_adapter.release());
    return result;
}

References m_adapter.

rootResidualFunction()

const RootResidualFunction * ObjectiveFunctionAdapter::rootResidualFunction	(	fcn_residual_t	fcn,
		const Parameters &	parameters
	)

Definition at line 37 of file ObjectiveFunctionAdapter.cpp.

{
    std::unique_ptr<ResidualFunctionAdapter> temp_adapter(
        new ResidualFunctionAdapter(fcn, parameters));
    auto result = temp_adapter->rootResidualFunction();
    m_adapter.reset(temp_adapter.release());
    return result;
}

References m_adapter.

numberOfCalls()

int ObjectiveFunctionAdapter::numberOfCalls

(

)

const

Definition at line 46 of file ObjectiveFunctionAdapter.cpp.

{
    return m_adapter ? m_adapter->numberOfCalls() : 0;
}

References m_adapter.

numberOfGradientCalls()

int ObjectiveFunctionAdapter::numberOfGradientCalls

(

)

const

Definition at line 51 of file ObjectiveFunctionAdapter.cpp.

{
    return m_adapter ? m_adapter->numberOfGradientCalls() : 0;
}

References m_adapter.

Member Data Documentation

m_adapter

std::unique_ptr<IFunctionAdapter> Fit::ObjectiveFunctionAdapter::m_adapter

private

Definition at line 48 of file ObjectiveFunctionAdapter.h.

Referenced by numberOfCalls(), numberOfGradientCalls(), rootObjectiveFunction(), and rootResidualFunction().

---

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

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