Teuchos::DivisionFunction< OperandType > Class Template Reference

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

#include <Teuchos_StandardFunctionObjects.hpp>

Inheritance diagram for Teuchos::DivisionFunction< OperandType >:

List of all members.

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

---

Detailed Description

template<class OperandType>
class Teuchos::DivisionFunction< OperandType >

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

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

Definition at line 315 of file Teuchos_StandardFunctionObjects.hpp.

---

Constructor & Destructor Documentation

template<class OperandType >

Teuchos::DivisionFunction< OperandType >::DivisionFunction

(

)

[inline]

Constructs a DivisionFunction.

Definition at line 327 of file Teuchos_StandardFunctionObjects.hpp.

template<class OperandType >

Teuchos::DivisionFunction< OperandType >::DivisionFunction

(

OperandType

amountToDivideBy

)

[inline]

Constructs a DivisionFunction.

Parameters:

amoundToDivideBy

The amound to be by which the given arguement in the runFunction function should be divided.

Definition at line 336 of file Teuchos_StandardFunctionObjects.hpp.

---

Member Function Documentation

template<class OperandType >

OperandType Teuchos::DivisionFunction< OperandType >::runFunction

(

OperandType

arguement

)

const [inline, virtual]

Implements Teuchos::SimpleFunctionObject< OperandType >.

Definition at line 345 of file Teuchos_StandardFunctionObjects.hpp.

template<class OperandType >

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

(

)

const [inline, virtual]

Implements Teuchos::FunctionObject.

Definition at line 358 of file Teuchos_StandardFunctionObjects.hpp.

---

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

• Teuchos_StandardFunctionObjects.hpp