multi_vfunct Class Template Reference

Multi-dimensional function base with arrays [abstract base]. More...

#include <multi_funct.h>

Inheritance diagram for multi_vfunct:

multi_vfunct_cmfptr multi_vfunct_cmfptr_noerr multi_vfunct_fptr multi_vfunct_fptr_noerr multi_vfunct_gsl multi_vfunct_mfptr multi_vfunct_mfptr_noerr

Detailed Description

template<class param_t, size_t nvar>
class multi_vfunct< param_t, nvar >

Multi-dimensional function base with arrays [abstract base].

This class generalizes one function of several variables, i.e. $ y(x_0,x_1,...,x_{nv-1}) $ where nv is the number of variables in the function y.

This class is one of a large number of function object classes in O2scl designed to provide a mechanism for the user to supply functions to solvers, minimizers, integrators, etc. See Function Objects for a general description.

Definition at line 501 of file multi_funct.h.


Public Member Functions

virtual int operator() (size_t nv, const double x[nvar], double &y, param_t &pa)=0
 Compute a function y of nv variables stored in x with parameter pa.
virtual double operator() (size_t nv, const double x[nvar], param_t &pa)
 Return the value of a function of nv variables stored in x with parameter pa.

Member Function Documentation

virtual double operator() ( size_t  nv,
const double  x[nvar],
param_t &  pa 
) [inline, virtual]

Return the value of a function of nv variables stored in x with parameter pa.

Note that this is reimplemented in all children because if one member function operator() is reimplemented, all must be.

Reimplemented in multi_vfunct_fptr, multi_vfunct_gsl, multi_vfunct_fptr_noerr, multi_vfunct_mfptr, multi_vfunct_mfptr_noerr, multi_vfunct_cmfptr, and multi_vfunct_cmfptr_noerr.

Definition at line 521 of file multi_funct.h.


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

Documentation generated with Doxygen and provided under the GNU Free Documentation License. See License Information for details.

Project hosting provided by SourceForge.net Logo, O2scl Sourceforge Project Page