RVL::RVLL2innerProd< complex< Scalar > > Class Template Reference

Complex specialization of L2 Inner Product. More...

#include <functions.hh>

Inheritance diagram for RVL::RVLL2innerProd< complex< Scalar > >:

RVL::BinaryLocalFunctionObjectScalarRedn< complex< Scalar >, complex< Scalar > > RVL::FunctionObjectScalarRedn< complex< Scalar > > RVL::BinaryLocalConstEval< complex< Scalar > > RVL::FunctionObjectConstEval RVL::ScalarRedn< complex< Scalar > > RVL::LocalConstEval< complex< Scalar > > RVL::Writeable List of all members.

Public Member Functions

 RVLL2innerProd (Scalar _scale=ScalarFieldTraits< Scalar >::One(), complex< Scalar > _init=complex< Scalar >(ScalarFieldTraits< Scalar >::Zero()))
 RVLL2innerProd (const RVLL2innerProd< complex< Scalar > > &ipfo)
 ~RVLL2innerProd ()
void setValue ()
void operator() (LocalDataContainer< complex< Scalar > > const &v, LocalDataContainer< complex< Scalar > > const &w)
Scalar getScale () const
 added to enable faithful copy in LinAlg package copy constructors
void setScale (Scalar newscale)
 added to separate instantiation from initialization.
string getName () const

Detailed Description

template<class Scalar>
class RVL::RVLL2innerProd< complex< Scalar > >

Complex specialization of L2 Inner Product.

Note: scale is REAL.

Definition at line 279 of file functions.hh.


Constructor & Destructor Documentation

template<class Scalar>
RVL::RVLL2innerProd< complex< Scalar > >::RVLL2innerProd ( Scalar  _scale = ScalarFieldTraits<Scalar>::One(),
complex< Scalar >  _init = complex<Scalar>(ScalarFieldTraits<Scalar>::Zero()) 
)

Parameters:
_scale a scale factor applied to the inner product. Defaults to 1
_init uses 0 as the default initial value, but can be set otherwise.

Definition at line 288 of file functions.hh.

template<class Scalar>
RVL::RVLL2innerProd< complex< Scalar > >::RVLL2innerProd ( const RVLL2innerProd< complex< Scalar > > &  ipfo  ) 

Definition at line 292 of file functions.hh.

template<class Scalar>
RVL::RVLL2innerProd< complex< Scalar > >::~RVLL2innerProd (  ) 

Definition at line 295 of file functions.hh.


Member Function Documentation

template<class Scalar>
void RVL::RVLL2innerProd< complex< Scalar > >::setValue (  )  [virtual]

Implements RVL::ScalarRedn< complex< Scalar > >.

Definition at line 297 of file functions.hh.

References RVL::RVLL2innerProd< Scalar >::setValue().

template<class Scalar>
void RVL::RVLL2innerProd< complex< Scalar > >::operator() ( LocalDataContainer< complex< Scalar > > const &  v,
LocalDataContainer< complex< Scalar > > const &  w 
) [virtual]

Implements RVL::BinaryLocalConstEval< complex< Scalar > >.

Definition at line 300 of file functions.hh.

References RVL::ScalarRedn< Scalar >::getValue(), and RVL::RVLL2innerProd< Scalar >::setValue().

template<class Scalar>
Scalar RVL::RVLL2innerProd< complex< Scalar > >::getScale (  )  const

added to enable faithful copy in LinAlg package copy constructors

Definition at line 330 of file functions.hh.

template<class Scalar>
void RVL::RVLL2innerProd< complex< Scalar > >::setScale ( Scalar  newscale  ) 

added to separate instantiation from initialization.

Definition at line 333 of file functions.hh.

template<class Scalar>
string RVL::RVLL2innerProd< complex< Scalar > >::getName (  )  const [virtual]

Implements RVL::FunctionObjectConstEval.

Definition at line 335 of file functions.hh.


The documentation for this class was generated from the following file:
Generated on 5 Jan 2017 for LocalRVL by  doxygen 1.4.7