Teuchos_StandardConditions.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER


#ifndef TEUCHOS_STANDARDCONDITION_HPP_
#define TEUCHOS_STANDARDCONDITION_HPP_

#include "Teuchos_Condition.hpp"
#include "Teuchos_InvalidConditionException.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_StandardFunctionObjects.hpp"
#include "Teuchos_DummyObjectGetter.hpp"
#include "Teuchos_ScalarTraits.hpp"


namespace Teuchos{


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ParameterCondition : public Condition{

public:


  ParameterCondition(RCP<const ParameterEntry> parameter);

  virtual ~ParameterCondition(){}




  virtual bool evaluateParameter() const = 0;

  inline RCP<const ParameterEntry> getParameter() const{
    return parameterEntry_.getConst();
  }



  bool isConditionTrue() const{
    return evaluateParameter();
  }

  bool containsAtLeasteOneParameter() const{
    return true;
  }

  Dependency::ConstParameterEntryList getAllParameters() const;


private:


  RCP<const ParameterEntry> parameterEntry_;


};

class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT StringCondition : public ParameterCondition{

public:


  typedef Array<std::string> ValueList;



  StringCondition(RCP<const ParameterEntry> parameter, std::string value);

  StringCondition(RCP<const ParameterEntry> parameter, ValueList values);

  virtual ~StringCondition(){}



  std::string getTypeAttributeValue() const{
    return "StringCondition";
  }



  bool evaluateParameter() const;



    const ValueList& getValueList() const{
      return values_;
    }


private:


  ValueList values_;

  void checkParameterType();


};


template<>
class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DummyObjectGetter<StringCondition>{

public:


  static RCP<StringCondition> getDummyObject();


};


template<class T>
class NumberCondition : public ParameterCondition{

public:


  NumberCondition(
    RCP<const ParameterEntry> parameter,
    RCP<const SimpleFunctionObject<T> > func=null):
    ParameterCondition(parameter),
    func_(func)
  {}

  virtual ~NumberCondition(){}



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



  bool evaluateParameter() const{
    T value = getValue<T>(*getParameter());
    if(!func_.is_null()){
      value = func_->runFunction(value);
    }
    return value > 0;
  }



  RCP<const SimpleFunctionObject<T> > getFunctionObject() const{
    return func_.getConst();
  }


private:


  RCP<const SimpleFunctionObject<T> > func_;


};


template<class T>
class DummyObjectGetter<NumberCondition<T> >{

public:


  static RCP<NumberCondition<T> > getDummyObject();


};

template<class T>
RCP<NumberCondition<T> >
  DummyObjectGetter<NumberCondition<T> >::getDummyObject()
{
  return rcp(new NumberCondition<T>(
    rcp(new ParameterEntry(ScalarTraits<T>::zero()))));
}


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT BoolCondition : public ParameterCondition{

public:


  BoolCondition(RCP<const ParameterEntry> parameter);

  virtual ~BoolCondition(){}



  std::string getTypeAttributeValue() const{
    return "BoolCondition";
  }



  bool evaluateParameter() const;


};


template<>
class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DummyObjectGetter<BoolCondition>{

public:


  static RCP<BoolCondition > getDummyObject();


};


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT BoolLogicCondition : public Condition{

public:


  BoolLogicCondition(ConstConditionList& conditions);

  virtual ~BoolLogicCondition(){}



  void addCondition(RCP<const Condition> toAdd);




  virtual bool applyOperator(bool op1, bool op2) const = 0;

  inline
  const ConstConditionList& getConditions() const{
    return conditions_;
  }



  virtual bool isConditionTrue() const;

  bool containsAtLeasteOneParameter() const;

  Dependency::ConstParameterEntryList getAllParameters() const;


private:


  /*
   * \brief A list of conditions on which to perform some logic operation.
   */
  ConstConditionList conditions_;


};

class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT OrCondition : public BoolLogicCondition{

public:


  OrCondition(ConstConditionList& conditions);

  virtual ~OrCondition(){}



  std::string getTypeAttributeValue() const{
    return "OrCondition";
  }



  bool applyOperator(bool op1, bool op2) const;


};


template<>
class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DummyObjectGetter<OrCondition>{

public:


  static RCP<OrCondition> getDummyObject();


};


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT AndCondition : public BoolLogicCondition{

public:


  AndCondition(ConstConditionList& conditions);

  virtual ~AndCondition(){}



  std::string getTypeAttributeValue() const{
    return "AndCondition";
  }




  bool applyOperator(bool op1, bool op2) const;


};


template<>
class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DummyObjectGetter<AndCondition>{

public:


  static RCP<AndCondition > getDummyObject();


};


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT EqualsCondition : public BoolLogicCondition{

public:


  EqualsCondition(ConstConditionList& conditions);

  virtual ~EqualsCondition(){}



  std::string getTypeAttributeValue() const{
    return "EqualsCondition";
  }



  bool applyOperator(bool op1, bool op2) const;


};


template<>
class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DummyObjectGetter<EqualsCondition>{

public:


  static RCP<EqualsCondition > getDummyObject();


};


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT NotCondition : public Condition{

public:


  NotCondition(RCP<const Condition> condition);

  virtual ~NotCondition(){}



  RCP<const Condition> getChildCondition() const{
    return childCondition_;
  }



  bool isConditionTrue() const;

  bool containsAtLeasteOneParameter() const;

  Dependency::ConstParameterEntryList getAllParameters() const;

  std::string getTypeAttributeValue() const{
    return "NotCondition";
  }


private:


  RCP<const Condition> childCondition_;


};


template<>
class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DummyObjectGetter<NotCondition>{

public:


  static RCP<NotCondition> getDummyObject();


};

} //namespace Teuchos


#endif //TEUCHOS_STANDARDCONDITION_HPP_