mult.h

Go to the documentation of this file.

/*
 *  This file is a part of TiledArray.
 *  Copyright (C) 2013  Virginia Tech
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  Justus Calvin
 *  Department of Chemistry, Virginia Tech
 *
 *  mult.h
 *  May 8, 2013
 *
 */
 
#ifndef TILEDARRAY_TILE_OP_MULT_H__INCLUDED
#define TILEDARRAY_TILE_OP_MULT_H__INCLUDED
 
#include <TiledArray/error.h>
#include <TiledArray/tile_op/tile_interface.h>
#include <TiledArray/util/function.h>
#include <TiledArray/zero_tensor.h>
 
namespace TiledArray {
namespace detail {
 
 
template <typename Result, typename Left, typename Right, bool LeftConsumable,
          bool RightConsumable>
class Mult {
 public:
  typedef Mult<Result, Left, Right, LeftConsumable, RightConsumable> Mult_;
  typedef Left left_type;      
  typedef Right right_type;    
  typedef Result result_type;  
 
  using left_value_type = typename left_type::value_type;
  using right_value_type = typename right_type::value_type;
  using result_value_type = typename result_type::value_type;
  using element_op_type = result_value_type(const left_value_type&,
                                            const right_value_type&);
 
  static constexpr bool left_is_consumable =
      LeftConsumable && std::is_same<result_type, left_type>::value;
  static constexpr bool right_is_consumable =
      RightConsumable && std::is_same<result_type, right_type>::value;
 
 private:
  TiledArray::function_ref<element_op_type> element_op_;
 
  // Permuting tile evaluation function
  // These operations cannot consume the argument tile since this operation
  // requires temporary storage space.
  template <typename Perm, typename = std::enable_if_t<
                               TiledArray::detail::is_permutation_v<Perm>>>
  result_type eval(const left_type& first, const right_type& second,
                   const Perm& perm) const {
    if (!element_op_) {
      using TiledArray::mult;
      return mult(first, second, perm);
    } else {
      using TiledArray::binary;
      return binary(first, second, element_op_, perm);
    }
  }
 
  template <typename Perm, typename = std::enable_if_t<
                               TiledArray::detail::is_permutation_v<Perm>>>
  result_type eval(ZeroTensor, const right_type& second,
                   const Perm& perm) const {
    TA_ASSERT(false);  // Invalid arguments for this operation
    return result_type();
  }
 
  template <typename Perm, typename = std::enable_if_t<
                               TiledArray::detail::is_permutation_v<Perm>>>
  result_type eval(const left_type& first, ZeroTensor, const Perm& perm) const {
    TA_ASSERT(false);  // Invalid arguments for this operation
    return result_type();
  }
 
  // Non-permuting tile evaluation functions
  // The compiler will select the correct functions based on the
  // consumability of the arguments.
 
  template <bool LC, bool RC,
            typename std::enable_if<!(LC || RC)>::type* = nullptr>
  result_type eval(const left_type& first, const right_type& second) const {
    if (!element_op_) {
      using TiledArray::mult;
      return mult(first, second);
    } else {
      using TiledArray::binary;
      return binary(first, second, element_op_);
    }
  }
 
  template <bool LC, bool RC, typename std::enable_if<LC>::type* = nullptr>
  result_type eval(left_type& first, const right_type& second) const {
    TA_ASSERT(!element_op_);
    using TiledArray::mult_to;
    return mult_to(first, second);
  }
 
  template <bool LC, bool RC,
            typename std::enable_if<!LC && RC>::type* = nullptr>
  result_type eval(const left_type& first, right_type& second) const {
    TA_ASSERT(!element_op_);
    using TiledArray::mult_to;
    return mult_to(second, first);
  }
 
  template <bool LC, bool RC, typename std::enable_if<!RC>::type* = nullptr>
  result_type eval(ZeroTensor, const right_type& second) const {
    TA_ASSERT(false);  // Invalid arguments for this operation
    return result_type();
  }
 
  template <bool LC, bool RC, typename std::enable_if<RC>::type* = nullptr>
  result_type eval(ZeroTensor, right_type& second) const {
    TA_ASSERT(false);  // Invalid arguments for this operation
    return result_type();
  }
 
  template <bool LC, bool RC, typename std::enable_if<!LC>::type* = nullptr>
  result_type eval(const left_type& first, ZeroTensor) const {
    TA_ASSERT(false);  // Invalid arguments for this operation
    return result_type();
  }
 
  template <bool LC, bool RC, typename std::enable_if<LC>::type* = nullptr>
  result_type eval(left_type& first, ZeroTensor) const {
    TA_ASSERT(false);  // Invalid arguments for this operation
    return result_type();
  }
 
 public:
  Mult() = default;
  template <typename ElementOp,
            typename = std::enable_if_t<
                !std::is_same_v<std::remove_reference_t<ElementOp>, Mult_> &&
                std::is_invocable_r_v<
                    result_value_type, std::remove_reference_t<ElementOp>,
                    const left_value_type&, const right_value_type&>>>
  explicit Mult(ElementOp&& op) : element_op_(std::forward<ElementOp>(op)) {}
 
 
  template <
      typename L, typename R, typename Perm,
      typename = std::enable_if_t<TiledArray::detail::is_permutation_v<Perm>>>
  result_type operator()(L&& left, R&& right, const Perm& perm) const {
    return eval(std::forward<L>(left), std::forward<R>(right), perm);
  }
 
 
  template <typename L, typename R>
  result_type operator()(L&& left, R&& right) const {
    return Mult_::template eval<left_is_consumable, right_is_consumable>(
        std::forward<L>(left), std::forward<R>(right));
  }
 
 
  template <typename R>
  result_type consume_left(left_type& left, R&& right) const {
    constexpr bool can_consume_left =
        is_consumable_tile<left_type>::value &&
        std::is_same<result_type, left_type>::value;
    constexpr bool can_consume_right =
        right_is_consumable && !(std::is_const<R>::value || can_consume_left);
    return Mult_::template eval<can_consume_left, can_consume_right>(
        left, std::forward<R>(right));
  }
 
 
  template <typename L>
  result_type consume_right(L&& left, right_type& right) const {
    constexpr bool can_consume_right =
        is_consumable_tile<right_type>::value &&
        std::is_same<result_type, right_type>::value;
    constexpr bool can_consume_left =
        left_is_consumable && !(std::is_const<L>::value || can_consume_right);
    return Mult_::template eval<can_consume_left, can_consume_right>(
        std::forward<L>(left), right);
  }
 
};  // class Mult
 
 
template <typename Result, typename Left, typename Right, typename Scalar,
          bool LeftConsumable, bool RightConsumable>
class ScalMult {
 public:
  typedef ScalMult<Result, Left, Right, Scalar, LeftConsumable,
                   RightConsumable>
      ScalMult_;               
  typedef Left left_type;      
  typedef Right right_type;    
  typedef Scalar scalar_type;  
  typedef Result result_type;  
 
  static constexpr bool left_is_consumable =
      LeftConsumable && std::is_same<result_type, left_type>::value;
  static constexpr bool right_is_consumable =
      RightConsumable && std::is_same<result_type, right_type>::value;
 
 private:
  scalar_type factor_;  
 
  // Permuting tile evaluation function
  // These operations cannot consume the argument tile since this operation
  // requires temporary storage space.
 
  template <typename Perm, typename = std::enable_if_t<
                               TiledArray::detail::is_permutation_v<Perm>>>
  result_type eval(const left_type& first, const right_type& second,
                   const Perm& perm) const {
    using TiledArray::mult;
    return mult(first, second, factor_, perm);
  }
 
  template <typename Perm, typename = std::enable_if_t<
                               TiledArray::detail::is_permutation_v<Perm>>>
  result_type eval(ZeroTensor, const right_type& second,
                   const Perm& perm) const {
    TA_ASSERT(false);  // Invalid arguments for this operation
    return result_type();
  }
 
  template <typename Perm, typename = std::enable_if_t<
                               TiledArray::detail::is_permutation_v<Perm>>>
  result_type eval(const left_type& first, ZeroTensor, const Perm& perm) const {
    TA_ASSERT(false);  // Invalid arguments for this operation
    return result_type();
  }
 
  // Non-permuting tile evaluation functions
  // The compiler will select the correct functions based on the
  // consumability of the arguments.
 
  template <bool LC, bool RC,
            typename std::enable_if<!(LC || RC)>::type* = nullptr>
  result_type eval(const left_type& first, const right_type& second) const {
    using TiledArray::mult;
    return mult(first, second, factor_);
  }
 
  template <bool LC, bool RC, typename std::enable_if<LC>::type* = nullptr>
  result_type eval(left_type& first, const right_type& second) const {
    using TiledArray::mult_to;
    return mult_to(first, second, factor_);
  }
 
  template <bool LC, bool RC,
            typename std::enable_if<!LC && RC>::type* = nullptr>
  result_type eval(const left_type& first, right_type& second) const {
    using TiledArray::mult_to;
    return mult_to(second, first, factor_);
  }
 
  template <bool LC, bool RC, typename std::enable_if<!RC>::type* = nullptr>
  result_type eval(ZeroTensor, const right_type& second) const {
    TA_ASSERT(false);  // Invalid arguments for this operation
    return result_type();
  }
 
  template <bool LC, bool RC, typename std::enable_if<RC>::type* = nullptr>
  result_type eval(ZeroTensor, right_type& second) const {
    TA_ASSERT(false);  // Invalid arguments for this operation
    return result_type();
  }
 
  template <bool LC, bool RC, typename std::enable_if<!LC>::type* = nullptr>
  result_type eval(const left_type& first, ZeroTensor) const {
    TA_ASSERT(false);  // Invalid arguments for this operation
    return result_type();
  }
 
  template <bool LC, bool RC, typename std::enable_if<LC>::type* = nullptr>
  result_type eval(left_type& first, ZeroTensor) const {
    TA_ASSERT(false);  // Invalid arguments for this operation
    return result_type();
  }
 
 public:
  // Compiler generated functions
  ScalMult(const ScalMult_&) = default;
  ScalMult(ScalMult_&&) = default;
  ~ScalMult() = default;
  ScalMult_& operator=(const ScalMult_&) = default;
  ScalMult_& operator=(ScalMult_&&) = default;
 
 
  explicit ScalMult(const Scalar factor) : factor_(factor) {}
 
 
  template <
      typename L, typename R, typename Perm,
      typename = std::enable_if_t<TiledArray::detail::is_permutation_v<Perm>>>
  result_type operator()(L&& left, R&& right, const Perm& perm) const {
    return eval(std::forward<L>(left), std::forward<R>(right), perm);
  }
 
 
  template <typename L, typename R>
  result_type operator()(L&& left, R&& right) const {
    return ScalMult_::template eval<left_is_consumable, right_is_consumable>(
        std::forward<L>(left), std::forward<R>(right));
  }
 
 
  template <typename R>
  result_type consume_left(left_type& left, R&& right) const {
    constexpr bool can_consume_left =
        is_consumable_tile<left_type>::value &&
        std::is_same<result_type, left_type>::value;
    constexpr bool can_consume_right =
        right_is_consumable && !(std::is_const<R>::value || can_consume_left);
    return ScalMult_::template eval<can_consume_left, can_consume_right>(
        left, std::forward<R>(right));
  }
 
 
  template <typename L>
  result_type consume_right(L&& left, right_type& right) const {
    constexpr bool can_consume_right =
        is_consumable_tile<right_type>::value &&
        std::is_same<result_type, right_type>::value;
    constexpr bool can_consume_left =
        left_is_consumable && !(std::is_const<L>::value || can_consume_right);
    return ScalMult_::template eval<can_consume_left, can_consume_right>(
        std::forward<L>(left), right);
  }
 
};  // class ScalMult
 
}  // namespace detail
}  // namespace TiledArray
 
#endif  // TILEDARRAY_TILE_OP_MULT_H__INCLUDED