File: IFunctionAdapter.h

package info (click to toggle)
bornagain 23.0-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 103,956 kB
  • sloc: cpp: 423,131; python: 40,997; javascript: 11,167; awk: 630; sh: 356; ruby: 173; xml: 130; makefile: 45; ansic: 24
file content (41 lines) | stat: -rw-r--r-- 1,340 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Fit/Residual/IFunctionAdapter.h
//! @brief     Defines interface IFunctionAdapter.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************

#ifdef SWIG
#error no need to expose this header to Swig
#endif // SWIG
#ifndef BORNAGAIN_FIT_RESIDUAL_IFUNCTIONADAPTER_H
#define BORNAGAIN_FIT_RESIDUAL_IFUNCTIONADAPTER_H

namespace mumufit {

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

class IFunctionAdapter {
public:
    IFunctionAdapter();
    virtual ~IFunctionAdapter();

    int numberOfCalls() const { return m_number_of_calls; }
    int numberOfGradientCalls() const { return m_number_of_gradient_calls; }

protected:
    int m_number_of_calls;
    int m_number_of_gradient_calls;
};

} // namespace mumufit

#endif // BORNAGAIN_FIT_RESIDUAL_IFUNCTIONADAPTER_H