Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::Function< F > Class Template Referenceabstract

#include <basis.hh>

Inheritance diagram for concepts::Function< F >:
concepts::OutputOperator concepts::Vector< Real > concepts::Vector< concepts::Real > concepts::Vector< ScalarT > concepts::Vector< Cmplx > concepts::Vector< G > concepts::SubVector< F > concepts::Vector< F > timestepping::TimeVector

Public Member Functions

template<class G >
 Function (const Space< G > &spc)
 Constructor.
 
 Function (const uint dim)
 
virtual Function< F > & operator= (const Function< F > &fnc)=0
 Assignment operator.
 
virtual F & operator() (uint i)=0
 Index operator.
 
virtualoperator() (uint i) const =0
 Index operator.
 
virtual Function< F > & operator+= (const Function< F > &fnc)
 Addition operator.
 
virtual Function< F > & operator+= (F c)
 Addition operator.
 
virtual Function< F > & operator-= (const Function< F > &fnc)
 Subtraction operator.
 
virtual Function< F > & operator-= (F c)
 Subtraction operator.
 
virtual Function< F > & operator*= (F a)
 Scaling operator.
 
virtual Function< F > & add (const Function< F > &fnc, F a)
 Adds a times fnc to this function.
 
uint dim () const
 Returns the dimension of the function.
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

Protected Attributes

uint dim_
 Dimension of the function (or of the space the function is defined)
 

Detailed Description

template<class F>
class concepts::Function< F >

Abstract class for a function. A function is always associated to a space which determines the dimension of the function.

Definition at line 21 of file basis.hh.

Constructor & Destructor Documentation

◆ Function() [1/2]

template<class F >
template<class G >
concepts::Function< F >::Function ( const Space< G > &  spc)
inline

Constructor.

Definition at line 25 of file basis.hh.

◆ Function() [2/2]

template<class F >
concepts::Function< F >::Function ( const uint  dim)
inline

Definition at line 26 of file basis.hh.

Member Function Documentation

◆ add()

template<class F >
virtual Function< F > & concepts::Function< F >::add ( const Function< F > &  fnc,
a 
)
virtual

Adds a times fnc to this function.

Reimplemented in concepts::SubVector< F >, and concepts::Vector< F >.

◆ dim()

template<class F >
uint concepts::Function< F >::dim ( ) const
inline

Returns the dimension of the function.

Definition at line 53 of file basis.hh.

◆ info()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator*=()

template<class F >
virtual Function< F > & concepts::Function< F >::operator*= ( a)
virtual

Scaling operator.

Reimplemented in concepts::SubVector< F >, and concepts::Vector< F >.

◆ operator+=() [1/2]

template<class F >
virtual Function< F > & concepts::Function< F >::operator+= ( const Function< F > &  fnc)
virtual

Addition operator.

Reimplemented in concepts::SubVector< F >, and concepts::Vector< F >.

◆ operator+=() [2/2]

template<class F >
virtual Function< F > & concepts::Function< F >::operator+= ( c)
virtual

Addition operator.

Reimplemented in concepts::SubVector< F >, and concepts::Vector< F >.

◆ operator-=() [1/2]

template<class F >
virtual Function< F > & concepts::Function< F >::operator-= ( const Function< F > &  fnc)
virtual

Subtraction operator.

Reimplemented in concepts::SubVector< F >, and concepts::Vector< F >.

◆ operator-=() [2/2]

template<class F >
virtual Function< F > & concepts::Function< F >::operator-= ( c)
virtual

Subtraction operator.

Reimplemented in concepts::SubVector< F >, and concepts::Vector< F >.

◆ operator=()

template<class F >
virtual Function< F > & concepts::Function< F >::operator= ( const Function< F > &  fnc)
pure virtual

Member Data Documentation

◆ dim_

template<class F >
uint concepts::Function< F >::dim_
protected

Dimension of the function (or of the space the function is defined)

Definition at line 57 of file basis.hh.


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