Teuchos - Trilinos Tools Package Version of the Day
Teuchos::MultiplicationFunction< OperandType > Class Template Reference

A simple function object that multiplys a specififed value from the given arguement in the runFunction function. More...

#include <Teuchos_StandardFunctionObjects.hpp>

Inheritance diagram for Teuchos::MultiplicationFunction< OperandType >:
Teuchos::SimpleFunctionObject< OperandType > Teuchos::FunctionObject Teuchos::Describable Teuchos::LabeledObject

List of all members.

Public Member Functions

Constructors/Destructors
 MultiplicationFunction ()
 Constructs a MultiplicationFunction.
 MultiplicationFunction (OperandType amountToMultiplyBy)
 Constructs a MultiplicationFunction.
Overridden from SimpleFunctionObject
OperandType runFunction (OperandType arguement) const
 
Overridden from FunctionObject
std::string getTypeAttributeValue () const
 

Detailed Description

template<class OperandType>
class Teuchos::MultiplicationFunction< OperandType >

A simple function object that multiplys a specififed value from the given arguement in the runFunction function.

Please see the MultiplicationFunctionXMLConverter for details on the XML representation of this fucntion object.

Definition at line 255 of file Teuchos_StandardFunctionObjects.hpp.


Constructor & Destructor Documentation

template<class OperandType >
Teuchos::MultiplicationFunction< OperandType >::MultiplicationFunction ( ) [inline]

Constructs a MultiplicationFunction.

Definition at line 266 of file Teuchos_StandardFunctionObjects.hpp.

template<class OperandType >
Teuchos::MultiplicationFunction< OperandType >::MultiplicationFunction ( OperandType  amountToMultiplyBy) [inline]

Constructs a MultiplicationFunction.

Parameters:
amountToMultiplyByThe amound to be by which the given arguement in the runFunction function should be multiplied.

Definition at line 275 of file Teuchos_StandardFunctionObjects.hpp.


Member Function Documentation

template<class OperandType >
OperandType Teuchos::MultiplicationFunction< OperandType >::runFunction ( OperandType  arguement) const [inline, virtual]
template<class OperandType >
std::string Teuchos::MultiplicationFunction< OperandType >::getTypeAttributeValue ( ) const [inline, virtual]

Implements Teuchos::FunctionObject.

Definition at line 297 of file Teuchos_StandardFunctionObjects.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines