treepath.hh

Go to the documentation of this file.

// -*- tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=8 sw=2 sts=2:
// SPDX-FileCopyrightInfo: Copyright © DUNE Project contributors, see file LICENSE.md in module root
// SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception OR LGPL-3.0-or-later

#ifndef DUNE_COMMON_TYPETREE_TREEPATH_HH
#define DUNE_COMMON_TYPETREE_TREEPATH_HH

#include <cstddef>
#include <cassert>
#include <type_traits>

#include <dune/common/documentation.hh>
#include <dune/common/typetraits.hh>
#include <dune/common/indices.hh>

#include <dune/common/hybridmultiindex.hh>


namespace Dune::TypeTree {



  template<typename... T>
  using TreePath = Dune::HybridMultiIndex<T...>;


  template<typename... T>
  requires (((std::is_integral_v<T> or Dune::IsIntegralConstant<T>::value) && ...))
  [[nodiscard]] constexpr auto treePath(const T&... t)
  {
    return HybridMultiIndex(t...);
  }

  // Pull in the free utility function for HybridMultiIndex/TreePath
  // We cannot add forwarding functions of the same name here, since this
  // leads to ambiguous overloads.
  // Unfortunately doxygen ignores documentation for using statements.
  using Dune::back;
  using Dune::front;
  using Dune::push_back;
  using Dune::push_front;
  using Dune::accumulate_back;
  using Dune::accumulate_front;
  using Dune::join;
  using Dune::reverse;
  using Dune::pop_front;
  using Dune::pop_back;

  inline namespace Literals {


  template <char... digits>
  constexpr auto operator""_tp()
  {
    using namespace Dune::Indices::Literals;
    return treePath(operator""_ic<digits...>());
  }

  } // end namespace Literals



} //namespace Dune::TypeTree



#endif // DUNE_TYPETREE_TREEPATH_HH