Sacado_ParameterLibraryBase.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_PARAMETERLIBRARYBASE_HPP
#define SACADO_PARAMETERLIBRARYBASE_HPP

#include <iostream>

#include "Teuchos_Array.hpp"

#include "Sacado_ParameterFamilyBase.hpp"
#include "Sacado_ParameterVectorBase.hpp"
#include "Sacado_mpl_apply.hpp"

namespace Sacado {

  using std::string;

  template <typename FamilyType, typename EntryType>
  class ParameterLibraryBase  {

  protected:

    typedef std::map<string, Teuchos::RCP<FamilyType> > FamilyMap;

  public:

    typedef typename FamilyMap::iterator iterator;

    typedef typename FamilyMap::const_iterator const_iterator;

    ParameterLibraryBase();

    virtual ~ParameterLibraryBase();

    bool isParameter(const std::string& name) const;

    template <typename EvalType>
    bool isParameterForType(const std::string& name) const;


    bool addParameterFamily(const std::string& name, bool supports_ad,
                            bool supports_analytic);



    template <typename EvalType>
    bool addEntry(const std::string& name,
                  const Teuchos::RCP< typename Sacado::mpl::apply<EntryType,EvalType>::type >& entry,
                  const bool allow_overwrite = false);

    template <typename EvalType>
    Teuchos::RCP< typename Sacado::mpl::apply<EntryType,EvalType>::type >
    getEntry(const std::string& name);

    template <typename EvalType>
    Teuchos::RCP< const typename Sacado::mpl::apply<EntryType,EvalType>::type >
    getEntry(const std::string& name) const;

    unsigned int size() const { return library.size(); }

    iterator begin() { return library.begin(); }

    const_iterator begin() const { return library.begin(); }

    iterator end() { return library.end(); }

    const_iterator end() const { return library.end(); }

    template <typename BaseValueType>
    void
    fillVector(const Teuchos::Array<std::string>& names,
               const Teuchos::Array<BaseValueType>& values,
               ParameterVectorBase<FamilyType,BaseValueType>& pv);


    void print(std::ostream& os, bool print_values = false) const;

    void clear() { library = FamilyMap(); }

  private:

    ParameterLibraryBase(const ParameterLibraryBase&);

    ParameterLibraryBase& operator = (const ParameterLibraryBase&);

  protected:

    FamilyMap library;
  };

  template <typename FamilyType, typename EntryType>
  std::ostream&
  operator << (std::ostream& os,
               const ParameterLibraryBase<FamilyType, EntryType>& pl)
  {
    pl.print(os);
    return os;
  }
}

// Include template definitions
#include "Sacado_ParameterLibraryBaseImp.hpp"

#endif