Loading...
Searching...
No Matches
MarshallableChebyshev.h
Go to the documentation of this file.
//# MarshalableChebyshev.h: a Marshallable Chebyshev polynomial
//# Copyright (C) 2002
//# 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_MARSHALLABLECHEBYSHEV_H
#define SCIMATH_MARSHALLABLECHEBYSHEV_H
#include <casacore/casa/aips.h>
#include <casacore/scimath/Functionals/Chebyshev.h>
#include <casacore/scimath/Functionals/FunctionMarshallable.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
// <summary> A Chebyshev function class that supports serialization
// </summary>
// <use visibility=export>
// <reviewed reviewer="wbrouw" date="2001/11/12" tests="tChebyshev" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=Function>Function</linkto>
// </prerequisite>
//
// <etymology>
// This class is named after Chebyshev Type I polynomials. "Marshallable"
// means that the class can be serialized into a form that can be transmitted
// to another execution context.
// </etymology>
//
// <synopsis>
// This class is a specialization of the Chebyshev class that supports
// serialization. That is, it allows one to write the state of the Chebyshev
// polynomial object into a Record. This record can then be transmitted
// to another execution context where it
// can be "reconstituted" as a new object with identical state as this one.
// This documentation focusses on this serialization functionality (also known
// as "marshalling"); for details about the general features of the Chebyshev
// polynomial series, see the <linkto class="Chebyshev">Chebyshev</linkto>
// class.
// </synopsis>
//
// <example>
// </example>
//
// <motivation>
// Making Chebyshev Marshallable provides a convenient way of configuring
// the simulator tool from .
// </motivation>
//
// <thrown>
// <li> Assertion in debug mode if attempt is made to address incorrect
// coefficients
// </thrown>
//
template<class T>
class MarshallableChebyshev : public Chebyshev<T>,
public FunctionMarshallable
{
private:
static const String modenames[];
public:
static const String FUNCTYPE;
static const String FUNCFIELDS[];
// definitions of the fields stored in a serialized Record. The
// actual string names are stored in FUNCFIELDS
enum FieldNames {
// the array of coefficients
COEFFS,
// the default mode
MODE,
// the default value to use when mode=CONSTANT
DEF,
// the 2-element double array
INTERVAL,
// the number of supported fields
NFieldNames
};
//# Constructors
// create a zero-th order Chebyshev polynomial with the first coefficient
// equal to zero. The bounded domain is [T(-1), T(1)]. The
// OutOfDomainMode is CONSTANT, and the default value is T(0).
MarshallableChebyshev() :
Chebyshev<T>(), FunctionMarshallable(FUNCTYPE) {}
// create an n-th order Chebyshev polynomial with the coefficients
// equal to zero. The bounded domain is [T(-1), T(1)]. The
// OutOfDomainMode is CONSTANT, and the default value is T(0).
explicit MarshallableChebyshev(const uInt n) :
Chebyshev<T>(n), FunctionMarshallable(FUNCTYPE) {}
// create a zero-th order Chebyshev polynomical with the first coefficient
// equal to one.
// min is the minimum value of its Chebyshev interval, and
// max is the maximum value.
// mode sets the behavior of the function outside the Chebyshev interval
// (see setOutOfIntervalMode() and OutOfIntervalMode enumeration
// definition for details).
// defval is the value returned when the function is evaluated outside
// the Chebyshev interval and mode=CONSTANT.
MarshallableChebyshev(const T &min, const T &max,
const typename ChebyshevEnums::
OutOfIntervalMode mode=ChebyshevEnums::CONSTANT,
const T &defval=T(0)) :
Chebyshev<T>(min, max, mode, defval), FunctionMarshallable(FUNCTYPE)
{}
// create a fully specified Chebyshev polynomial.
// coeffs holds the coefficients of the Chebyshev polynomial (see
// setCoefficients() for details).
// min is the minimum value of its canonical range, and
// max is the maximum value.
// mode sets the behavior of the function outside the Chebyshev interval
// (see setOutOfIntervalMode() and OutOfIntervalMode enumeration
// definition for details).
// defval is the value returned when the function is evaluated outside
// the canonical range and mode=CONSTANT.
MarshallableChebyshev(const Vector<T> &coeffs,
const T &min, const T &max,
const typename ChebyshevEnums::
OutOfIntervalMode mode=ChebyshevEnums::CONSTANT,
const T &defval=T(0)) :
Chebyshev<T>(coeffs, min, max, mode, defval),
FunctionMarshallable(FUNCTYPE)
{}
// create a fully specified Chebyshev polynomial from parameters
// stored in a Record.
explicit MarshallableChebyshev(const Record& gr)
throw(InvalidSerializationError);
// create a deep copy of another Chebyshev polynomial
// <group>
MarshallableChebyshev(const Chebyshev<T> &other) :
Chebyshev<T>(other), FunctionMarshallable(FUNCTYPE) {}
MarshallableChebyshev(const MarshallableChebyshev<T> &other) :
Chebyshev<T>(other), FunctionMarshallable(other) {}
// </group>
// make a (deep) copy of another Chebyshev polynomial
// <group>
MarshallableChebyshev<T> &operator=(
const MarshallableChebyshev<T> &other)
{
FunctionMarshallable::operator=(other);
Chebyshev<T>::operator=(other);
return *this;
}
MarshallableChebyshev<T> &operator=(
const Chebyshev<T> &other)
{
Chebyshev<T>::operator=(other);
return *this;
}
// </group>
// Destructor
virtual ~MarshallableChebyshev() {}
// store the state of this Function into a Record
virtual void store(Record& gr) const;
// Create a copy of this object. The caller is responsible for
// deleting the pointer.
virtual Function<T> *clone() const {
return new MarshallableChebyshev<T>(*this);
}
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/scimath/Functionals/MarshallableChebyshev.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
casacore::ChebyshevEnums
Definition ChebyshevParam.h:45
casacore::ChebyshevEnums::CONSTANT
@ CONSTANT
return a constant, default value.
Definition ChebyshevParam.h:53
casacore::Chebyshev::Chebyshev
Chebyshev()
create a zero-th order Chebyshev polynomial with the first coefficient equal to zero.
Definition Chebyshev.h:240
casacore::Chebyshev::operator=
Chebyshev< T > & operator=(const Chebyshev< T > &other)
make this instance a (deep) copy of another Chebyshev polynomial
Definition Chebyshev.h:297
casacore::FunctionMarshallable::operator=
virtual FunctionMarshallable & operator=(const FunctionMarshallable &other)
Definition FunctionMarshallable.h:100
casacore::FunctionMarshallable::FunctionMarshallable
FunctionMarshallable(const String &functype)
create a FunctionMarshallable.
Definition FunctionMarshallable.h:87
casacore::Function
Definition Function.h:200
casacore::InvalidSerializationError
Definition FunctionFactoryErrors.h:57
casacore::MarshallableChebyshev::MarshallableChebyshev
MarshallableChebyshev(const Record &gr)
create a fully specified Chebyshev polynomial from parameters stored in a Record.
casacore::MarshallableChebyshev::FUNCFIELDS
static const String FUNCFIELDS[]
Definition MarshallableChebyshev.h:92
casacore::MarshallableChebyshev::MarshallableChebyshev
MarshallableChebyshev(const uInt n)
create an n-th order Chebyshev polynomial with the coefficients equal to zero.
Definition MarshallableChebyshev.h:119
casacore::MarshallableChebyshev::clone
virtual Function< T > * clone() const
Create a copy of this object.
Definition MarshallableChebyshev.h:195
casacore::MarshallableChebyshev::MarshallableChebyshev
MarshallableChebyshev()
create a zero-th order Chebyshev polynomial with the first coefficient equal to zero.
Definition MarshallableChebyshev.h:113
casacore::MarshallableChebyshev::MarshallableChebyshev
MarshallableChebyshev(const MarshallableChebyshev< T > &other)
Definition MarshallableChebyshev.h:166
casacore::MarshallableChebyshev::modenames
static const String modenames[]
Definition MarshallableChebyshev.h:88
casacore::MarshallableChebyshev::FUNCTYPE
static const String FUNCTYPE
Definition MarshallableChebyshev.h:91
casacore::MarshallableChebyshev::FieldNames
FieldNames
definitions of the fields stored in a serialized Record.
Definition MarshallableChebyshev.h:96
casacore::MarshallableChebyshev::NFieldNames
@ NFieldNames
the number of supported fields
Definition MarshallableChebyshev.h:106
casacore::MarshallableChebyshev::COEFFS
@ COEFFS
the array of coefficients
Definition MarshallableChebyshev.h:98
casacore::MarshallableChebyshev::MODE
@ MODE
the default mode
Definition MarshallableChebyshev.h:100
casacore::MarshallableChebyshev::INTERVAL
@ INTERVAL
the 2-element double array
Definition MarshallableChebyshev.h:104
casacore::MarshallableChebyshev::DEF
@ DEF
the default value to use when mode=CONSTANT
Definition MarshallableChebyshev.h:102
casacore::MarshallableChebyshev::MarshallableChebyshev
MarshallableChebyshev(const Chebyshev< T > &other)
create a deep copy of another Chebyshev polynomial
Definition MarshallableChebyshev.h:164
casacore::MarshallableChebyshev::operator=
MarshallableChebyshev< T > & operator=(const MarshallableChebyshev< T > &other)
make a (deep) copy of another Chebyshev polynomial
Definition MarshallableChebyshev.h:172
casacore::MarshallableChebyshev::operator=
MarshallableChebyshev< T > & operator=(const Chebyshev< T > &other)
Definition MarshallableChebyshev.h:179
casacore::MarshallableChebyshev::MarshallableChebyshev
MarshallableChebyshev(const Vector< T > &coeffs, const T &min, const T &max, const typename ChebyshevEnums::OutOfIntervalMode mode=ChebyshevEnums::CONSTANT, const T &defval=T(0))
create a fully specified Chebyshev polynomial.
Definition MarshallableChebyshev.h:148
casacore::MarshallableChebyshev::~MarshallableChebyshev
virtual ~MarshallableChebyshev()
Destructor.
Definition MarshallableChebyshev.h:188
casacore::MarshallableChebyshev::store
virtual void store(Record &gr) const
store the state of this Function into a Record
casacore::MarshallableChebyshev::MarshallableChebyshev
MarshallableChebyshev(const T &min, const T &max, const typename ChebyshevEnums::OutOfIntervalMode mode=ChebyshevEnums::CONSTANT, const T &defval=T(0))
create a zero-th order Chebyshev polynomical with the first coefficient equal to one.
Definition MarshallableChebyshev.h:131
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::Vector
Definition Vector.h:82
casacore::Record
Record()
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::max
LatticeExprNode max(const LatticeExprNode &left, const LatticeExprNode &right)
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::min
LatticeExprNode min(const LatticeExprNode &left, const LatticeExprNode &right)