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

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

#include <Teuchos_StandardFunctionObjects.hpp>

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

List of all members.

Public Member Functions

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

Detailed Description

template<class OperandType>
class Teuchos::AdditionFunction< OperandType >

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

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

Definition at line 196 of file Teuchos_StandardFunctionObjects.hpp.


Constructor & Destructor Documentation

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

Constructs a AdditionFunction.

Definition at line 206 of file Teuchos_StandardFunctionObjects.hpp.

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

Constructs a AdditionFunction.

Parameters:
amountToAddThe amound to be added to a given arguement in the runFunction function.

Definition at line 214 of file Teuchos_StandardFunctionObjects.hpp.


Member Function Documentation

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

Implements Teuchos::FunctionObject.

Definition at line 236 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