CompiledParam.h

Classes

CompiledParam -- Parameters for a compiled string function object. (full description)

template <class T> class CompiledParam : public Function<T>

Interface

Public Members

CompiledParam(const CompiledParam<T> &other)

template <class W> CompiledParam(const CompiledParam<W> &other) : Function<T>(other), ndim_p(other.ndim()), msg_p(other.errorMessage()), text_p(other.getText()), functionPtr_p(new ndim(*other.getFunctionPtr()))

CompiledParam<T> &operator=(const CompiledParam<T> &other)

virtual ~CompiledParam()

virtual const String &name() const

Bool setFunction(const String &newFunction)

const String &errorMessage() const

const FuncExpression &function() const

virtual uInt ndim() const

const String &getText() const

const FuncExpression *const getFunctionPtr() const

Description

Review Status

Programs:

Tests:

tFuncExpression

Prerequisite

FuncExpression class

Synopsis

Given a string describing an expression (see FuncExpression class for details of the expression), the CompiledFunctionclass wraps this expression as a Function (see Function class) which can be used in all places where functions can be used (e.g. see Fitting).

This class takes care of the CompiledFunction parameter interface (see FunctionParam class for details).

Example

In the following example a Gaussian profile with three parameters (height, center and halfwidth) is specified and its value and derivatives with respect to the parameters are calculated at x=2.

    // the Gaussian
    CompiledFunction<Double> prof("p0*exp(-((x-p1)/p2)^2)");
    prof[0] = 2;				// the height
    prof[1] = 1.5;			// the center
    prof[2] = 1;				// the width
    Vector<Double> x(3);
    X[0] = 1.9; x[1] = 2.0; x[2] = 2.1;
    cout << "Gaussian at x=" << x << ": " << prof(x) << endl;
    // and an automatic derivative one:
    CompiledFunction<AutoDiff<Double> > profad("p0*exp(-((x-p1)/p2)^2)");
    cout << "Gaussian at x=" << x << ": " << profad(x) << endl;

will produce the output: