Loading...
Searching...
No Matches
CompiledParam.h
Go to the documentation of this file.
//# CompiledParam.h: Parameters for a compiled string function
//# Copyright (C) 2002,2005
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef SCIMATH_COMPILEDPARAM_H
#define SCIMATH_COMPILEDPARAM_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/BasicSL/String.h>
#include <casacore/scimath/Functionals/Function.h>
#include <casacore/scimath/Functionals/FuncExpression.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// Parameters for a compiled string function object.
// </summary>
//
// <use visibility=local>
//
// <reviewed reviewer="" date="" tests="tFuncExpression" demos="">
// </reviewed>
//
// <prerequisite>
// <li> <linkto class="FuncExpression">FuncExpression</linkto> class
// </prerequisite>
//
// <synopsis>
// Given a string describing an expression
// (see <linkto class=FuncExpression>FuncExpression</linkto> class for
// details of the expression), the <src>CompiledFunction</src>class wraps
// this expression as a
// Function (see <linkto class=Function>Function</linkto> class) which can
// be used in all places where functions can be used (e.g. see
// <linkto module=Fitting>Fitting</linkto>).
//
// This class takes care of the
// <linkto class=CompiledFunction>CompiledFunction</linkto> parameter interface
// (see <linkto class=FunctionParam>FunctionParam</linkto> class for details).
// </synopsis>
//
// <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 <src>x=2</src>.
// <srcblock>
// // 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;
// </srcblock>
// will produce the output:
// <srcblock>
// </srcblock>
// </example>
// <templating arg=T>
// <li> T should have standard numerical operators and functions.
// <li> To obtain derivatives, the derivatives should be defined.
// </templating>
// <thrown>
// </thrown>
// <motivation>
// This class was created to allow specialization of the function evaluation in
// a simple way.
// </motivation>
//
// <todo asof="2002/04/29">
// <li> Nothing I know of
// </todo>
template <class T> class CompiledParam : public Function<T> {
public:
//# Constructors
// The default constructor -- no functions, no parameters, nothing, the
// function operator returns a 0.
CompiledParam();
// Make this object a (deep) copy of other.
// <group>
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 FuncExpression(*other.getFunctionPtr())) {}
// </group>
// Make this object a (deep) copy of other.
CompiledParam<T> &operator=(const CompiledParam<T> &other);
// Destructor
virtual ~CompiledParam();
//# Operators
//# Member functions
// Give name of function
virtual const String &name() const { static String x("compiled");
return x; }
// Set a function. The return will be False (and an error message will be
// set) if a compilation error occurs
Bool setFunction(const String &newFunction);
// Return the error message of the compilation
const String &errorMessage() const { return msg_p; }
// Return the expression
const FuncExpression &function() const;
// Returns the dimension of function
virtual uInt ndim() const { return ndim_p; }
// Returns the text of the function string
const String &getText() const { return text_p; }
// Returns the function pointer (for debugging)
const FuncExpression* getFunctionPtr() const {
return functionPtr_p; }
protected:
//# Data
// Number of dimensions of underlying function
uInt ndim_p;
// Possible error message
String msg_p;
// Input text string
String text_p;
// Pointer to function
FuncExpression *functionPtr_p;
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/scimath/Functionals/CompiledParam.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
casacore::CompiledParam::ndim_p
uInt ndim_p
Number of dimensions of underlying function.
Definition CompiledParam.h:153
casacore::CompiledParam::~CompiledParam
virtual ~CompiledParam()
Destructor.
casacore::CompiledParam::ndim
virtual uInt ndim() const
Returns the dimension of function.
Definition CompiledParam.h:141
casacore::CompiledParam::getFunctionPtr
const FuncExpression * getFunctionPtr() const
Returns the function pointer (for debugging).
Definition CompiledParam.h:147
casacore::CompiledParam::CompiledParam
CompiledParam(const CompiledParam< W > &other)
Definition CompiledParam.h:113
casacore::CompiledParam::operator=
CompiledParam< T > & operator=(const CompiledParam< T > &other)
Make this object a (deep) copy of other.
casacore::CompiledParam::CompiledParam
CompiledParam(const CompiledParam< T > &other)
Make this object a (deep) copy of other.
casacore::CompiledParam::msg_p
String msg_p
Possible error message.
Definition CompiledParam.h:155
casacore::CompiledParam::getText
const String & getText() const
Returns the text of the function string.
Definition CompiledParam.h:144
casacore::CompiledParam::text_p
String text_p
Input text string.
Definition CompiledParam.h:157
casacore::CompiledParam::functionPtr_p
FuncExpression * functionPtr_p
Pointer to function.
Definition CompiledParam.h:160
casacore::CompiledParam::function
const FuncExpression & function() const
Return the expression.
casacore::CompiledParam::name
virtual const String & name() const
Give name of function.
Definition CompiledParam.h:127
casacore::CompiledParam::setFunction
Bool setFunction(const String &newFunction)
Set a function.
casacore::CompiledParam::errorMessage
const String & errorMessage() const
Return the error message of the compilation.
Definition CompiledParam.h:135
casacore::CompiledParam::CompiledParam
CompiledParam()
The default constructor – no functions, no parameters, nothing, the function operator returns a 0.
casacore::FuncExpression
Definition FuncExpression.h:81
casacore::Function::Function
Function()
Constructors.
Definition Function.h:210
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40