placeholder.hpp

Go to the documentation of this file.

// Copyright (c) 2019-2023 Simons Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0.txt
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Authors: Olivier Parcollet, Nils Wentzell
 
#pragma once
 
#include "./expression.hpp"
#include "./utils.hpp"
 
#include <type_traits>
#include <utility>
 
namespace nda::clef {
 
  // Forward declarations.
  template <int N, typename T>
  struct pair;
 
  template <int N>
  struct placeholder {
    static_assert(N >= 0 && N < 64, "Placeholder index must be in {0, 1, ..., 63}");
 
    static constexpr int index = N;
 
    template <typename RHS>
    pair<N, RHS> operator=(RHS &&rhs) const { // NOLINT (we want to return a pair)
      return {std::forward<RHS>(rhs)};
    }
 
    template <typename... Args>
    auto operator()(Args &&...args) const {
      return expr<tags::function, placeholder, expr_storage_t<Args>...>{tags::function{}, *this, std::forward<Args>(args)...};
    }
 
    template <typename T>
    auto operator[](T &&t) const {
      return expr<tags::subscript, placeholder, expr_storage_t<T>>{tags::subscript{}, *this, std::forward<T>(t)};
    }
  };
 
  template <int N, typename T>
  struct pair {
    T rhs;
 
    static constexpr int p = N;
 
    using value_type = std::decay_t<T>;
  };
 
  namespace detail {
 
    // Specialization of force_copy_in_expr_impl for nda::clef::placeholder types (always true).
    template <int N>
    constexpr bool force_copy_in_expr_impl<placeholder<N>> = true;
 
    // Specialization of ph_set for nda::clef::placeholder types.
    template <int N>
    struct ph_set<placeholder<N>> {
      static constexpr ull_t value = 1ull << N;
    };
 
    // Specialization of ph_set for nda::clef::pair types.
    template <int N, typename T>
    struct ph_set<pair<N, T>> : ph_set<placeholder<N>> {};
 
    // Specialization of is_lazy_impl for nda::clef::placeholder types.
    template <int N>
    constexpr bool is_lazy_impl<placeholder<N>> = true;
 
  } // namespace detail
 
} // namespace nda::clef