Teuchos::SimpleFunctionObject< OperandType > Class Template Reference

A simple function object that applies a given operand to a spcified arguement using a specific operator. More...

#include <Teuchos_StandardFunctionObjects.hpp>

Inheritance diagram for Teuchos::SimpleFunctionObject< OperandType >:

List of all members.

Public Member Functions
virtual OperandType	runFunction (OperandType arguement) const =0
Constructors/Destructors
	SimpleFunctionObject ()
	Constructs a SimpleFunctionObject.
	SimpleFunctionObject (OperandType modifyingOperand)
	Constructs a SimpleFunctionObject.
Getters/Setters
OperandType	getModifiyingOperand () const
	Returns the modifying operand.
OperandType	setModifyingOperand (OperandType newOperand)
	Sets the modifyingOperand.

---

Detailed Description

template<class OperandType>
class Teuchos::SimpleFunctionObject< OperandType >

A simple function object that applies a given operand to a spcified arguement using a specific operator.

Definition at line 59 of file Teuchos_StandardFunctionObjects.hpp.

---

Constructor & Destructor Documentation

template<class OperandType>

Teuchos::SimpleFunctionObject< OperandType >::SimpleFunctionObject

(

)

[inline]

Constructs a SimpleFunctionObject.

Definition at line 70 of file Teuchos_StandardFunctionObjects.hpp.

template<class OperandType>

Teuchos::SimpleFunctionObject< OperandType >::SimpleFunctionObject

(

OperandType

modifyingOperand

)

[inline]

Constructs a SimpleFunctionObject.

Parameters:

modifyingOperand

The operand that will be modifying the arguement given in the runFuction function.

Definition at line 79 of file Teuchos_StandardFunctionObjects.hpp.

---

Member Function Documentation

template<class OperandType>

virtual OperandType Teuchos::SimpleFunctionObject< OperandType >::runFunction

(

OperandType

arguement

)

const [pure virtual]

Runs the desired function on the arguement and returns the result.

Parameters:

arguement

Arguement on which the function should be run.

Returns:

The result of running the function on the give arguement.

Implemented in Teuchos::DivisionFunction< OperandType >, Teuchos::MultiplicationFunction< OperandType >, Teuchos::AdditionFunction< OperandType >, and Teuchos::SubtractionFunction< OperandType >.

template<class OperandType>

OperandType Teuchos::SimpleFunctionObject< OperandType >::getModifiyingOperand

(

)

const [inline]

Returns the modifying operand.

Definition at line 100 of file Teuchos_StandardFunctionObjects.hpp.

template<class OperandType>

OperandType Teuchos::SimpleFunctionObject< OperandType >::setModifyingOperand

(

OperandType

newOperand

)

[inline]

Sets the modifyingOperand.

Parameters:

newOperand

The new modifyingOperand to use.

Definition at line 110 of file Teuchos_StandardFunctionObjects.hpp.

---

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

• Teuchos_StandardFunctionObjects.hpp