Teuchos::SubtractionFunction< OperandType > Class Template Reference

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

#include <Teuchos_StandardFunctionObjects.hpp>

Inheritance diagram for Teuchos::SubtractionFunction< OperandType >:

List of all members.

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

---

Detailed Description

template<class OperandType>
class Teuchos::SubtractionFunction< OperandType >

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

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

Definition at line 137 of file Teuchos_StandardFunctionObjects.hpp.

---

Constructor & Destructor Documentation

template<class OperandType >

Teuchos::SubtractionFunction< OperandType >::SubtractionFunction

(

)

[inline]

Constructs a SubtractionFunction.

Definition at line 147 of file Teuchos_StandardFunctionObjects.hpp.

template<class OperandType >

Teuchos::SubtractionFunction< OperandType >::SubtractionFunction

(

OperandType

amountToSubtract

)

[inline]

Constructs a SubtractionFunction.

Parameters:

amountToSubtract

The amound to be subtracted from a given arguement in the runFunction function.

Definition at line 155 of file Teuchos_StandardFunctionObjects.hpp.

---

Member Function Documentation

template<class OperandType >

OperandType Teuchos::SubtractionFunction< OperandType >::runFunction

(

OperandType

arguement

)

const [inline, virtual]

Implements Teuchos::SimpleFunctionObject< OperandType >.

Definition at line 164 of file Teuchos_StandardFunctionObjects.hpp.

template<class OperandType >

std::string Teuchos::SubtractionFunction< OperandType >::getTypeAttributeValue

(

)

const [inline, virtual]

Implements Teuchos::FunctionObject.

Definition at line 177 of file Teuchos_StandardFunctionObjects.hpp.

---

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

• Teuchos_StandardFunctionObjects.hpp