File: ResidualFunctionAdapter.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 (62 lines) | stat: -rw-r--r-- 2,239 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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Fit/Residual/ResidualFunctionAdapter.h
//! @brief     Defines class ResidualFunctionAdapter.
//!
//! @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_RESIDUALFUNCTIONADAPTER_H
#define BORNAGAIN_FIT_RESIDUAL_RESIDUALFUNCTIONADAPTER_H

#include "Fit/Minimizer/Types.h"
#include "Fit/Param/Parameters.h"
#include "Fit/Residual/IFunctionAdapter.h"
#include <functional>
#include <memory>
#include <vector>

class RootResidualFunction;

namespace mumufit {

//! Provides RootResidualFunction which will be minimizer by ROOT.
//! Converts ROOT calls to the call of fcn_residual_t.

class ResidualFunctionAdapter : public IFunctionAdapter {
public:
    ResidualFunctionAdapter(const fcn_residual_t& func, const Parameters& parameters);

    const RootResidualFunction* rootResidualFunction();

private:
    void calculate_gradients(const std::vector<double>& pars);
    std::vector<double> get_residuals(const std::vector<double>& pars);

    //! evaluate method for gradients and residuals called directly from the minimizer
    double element_residual(const std::vector<double>& pars, unsigned int index,
                            std::vector<double>& gradients);
    //! Evaluate chi2
    double chi2(const std::vector<double>& pars);

    //! Length of vector with residuals, should stay the same during minimization.
    size_t m_datasize;
    fcn_residual_t m_fcn; //!< user function to minimize
    Parameters m_parameters;
    std::vector<double> m_residuals;
    double2d_t m_gradients; // [m_npars][m_ndatasize]
    std::unique_ptr<RootResidualFunction> m_root_objective;
};

} // namespace mumufit

#endif // BORNAGAIN_FIT_RESIDUAL_RESIDUALFUNCTIONADAPTER_H