OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
Vps< T > Class Template Reference

Vector truncated power series. More...

#include <Vps.h>

Inheritance diagram for Vps< T >:
Collaboration diagram for Vps< T >:

Public Member Functions

 Vps (int nDim, int nVar=0)
 Constructor.
 Vps (const Matrix< T > &M)
 Convert.
 Vps (const Vector< T > &V)
 Convert from vector.
 Vps ()
 Vps (const Vps< T > &rhs)
 ~Vps ()
Vps< T > & operator= (const Vps< T > &)
const Tps< T > & getComponent (int index) const
 Get component.
void setComponent (int index, const Tps< T > &value)
 Set component.
Tps< T > & operator[] (int index)
 Get component.
const Tps< T > & operator[] (int index) const
 Set component.
void check () const
 Check consistency.
Vps< T > operator+ () const
 Unary plus.
Vps< T > operator- () const
 Unary minus.
Vps< T > & operator*= (const Tps< T > &y)
 Multiply by Tps<T> and assign.
Vps< T > & operator/= (const Tps< T > &y)
 Divide by Tps<T> and assign.
Vps< T > & operator*= (const T &y)
 Multiply by constant and assign.
Vps< T > & operator/= (const T &y)
 Divide by constant and assign.
Vps< T > & operator+= (const Vps< T > &y)
 Addition.
Vps< T > & operator-= (const Vps< T > &y)
 Subtraction.
Vps< T > & operator+= (const Vector< T > &y)
 Add and assign.
Vps< T > & operator-= (const Vector< T > &y)
 Subtract and assign.
std::istream & get (std::istream &is)
 Get a Vps<T> from stream is.
std::ostream & put (std::ostream &os) const
 Put a Vps<T> to stream os.
int getDimension () const
 Get dimension (number of Tps<T> components).
int getTopOrder () const
 Get highest order contained in any component.
int getTruncOrder () const
 Get lowest truncation order in any component.
int getVariables () const
 Get number of variables (the same in all components).
Vps< T > filter (int lowOrder, int highOrder) const
 Extract range of orders, set others to zero.
Vps< T > truncate (int trunc)
 Truncate, may also increase truncation order.

Protected Attributes

Array1D< Tps< T > > data
int variables

Detailed Description

template<class T>
class Vps< T >

Vector truncated power series.

Definition at line 38 of file Vps.h.

Constructor & Destructor Documentation

◆ Vps() [1/5]

◆ Vps() [2/5]

template<class T>
Vps< T >::Vps ( const Matrix< T > & M)

Convert.

Definition at line 59 of file Vps.hpp.

References data, Array2D< T >::ncols(), Array2D< T >::nrows(), and variables.

Here is the call graph for this function:

◆ Vps() [3/5]

template<class T>
Vps< T >::Vps ( const Vector< T > & V)

Convert from vector.

Definition at line 72 of file Vps.hpp.

References data, and variables.

◆ Vps() [4/5]

template<class T>
Vps< T >::Vps ( )

Definition at line 40 of file Vps.hpp.

References data, and variables.

◆ Vps() [5/5]

template<class T>
Vps< T >::Vps ( const Vps< T > & rhs)

Definition at line 52 of file Vps.hpp.

References data, variables, and Vps().

Here is the call graph for this function:

◆ ~Vps()

template<class T>
Vps< T >::~Vps ( )

Definition at line 79 of file Vps.hpp.

Member Function Documentation

◆ check()

template<class T>
void Vps< T >::check ( ) const

Check consistency.

Definition at line 108 of file Vps.hpp.

References data, and variables.

Referenced by filter(), get(), getVariables(), setComponent(), VpsMap< T >::substitute(), and truncate().

◆ filter()

template<class T>
Vps< T > Vps< T >::filter ( int lowOrder,
int highOrder ) const

Extract range of orders, set others to zero.

Definition at line 286 of file Vps.hpp.

References check(), data, getDimension(), variables, and Vps().

Here is the call graph for this function:

◆ get()

template<class T>
std::istream & Vps< T >::get ( std::istream & is)

Get a Vps<T> from stream is.

Definition at line 213 of file Vps.hpp.

References check(), data, and Vps().

Referenced by operator>>(), and operator>>().

Here is the call graph for this function:

◆ getComponent()

template<class T>
const Tps< T > & Vps< T >::getComponent ( int index) const

Get component.

Definition at line 92 of file Vps.hpp.

References data.

◆ getDimension()

◆ getTopOrder()

template<class T>
int Vps< T >::getTopOrder ( ) const

Get highest order contained in any component.

Definition at line 253 of file Vps.hpp.

References data, FTpsData< N >::topOrder, and Tps< T >::getMaxOrder().

Referenced by VpsMap< T >::constantTerm(), and VpsMap< T >::substitute().

Here is the call graph for this function:

◆ getTruncOrder()

template<class T>
int Vps< T >::getTruncOrder ( ) const

Get lowest truncation order in any component.

Definition at line 266 of file Vps.hpp.

References data, Tps< T >::getTruncOrder(), and Tps< T >::truncOrder.

Referenced by VpsMap< T >::substitute(), and VpsMap< T >::substitute().

Here is the call graph for this function:

◆ getVariables()

template<class T>
int Vps< T >::getVariables ( ) const

Get number of variables (the same in all components).

Definition at line 279 of file Vps.hpp.

References check(), and variables.

Referenced by VpsMap< T >::constantTerm(), VpsMap< T >::derivative(), VpsMap< T >::integral(), VpsMap< T >::linearTerms(), VpsMap< T >::linearTerms(), and VpsMap< T >::substitute().

Here is the call graph for this function:

◆ operator*=() [1/2]

template<class T>
Vps< T > & Vps< T >::operator*= ( const T & y)

Multiply by constant and assign.

Definition at line 153 of file Vps.hpp.

References data, getDimension(), and Vps().

Here is the call graph for this function:

◆ operator*=() [2/2]

template<class T>
Vps< T > & Vps< T >::operator*= ( const Tps< T > & y)

Multiply by Tps<T> and assign.

Definition at line 138 of file Vps.hpp.

References data, getDimension(), and Vps().

Here is the call graph for this function:

◆ operator+()

template<class T>
Vps< T > Vps< T >::operator+ ( ) const

Unary plus.

Definition at line 124 of file Vps.hpp.

References Vps().

Here is the call graph for this function:

◆ operator+=() [1/2]

template<class T>
Vps< T > & Vps< T >::operator+= ( const Vector< T > & y)

Add and assign.

Definition at line 191 of file Vps.hpp.

References data, getDimension(), Array1D< T >::size(), and Vps().

Here is the call graph for this function:

◆ operator+=() [2/2]

template<class T>
Vps< T > & Vps< T >::operator+= ( const Vps< T > & y)

Addition.

Definition at line 169 of file Vps.hpp.

References data, getDimension(), and Vps().

Here is the call graph for this function:

◆ operator-()

template<class T>
Vps< T > Vps< T >::operator- ( ) const

Unary minus.

Definition at line 130 of file Vps.hpp.

References data, getDimension(), variables, and Vps().

Here is the call graph for this function:

◆ operator-=() [1/2]

template<class T>
Vps< T > & Vps< T >::operator-= ( const Vector< T > & y)

Subtract and assign.

Definition at line 202 of file Vps.hpp.

References data, getDimension(), Array1D< T >::size(), and Vps().

Here is the call graph for this function:

◆ operator-=() [2/2]

template<class T>
Vps< T > & Vps< T >::operator-= ( const Vps< T > & y)

Subtraction.

Definition at line 180 of file Vps.hpp.

References data, getDimension(), and Vps().

Here is the call graph for this function:

◆ operator/=() [1/2]

template<class T>
Vps< T > & Vps< T >::operator/= ( const T & y)

Divide by constant and assign.

Definition at line 160 of file Vps.hpp.

References data, getDimension(), and Vps().

Here is the call graph for this function:

◆ operator/=() [2/2]

template<class T>
Vps< T > & Vps< T >::operator/= ( const Tps< T > & y)

Divide by Tps<T> and assign.

Definition at line 145 of file Vps.hpp.

References data, getDimension(), Tps< T >::getGlobalTruncOrder(), Tps< T >::inverse(), and Vps().

Here is the call graph for this function:

◆ operator=()

template<class T>
Vps< T > & Vps< T >::operator= ( const Vps< T > & y)

Definition at line 84 of file Vps.hpp.

References data, variables, and Vps().

Referenced by VpsMap< T >::operator=().

Here is the call graph for this function:

◆ operator[]() [1/2]

template<class T>
Tps< T > & Vps< T >::operator[] ( int index)
inline

Get component.

Definition at line 154 of file Vps.h.

References data.

◆ operator[]() [2/2]

template<class T>
const Tps< T > & Vps< T >::operator[] ( int index) const
inline

Set component.

Definition at line 158 of file Vps.h.

References data.

◆ put()

template<class T>
std::ostream & Vps< T >::put ( std::ostream & os) const

Put a Vps<T> to stream os.

Definition at line 238 of file Vps.hpp.

References data, and getDimension().

Referenced by operator<<(), and operator<<().

Here is the call graph for this function:

◆ setComponent()

template<class T>
void Vps< T >::setComponent ( int index,
const Tps< T > & value )

Set component.

Definition at line 98 of file Vps.hpp.

References check(), data, Tps< T >::getVariables(), and variables.

Here is the call graph for this function:

◆ truncate()

template<class T>
Vps< T > Vps< T >::truncate ( int trunc)

Truncate, may also increase truncation order.

Definition at line 299 of file Vps.hpp.

References check(), data, getDimension(), variables, and Vps().

Here is the call graph for this function:

Member Data Documentation

◆ data

◆ variables

template<class T>
int Vps< T >::variables
mutableprotected

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