RVL::RVLL2innerProd< Scalar > Class Template Reference

This BFOSR and Accumulation computes the inner product of two LDCs. More...

#include <functions.hh>

Inheritance diagram for RVL::RVLL2innerProd< Scalar >:

List of all members.

Public Member Functions
	RVLL2innerProd (Scalar _scale=ScalarFieldTraits< Scalar >::One(), Scalar _init=ScalarFieldTraits< Scalar >::Zero())
	RVLL2innerProd (const RVLL2innerProd< Scalar > &ipfo)
	~RVLL2innerProd ()
void	setValue ()
void	operator() (LocalDataContainer< Scalar > const &v, LocalDataContainer< 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< Scalar >

This BFOSR and Accumulation computes the inner product of two LDCs.

Definition at line 216 of file functions.hh.

---

Constructor & Destructor Documentation

template<class Scalar>

RVL::RVLL2innerProd< Scalar >::RVLL2innerProd	(	Scalar	_scale = ScalarFieldTraits<Scalar>::One(),
		Scalar	_init = 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 225 of file functions.hh.

template<class Scalar>

RVL::RVLL2innerProd< Scalar >::RVLL2innerProd

(

const RVLL2innerProd< Scalar > &

ipfo

)

Definition at line 229 of file functions.hh.

template<class Scalar>

RVL::RVLL2innerProd< Scalar >::~RVLL2innerProd

(

)

Definition at line 232 of file functions.hh.

---

Member Function Documentation

template<class Scalar>

void RVL::RVLL2innerProd< Scalar >::setValue

(

)

[virtual]

Implements RVL::ScalarRedn< Scalar >.

Definition at line 234 of file functions.hh.

Referenced by RVL::RVLL2innerProd< complex< Scalar > >::operator()(), and RVL::RVLL2innerProd< complex< Scalar > >::setValue().

template<class Scalar>

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

Implements RVL::BinaryLocalConstEval< Scalar >.

Definition at line 237 of file functions.hh.

template<class Scalar>

Scalar RVL::RVLL2innerProd< Scalar >::getScale

(

)

const

added to enable faithful copy in LinAlg package copy constructors

Definition at line 267 of file functions.hh.

template<class Scalar>

void RVL::RVLL2innerProd< Scalar >::setScale

(

Scalar

newscale

)

added to separate instantiation from initialization.

Definition at line 270 of file functions.hh.

template<class Scalar>

string RVL::RVLL2innerProd< Scalar >::getName

(

)

const [virtual]

Implements RVL::FunctionObjectConstEval.

Definition at line 272 of file functions.hh.

---

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

• functions.hh

---