BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
PyCallback Class Reference

Base class to wrap Python callable and pass it to C++. More...

Public Types

enum  CallbackType { SCALAR , RESIDUAL }
 

Public Member Functions

 PyCallback (CallbackType callback_type=SCALAR)
 
virtual std::vector< double > call_residuals (mumufit::Parameters pars)
 Call Python callable and returns its result. More...
 
virtual double call_scalar (mumufit::Parameters pars)
 Call Python callable and returns its result. More...
 
CallbackType callback_type () const
 

Detailed Description

Base class to wrap Python callable and pass it to C++.

Used in swig interface file, intended to be overloaded from Python.

Member Function Documentation

◆ call_residuals()

std::vector< double > PyCallback::call_residuals ( mumufit::Parameters  pars)
virtual

Call Python callable and returns its result.

Intended to be overloaded in Python.

Parameters
parsFit parameters object (intentionally passed by value).
Returns
vector of residuals

◆ call_scalar()

double PyCallback::call_scalar ( mumufit::Parameters  pars)
virtual

Call Python callable and returns its result.

Intended to be overloaded in Python.

Parameters
parsFit parameters object (intentionally passed by value).
Returns
value of objective function.