| Teuchos - Trilinos Tools Package
    Version of the Day
    | 
A simple function object that applies a given operand to a spcified arguement using a specific operator. More...
#include <Teuchos_StandardFunctionObjects.hpp>
 
  
 | Public Member Functions | |
| virtual OperandType | runFunction (OperandType arguement) const =0 | 
| 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... | |
|  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... | |
| 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 verbLevelargument of describe().  More... | |
|  Related Functions inherited from Teuchos::Describable | |
| DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) | 
| Describable output stream manipulator.  More... | |
| std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) | 
| Output stream operator for Describable manipulator.  More... | |
A simple function object that applies a given operand to a spcified arguement using a specific operator.
Definition at line 27 of file Teuchos_StandardFunctionObjects.hpp.
| 
 | inline | 
Constructs a SimpleFunctionObject.
Definition at line 38 of file Teuchos_StandardFunctionObjects.hpp.
| 
 | inline | 
Constructs a SimpleFunctionObject.
| modifyingOperand | The operand that will be modifying the arguement given in the runFuction function. | 
Definition at line 47 of file Teuchos_StandardFunctionObjects.hpp.
| 
 | pure virtual | 
Runs the desired function on the arguement and returns the result.
| arguement | Arguement on which the function should be run. | 
Implemented in Teuchos::DivisionFunction< OperandType >, Teuchos::MultiplicationFunction< OperandType >, Teuchos::AdditionFunction< OperandType >, and Teuchos::SubtractionFunction< OperandType >.
| 
 | inline | 
Returns the modifying operand.
Definition at line 68 of file Teuchos_StandardFunctionObjects.hpp.
| 
 | inline | 
Sets the modifyingOperand.
| newOperand | The new modifyingOperand to use. | 
Definition at line 78 of file Teuchos_StandardFunctionObjects.hpp.
 1.8.5
 1.8.5