Teuchos_StandardFunctionObjects.hpp

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef Teuchos_STANDARD_FUNCTION_OBJECTS_H
#define Teuchos_STANDARD_FUNCTION_OBJECTS_H

#include "Teuchos_FunctionObject.hpp"


namespace Teuchos{

template<class OperandType>
class SimpleFunctionObject : public FunctionObject
{
public:



  SimpleFunctionObject():
    FunctionObject(){}

  SimpleFunctionObject(OperandType modifyingOperand):
    FunctionObject(),
    _modifyingOperand(modifyingOperand){}


  virtual OperandType runFunction(OperandType arguement) const=0;



  inline OperandType getModifiyingOperand() const{
    return _modifyingOperand;
  }

  inline OperandType setModifyingOperand(OperandType newOperand){
    _modifyingOperand = newOperand;
  }


private:


  OperandType _modifyingOperand;

};

template<class OperandType>
class SubtractionFunction :
  public SimpleFunctionObject<OperandType>
{
public:


  SubtractionFunction():SimpleFunctionObject<OperandType>(){}

  SubtractionFunction(OperandType amountToSubtract):
    SimpleFunctionObject<OperandType>(amountToSubtract){}




  OperandType runFunction(OperandType arguement) const{
    return
      arguement
      -
      SimpleFunctionObject<OperandType>::getModifiyingOperand();
  }




  std::string getTypeAttributeValue() const{
    return
      "SubtractionFunction("
      + TypeNameTraits<OperandType>::name()
      +")";
  }

};

template<class OperandType>
class AdditionFunction :
  public SimpleFunctionObject<OperandType>
{
public:


  AdditionFunction():SimpleFunctionObject<OperandType>(){}

  AdditionFunction(OperandType amountToAdd):
    SimpleFunctionObject<OperandType>(amountToAdd){}




  OperandType runFunction(OperandType arguement) const{
    return
      arguement
      +
      SimpleFunctionObject<OperandType>::getModifiyingOperand();
  }




  std::string getTypeAttributeValue() const{
    return
      "AdditionFunction("
      + TypeNameTraits<OperandType>::name()
      +")";
  }

};

template<class OperandType>
class MultiplicationFunction :
  public SimpleFunctionObject<OperandType>
{
public:


  MultiplicationFunction():SimpleFunctionObject<OperandType>(){}

  MultiplicationFunction(OperandType amountToMultiplyBy):
    SimpleFunctionObject<OperandType>(amountToMultiplyBy){}




  OperandType runFunction(OperandType arguement) const{
    return
      arguement
      *
      SimpleFunctionObject<OperandType>::getModifiyingOperand();
  }




  std::string getTypeAttributeValue() const{
    return "MultiplicationFunction(" +
      TypeNameTraits<OperandType>::name()
      +")";
  }

};

template<class OperandType>
class DivisionFunction :
  public SimpleFunctionObject<OperandType>
{
public:



  DivisionFunction():SimpleFunctionObject<OperandType>(){}

  DivisionFunction(OperandType amountToDivideBy):
    SimpleFunctionObject<OperandType>(amountToDivideBy){}




  OperandType runFunction(OperandType arguement) const{
    return
      arguement
      /
      SimpleFunctionObject<OperandType>::getModifiyingOperand();
  }




  std::string getTypeAttributeValue() const{
    return
      "DivisionFunction("
      + TypeNameTraits<OperandType>::name()
      +")";
  }


};

} // namespace Teuchos


#endif