Sacado_ScalarParameterEntry.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                           Sacado Package
//                 Copyright (2006) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
// USA
// Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
// (etphipp@sandia.gov).
//
// ***********************************************************************
// @HEADER

#ifndef SACADO_SCALARPARAMETERENTRY_HPP
#define SACADO_SCALARPARAMETERENTRY_HPP

#include "Sacado_Traits.hpp"
#include "Sacado_mpl_apply.hpp"

namespace Sacado {


  struct DefaultEvalTypeTraits {
    template <class EvalType> struct apply {
      typedef EvalType type; };
  };

  class AbstractScalarParameterEntry {
  public:

    AbstractScalarParameterEntry() {}

    virtual ~AbstractScalarParameterEntry() {}

    virtual void setRealValue(double value) = 0;

    virtual double getRealValue() const = 0;

    virtual void print(std::ostream& os) const = 0;
  };

  template <typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>
  class ScalarParameterEntry : public AbstractScalarParameterEntry {

  public:

    typedef typename EvalTypeTraits::template apply<EvalType>::type ScalarT;

    ScalarParameterEntry() {}

    virtual ~ScalarParameterEntry() {}


    virtual void setValue(const ScalarT& value) = 0;

    virtual const ScalarT& getValue() const = 0;


    virtual double getRealValue() const {
      return Sacado::ScalarValue<ScalarT>::eval(this->getValue());
    }


    virtual void print(std::ostream& os) const {
      os << getValue();
    }

  };
}

#endif