Loading...
Searching...
No Matches
SparseDiffRep.h
Go to the documentation of this file.
//# SparseDiffRep.h: Representation of an automatic differential class data
//# Copyright (C) 2007
//# 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_SPARSEDIFFREP_H
#define SCIMATH_SPARSEDIFFREP_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/vector.h>
#include <utility>
// Using
using std::pair;
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward declarations
// <summary>
// Representation of data for the spare automatic differentiation calss.
// </summary>
//
// <use visibility=local>
//
// <reviewed reviewer="UNKNOWN" date="" tests="tSparseDiff.cc" demos="">
// </reviewed>
//
// <prerequisite>
// <li> <linkto class=SparseDiff>SparseDiff</linkto>
// </prerequisite>
//
// <etymology>
// Class that represents partial derivatives obtained by automatic
// differentiation.
// </etymology>
//
// <synopsis>
// Class representing
// the data necessary for automatic differentiation. The structure contains a
// value, and the derivatives of the value with respect to a number of
// dependent variables.
//
// The actual differentiation and access is done through the
// <linkto class=SparseDiff>SparseDiff</linkto> class.
//
// <example>
// See the example in <linkto class=SparseDiff>SparseDiff</linkto>
// </example>
//
// <motivation>
// To separate the data container from the actual calculations.
// To be able to create special conatiners; constructors and destructors
// (including memory allocation) to speed up processes.
//
// <templating arg=T>
// <li> any class that has the standard mathematical and comparison
// operators defined
// </templating>
//
// <todo asof="2007/11/27">
// <li> Nothing I know of
// </todo>
template <class T> class SparseDiffRep {
public:
//# Typedefs
typedef T value_type;
typedef value_type& reference;
typedef const value_type& const_reference;
typedef value_type* iterator;
typedef const value_type* const_iterator;
//# Constructors
// Construct a constant with a value of zero. Zero derivatives.
SparseDiffRep();
//# Operators
// Assignment operators
// <group>
SparseDiffRep<T> &operator=(const T &v);
SparseDiffRep<T> &operator=(const vector<pair<uInt, T> > &grad);
SparseDiffRep<T> &operator=(const SparseDiffRep<T> &other);
void operator*=(const T other);
void operator/=(const T other);
void operator+=(const T other);
void operator-=(const T other);
// </group>
//# Member functions
// Clear for reuse
void clear() { grad_p.clear(); }
//# Data
// The function value
T val_p;
// The derivatives
vector<pair<uInt, T> > grad_p;
// Link to indicate its status (1=linked in stack; 2=used in modules)
uInt link_p;
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/scimath/Mathematics/SparseDiffRep.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
casacore::SparseDiffRep::link_p
uInt link_p
Link to indicate its status (1=linked in stack; 2=used in modules).
Definition SparseDiffRep.h:122
casacore::SparseDiffRep::clear
void clear()
Clear for reuse.
Definition SparseDiffRep.h:114
casacore::SparseDiffRep::operator=
SparseDiffRep< T > & operator=(const SparseDiffRep< T > &other)
casacore::SparseDiffRep::grad_p
vector< pair< uInt, T > > grad_p
The derivatives.
Definition SparseDiffRep.h:120
casacore::SparseDiffRep::reference
value_type & reference
Definition SparseDiffRep.h:90
casacore::SparseDiffRep::operator*=
void operator*=(const T other)
casacore::SparseDiffRep::value_type
T value_type
Definition SparseDiffRep.h:89
casacore::SparseDiffRep::const_iterator
const value_type * const_iterator
Definition SparseDiffRep.h:93
casacore::SparseDiffRep::SparseDiffRep
SparseDiffRep()
Construct a constant with a value of zero.
casacore::SparseDiffRep::operator-=
void operator-=(const T other)
casacore::SparseDiffRep::iterator
value_type * iterator
Definition SparseDiffRep.h:92
casacore::SparseDiffRep::operator/=
void operator/=(const T other)
casacore::SparseDiffRep::const_reference
const value_type & const_reference
Definition SparseDiffRep.h:91
casacore::SparseDiffRep::operator=
SparseDiffRep< T > & operator=(const T &v)
Assignment operators.
casacore::SparseDiffRep::operator=
SparseDiffRep< T > & operator=(const vector< pair< uInt, T > > &grad)
casacore::SparseDiffRep::val_p
T val_p
The function value.
Definition SparseDiffRep.h:118
casacore::SparseDiffRep::operator+=
void operator+=(const T other)
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::uInt
unsigned int uInt
Definition aipstype.h:49