Teuchos Package Browser (Single Doxygen Collection)
Version of the Day
|
A simple function object that subtracts a specififed value from the given arguement in the runFunction function. More...
#include <Teuchos_StandardFunctionObjects.hpp>
Constructors/Destructors | |
SubtractionFunction () | |
Constructs a SubtractionFunction. More... | |
SubtractionFunction (OperandType amountToSubtract) | |
Constructs a SubtractionFunction. More... | |
Overridden from SimpleFunctionObject | |
OperandType | runFunction (OperandType arguement) const |
Overridden from FunctionObject | |
std::string | getTypeAttributeValue () const |
Additional Inherited Members | |
Public Member Functions inherited from Teuchos::SimpleFunctionObject< OperandType > | |
SimpleFunctionObject () | |
Constructs a SimpleFunctionObject. More... | |
SimpleFunctionObject (OperandType modifyingOperand) | |
Constructs a SimpleFunctionObject. More... | |
OperandType | getModifiyingOperand () const |
Returns the modifying operand. More... | |
OperandType | setModifyingOperand (OperandType newOperand) |
Sets the modifyingOperand. More... | |
Public Member Functions inherited from Teuchos::FunctionObject | |
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... | |
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... | |
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 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.
|
inline |
Constructs a SubtractionFunction.
Definition at line 147 of file Teuchos_StandardFunctionObjects.hpp.
|
inline |
Constructs a SubtractionFunction.
amountToSubtract | The amound to be subtracted from a given arguement in the runFunction function. |
Definition at line 155 of file Teuchos_StandardFunctionObjects.hpp.
|
inlinevirtual |
Implements Teuchos::SimpleFunctionObject< OperandType >.
Definition at line 164 of file Teuchos_StandardFunctionObjects.hpp.
|
inlinevirtual |
Implements Teuchos::FunctionObject.
Definition at line 177 of file Teuchos_StandardFunctionObjects.hpp.