Sacado_ScalarParameterEntry.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                           Sacado Package
//
// Copyright 2006 NTESS and the Sacado contributors.
// SPDX-License-Identifier: LGPL-2.1-or-later
// *****************************************************************************
// @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