Sacado_ScalarParameterFamily.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_SCALARPARAMETERFAMILY_HPP
#define SACADO_SCALARPARAMETERFAMILY_HPP

#include "Sacado_ParameterFamilyBase.hpp"
#include "Sacado_ScalarParameterEntry.hpp"

namespace Sacado {

  using namespace mpl::placeholders;

  template <typename EvalTypeTraits = DefaultEvalTypeTraits>
  class ScalarParameterFamily :
    public Sacado::ParameterFamilyBase<AbstractScalarParameterEntry,
                                       ScalarParameterEntry<_,EvalTypeTraits> >
  {

    typedef Sacado::ParameterFamilyBase<AbstractScalarParameterEntry,
                                        ScalarParameterEntry<_,EvalTypeTraits> >  BaseT;

  public:

    ScalarParameterFamily(const std::string& name_,
                          bool supports_ad_,
                          bool supports_analytic_) :
      BaseT(name_, supports_ad_, supports_analytic_) {}


    virtual ~ScalarParameterFamily() {}

    void setRealValueForAllTypes(double value) {
      for (typename BaseT::iterator it = this->family.begin();
           it != this->family.end(); ++it)
        (*it).second->setRealValue(value);
    }

    template <class EvalType>
    void
    setRealValue(double value)
    {
      this->template getEntry<EvalType>()->setRealValue(value);
    }

    template <class EvalType>
    void
    setValue(const typename EvalTypeTraits::template apply<EvalType>::type& value)
    {
      this->template getEntry<EvalType>()->setValue(value);
    }

    template <class EvalType>
    double
    getRealValue() const
    {
      return this->template getEntry<EvalType>()->getRealValue();
    }

    template <class EvalType>
    const typename EvalTypeTraits::template apply<EvalType>::type&
    getValue() const
    {
      return this->template getEntry<EvalType>()->getValue();
    }


  private:

    ScalarParameterFamily(const ScalarParameterFamily&);

    ScalarParameterFamily& operator = (const ScalarParameterFamily&);

  };

  template <typename EvalType, typename EvalTypeTraits>
  typename Sacado::ScalarParameterEntry<EvalType>::ScalarT
  getValue(const ScalarParameterFamily<EvalTypeTraits>& spf)
  {
    return spf.template getValue<EvalType>();
  }

} // namespace Sacado

#endif