BornAgain  1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
Public Member Functions | Protected Attributes | List of all members
mumufit::IFunctionAdapter Class Reference

Description

Base class for objective function adapters, which converts user functions to minimize into the function which minimization machinery expects.

Definition at line 28 of file IFunctionAdapter.h.

Inheritance diagram for mumufit::IFunctionAdapter:
[legend]

Public Member Functions

 IFunctionAdapter ()
 
virtual ~IFunctionAdapter ()
 
int numberOfCalls () const
 
int numberOfGradientCalls () const
 

Protected Attributes

int m_number_of_calls
 
int m_number_of_gradient_calls
 

Constructor & Destructor Documentation

◆ IFunctionAdapter()

IFunctionAdapter::IFunctionAdapter ( )

Definition at line 19 of file IFunctionAdapter.cpp.

20  : m_number_of_calls(0)
21  , m_number_of_gradient_calls(0)
22 {
23 }

◆ ~IFunctionAdapter()

IFunctionAdapter::~IFunctionAdapter ( )
virtualdefault

Member Function Documentation

◆ numberOfCalls()

int IFunctionAdapter::numberOfCalls ( ) const

Definition at line 27 of file IFunctionAdapter.cpp.

28 {
29  return m_number_of_calls;
30 }

References m_number_of_calls.

◆ numberOfGradientCalls()

int IFunctionAdapter::numberOfGradientCalls ( ) const

Definition at line 32 of file IFunctionAdapter.cpp.

33 {
34  return m_number_of_gradient_calls;
35 }

References m_number_of_gradient_calls.

Member Data Documentation

◆ m_number_of_calls

int mumufit::IFunctionAdapter::m_number_of_calls
protected

Definition at line 37 of file IFunctionAdapter.h.

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

◆ m_number_of_gradient_calls

int mumufit::IFunctionAdapter::m_number_of_gradient_calls
protected

Definition at line 38 of file IFunctionAdapter.h.

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

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