Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Teuchos_StandardFunctionObjects.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Teuchos: Common Tools Package
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef Teuchos_STANDARD_FUNCTION_OBJECTS_H
43#define Teuchos_STANDARD_FUNCTION_OBJECTS_H
44
50
51
52namespace Teuchos{
53
58template<class OperandType>
127
136template<class OperandType>
138 public SimpleFunctionObject<OperandType>
139{
140public:
142
143
148
157
159
161
162
170
172
174
175
177 std::string getTypeAttributeValue() const{
178 return
179 "SubtractionFunction("
181 +")";
182 }
183
185};
186
195template<class OperandType>
197 public SimpleFunctionObject<OperandType>
198{
199public:
201
202
207
216
218
220
221
229
231
233
234
236 std::string getTypeAttributeValue() const{
237 return
238 "AdditionFunction("
240 +")";
241 }
242
244};
245
254template<class OperandType>
256 public SimpleFunctionObject<OperandType>
257{
258public:
260
261
267
277
279
281
282
290
292
294
295
297 std::string getTypeAttributeValue() const{
298 return "MultiplicationFunction(" +
300 +")";
301 }
302
304};
305
314template<class OperandType>
316 public SimpleFunctionObject<OperandType>
317{
318public:
319
321
322
328
338
340
342
343
351
353
355
356
358 std::string getTypeAttributeValue() const{
359 return
360 "DivisionFunction("
362 +")";
363 }
364
366
367};
368
369} // namespace Teuchos
370
371
372#endif
An object representation of a function.
A simple function object that adds a specififed value from the given arguement in the runFunction fun...
AdditionFunction(OperandType amountToAdd)
Constructs a AdditionFunction.
OperandType runFunction(OperandType arguement) const
AdditionFunction()
Constructs a AdditionFunction.
A simple function object that divides a specififed value from the given arguement in the runFunction ...
DivisionFunction(OperandType amountToDivideBy)
Constructs a DivisionFunction.
OperandType runFunction(OperandType arguement) const
DivisionFunction()
Constructs a DivisionFunction.
A function object represents an arbitrary function.
A simple function object that multiplys a specififed value from the given arguement in the runFunctio...
MultiplicationFunction(OperandType amountToMultiplyBy)
Constructs a MultiplicationFunction.
OperandType runFunction(OperandType arguement) const
MultiplicationFunction()
Constructs a MultiplicationFunction.
Concrete serial communicator subclass.
A simple function object that applies a given operand to a spcified arguement using a specific operat...
virtual OperandType runFunction(OperandType arguement) const =0
SimpleFunctionObject()
Constructs a SimpleFunctionObject.
OperandType getModifiyingOperand() const
Returns the modifying operand.
OperandType setModifyingOperand(OperandType newOperand)
Sets the modifyingOperand.
OperandType _modifyingOperand
The modifying operand.
SimpleFunctionObject(OperandType modifyingOperand)
Constructs a SimpleFunctionObject.
A simple function object that subtracts a specififed value from the given arguement in the runFunctio...
SubtractionFunction()
Constructs a SubtractionFunction.
SubtractionFunction(OperandType amountToSubtract)
Constructs a SubtractionFunction.
OperandType runFunction(OperandType arguement) const