Playa::SimpleScaledOp< Scalar > Class Template Reference

Represent a scaled operator. More...

Inheritance diagram for Playa::SimpleScaledOp< Scalar >:

List of all members.

Public Member Functions
	SimpleScaledOp (const Scalar &alpha, const LinearOperator< Scalar > &A)
void	apply (Teuchos::ETransp transApplyType, const Vector< Scalar > &in, Vector< Scalar > out) const
	Apply the operator.
std::string	description () const
const Scalar &	alpha () const
LinearOperator< Scalar >	op () const
void	print (std::ostream &os) const
	abstract print function
Private Attributes
Scalar	alpha_
LinearOperator< Scalar >	A_
Related Functions
(Note that these are not member functions.)
template<class Scalar >
LinearOperator< Scalar >	scaledOperator (const Scalar &scale, const LinearOperator< Scalar > &op)

---

Detailed Description

template<class Scalar>
class Playa::SimpleScaledOp< Scalar >

Represent a scaled operator.

Definition at line 26 of file PlayaSimpleScaledOpDecl.hpp.

---

Constructor & Destructor Documentation

template<class Scalar >

Playa::SimpleScaledOp< Scalar >::SimpleScaledOp	(	const Scalar &	alpha,
		const LinearOperator< Scalar > &	A
	)			[inline]

Definition at line 32 of file PlayaSimpleScaledOpImpl.hpp.

---

Member Function Documentation

template<class Scalar >

const Scalar& Playa::SimpleScaledOp< Scalar >::alpha

(

)

const [inline]

Definition at line 43 of file PlayaSimpleScaledOpDecl.hpp.

References Playa::SimpleScaledOp< Scalar >::alpha_.

template<class Scalar >

void Playa::SimpleScaledOp< Scalar >::apply	(	Teuchos::ETransp	applyType,
		const Vector< Scalar > &	in,
		Vector< Scalar >	out
	)			const [inline, virtual]

Apply the operator.

Parameters:

	applyType	Indicates whether to apply the operator, its transpose, or its conjugate transpose.
	in	The vector on which the operator is to act
	out	The vector into which the result of the operation is to be written. This vector should already be initialized by the appropriate space.

Implements Playa::LinearOperatorBase< Scalar >.

Definition at line 42 of file PlayaSimpleScaledOpImpl.hpp.

References Playa::SimpleScaledOp< Scalar >::A_, Playa::SimpleScaledOp< Scalar >::alpha_, PLAYA_MSG2, Playa::Vector< Scalar >::scale(), and Playa::ObjectWithVerbosity::verb().

template<class Scalar >

std::string Playa::SimpleScaledOp< Scalar >::description

(

)

const [inline]

Definition at line 63 of file PlayaSimpleScaledOpImpl.hpp.

References Playa::SimpleScaledOp< Scalar >::A_, Playa::SimpleScaledOp< Scalar >::alpha_, and Teuchos::toString().

template<class Scalar >

LinearOperator<Scalar> Playa::SimpleScaledOp< Scalar >::op

(

)

const [inline]

Definition at line 46 of file PlayaSimpleScaledOpDecl.hpp.

References Playa::SimpleScaledOp< Scalar >::A_.

template<class Scalar >

void Playa::SimpleScaledOp< Scalar >::print

(

std::ostream &

os

)

const [inline, virtual]

abstract print function

Implements Playa::Printable.

Definition at line 72 of file PlayaSimpleScaledOpImpl.hpp.

References Playa::SimpleScaledOp< Scalar >::A_, and Playa::SimpleScaledOp< Scalar >::alpha_.

---

Friends And Related Function Documentation

template<class Scalar >

LinearOperator< Scalar > scaledOperator	(	const Scalar &	scale,
		const LinearOperator< Scalar > &	op
	)			[related]

Definition at line 85 of file PlayaSimpleScaledOpImpl.hpp.

---

Member Data Documentation

template<class Scalar >

LinearOperator<Scalar> Playa::SimpleScaledOp< Scalar >::A_ [private]

Definition at line 53 of file PlayaSimpleScaledOpDecl.hpp.

Referenced by Playa::SimpleScaledOp< Scalar >::apply(), Playa::SimpleScaledOp< Scalar >::description(), Playa::SimpleScaledOp< Scalar >::op(), and Playa::SimpleScaledOp< Scalar >::print().

template<class Scalar >

Scalar Playa::SimpleScaledOp< Scalar >::alpha_ [private]

Definition at line 52 of file PlayaSimpleScaledOpDecl.hpp.

Referenced by Playa::SimpleScaledOp< Scalar >::alpha(), Playa::SimpleScaledOp< Scalar >::apply(), Playa::SimpleScaledOp< Scalar >::description(), and Playa::SimpleScaledOp< Scalar >::print().