PyCallback Class Reference

Description

Base class to wrap Python callable and pass it to C++. Used in swig interface file, intended to be overloaded from Python.

Definition at line 24 of file PyCallback.h.

Public Types
enum	CallbackType { SCALAR , RESIDUAL }

Public Member Functions
	PyCallback (CallbackType callback_type=SCALAR)
virtual	~PyCallback ()
virtual std::vector< double >	call_residuals (mumufit::Parameters pars) const
	Call Python callable and returns its result. Intended to be overloaded in Python. More...
virtual double	call_scalar (mumufit::Parameters pars) const
	Call Python callable and returns its result. Intended to be overloaded in Python. More...
CallbackType	callback_type () const

Private Attributes
CallbackType	m_callback_type

Member Enumeration Documentation

CallbackType

enum PyCallback::CallbackType

Enumerator
SCALAR
RESIDUAL

Definition at line 26 of file PyCallback.h.

{ SCALAR, RESIDUAL };

Constructor & Destructor Documentation

PyCallback()

PyCallback::PyCallback ( PyCallback::CallbackType  callback_type = SCALAR )

explicit

Definition at line 17 of file PyCallback.cpp.

    : m_callback_type(callback_type)
{
}

~PyCallback()

PyCallback::~PyCallback ( )

virtualdefault

Member Function Documentation

call_residuals()

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

virtual

Call Python callable and returns its result. Intended to be overloaded in Python.

Parameters

pars	Fit parameters object (intentionally passed by value).

Returns

vector of residuals

Definition at line 34 of file PyCallback.cpp.

{
    throw std::runtime_error("PyCallback::call_residuals() -> Error. Not implemented");
}

Referenced by mumufit::Minimizer::minimize().

call_scalar()

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

virtual

Call Python callable and returns its result. Intended to be overloaded in Python.

Parameters

pars	Fit parameters object (intentionally passed by value).

Returns

value of objective function.

Definition at line 29 of file PyCallback.cpp.

{
    throw std::runtime_error("PyCallback::call_scalar() -> Error. Not implemented");
}

Referenced by mumufit::Minimizer::minimize().

callback_type()

PyCallback::CallbackType PyCallback::callback_type

(

)

const

Definition at line 22 of file PyCallback.cpp.

{
    return m_callback_type;
}

References m_callback_type.

Referenced by mumufit::Minimizer::minimize().

Member Data Documentation

m_callback_type

CallbackType PyCallback::m_callback_type

private

Definition at line 44 of file PyCallback.h.

Referenced by callback_type().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Kernel/PyCallback.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Kernel/PyCallback.cpp