Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Teuchos::SimpleFunctionObject< OperandType > Class Template Referenceabstract

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 >:
Inheritance graph
[legend]

Public Member Functions

virtual OperandType runFunction (OperandType arguement) const =0
 
- Public Member Functions inherited from Teuchos::FunctionObject
virtual std::string getTypeAttributeValue () const =0
 Returns the string to be used for the value of the type attribute when converting the function to XML. More...
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 Return a simple one-line description of this object. More...
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream. More...
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Version of describe() that takes an std::ostream instead of a FancyOStream. More...
 
virtual ~Describable ()
 Destructor (marked virtual for memory safety of derived classes). More...
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 Construct with an empty label. More...
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 Set the object label (see LabeledObject). More...
 
virtual std::string getObjectLabel () const
 Get the object label (see LabeledObject). More...
 

Constructors/Destructors

 SimpleFunctionObject ()
 Constructs a SimpleFunctionObject. More...
 
 SimpleFunctionObject (OperandType modifyingOperand)
 Constructs a SimpleFunctionObject. More...
 

Getters/Setters

OperandType getModifiyingOperand () const
 Returns the modifying operand. More...
 
OperandType setModifyingOperand (OperandType newOperand)
 Sets the modifyingOperand. More...
 

Private Members

OperandType _modifyingOperand
 The modifying operand. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Teuchos::FunctionObject
static const std::string & getXMLTagName ()
 Returns the name of the XML tag used to indicate a funciton object. More...
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe(). More...
 

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
modifyingOperandThe 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
arguementArguement 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
newOperandThe new modifyingOperand to use.

Definition at line 110 of file Teuchos_StandardFunctionObjects.hpp.

Member Data Documentation

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

The modifying operand.

Definition at line 123 of file Teuchos_StandardFunctionObjects.hpp.


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