blk_tsr_engine.h

Go to the documentation of this file.

/*
 *  This file is a part of TiledArray.
 *  Copyright (C) 2015  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
 *
 *  blk_tsr_engine.h
 *  May 20, 2015
 *
 */
 
#ifndef TILEDARRAY_EXPRESSIONS_BLK_TSR_ENGINE_H__INCLUDED
#define TILEDARRAY_EXPRESSIONS_BLK_TSR_ENGINE_H__INCLUDED
 
#include <TiledArray/expressions/leaf_engine.h>
#include <TiledArray/tile_op/shift.h>
 
namespace TiledArray {
 
// Forward declaration
template <typename, typename>
class DistArray;
 
namespace expressions {
 
// Forward declaration
template <typename, bool>
class BlkTsrExpr;
template <typename, typename>
class ScalBlkTsrExpr;
template <typename, typename, bool>
class BlkTsrEngine;
template <typename, typename, typename>
class ScalBlkTsrEngine;
 
template <typename Tile, typename Policy, typename Result, bool Alias>
struct EngineTrait<BlkTsrEngine<DistArray<Tile, Policy>, Result, Alias>> {
  // Argument typedefs
  typedef DistArray<Tile, Policy> array_type;  
 
  // Operational typedefs
  typedef
      typename TiledArray::detail::scalar_type<DistArray<Tile, Policy>>::type
          scalar_type;
  typedef TiledArray::detail::Shift<
      Result,
      typename TiledArray::eval_trait<typename array_type::value_type>::type,
      (!Alias) || TiledArray::eval_trait<
                      typename array_type::value_type>::is_consumable>
      op_base_type;  
  typedef TiledArray::detail::UnaryWrapper<op_base_type>
      op_type;  
  typedef TiledArray::detail::LazyArrayTile<typename array_type::value_type,
                                            op_type>
      value_type;  
  typedef typename eval_trait<value_type>::type
      eval_type;          
  typedef Policy policy;  
  typedef TiledArray::detail::DistEval<value_type, policy>
      dist_eval_type;  
 
  // Meta data typedefs
  typedef typename policy::ordinal_type size_type;   
  typedef typename policy::trange_type trange_type;  
  typedef typename policy::shape_type shape_type;    
  typedef typename policy::pmap_interface
      pmap_interface;  
 
  static constexpr bool consumable = true;
  static constexpr unsigned int leaves = 1;
};
 
template <typename Tile, typename Policy, typename Scalar, typename Result>
struct EngineTrait<ScalBlkTsrEngine<DistArray<Tile, Policy>, Scalar, Result>> {
  // Argument typedefs
  typedef DistArray<Tile, Policy> array_type;  
 
  // Operational typedefs
  typedef Scalar scalar_type;
  typedef TiledArray::detail::ScalShift<
      Result,
      typename TiledArray::eval_trait<typename array_type::value_type>::type,
      scalar_type,
      TiledArray::eval_trait<typename array_type::value_type>::is_consumable>
      op_base_type;  
  typedef TiledArray::detail::UnaryWrapper<op_base_type>
      op_type;  
  typedef TiledArray::detail::LazyArrayTile<typename array_type::value_type,
                                            op_type>
      value_type;  
  typedef typename eval_trait<value_type>::type
      eval_type;          
  typedef Policy policy;  
  typedef TiledArray::detail::DistEval<value_type, policy>
      dist_eval_type;  
 
  // Meta data typedefs
  typedef typename policy::ordinal_type size_type;   
  typedef typename policy::trange_type trange_type;  
  typedef typename policy::shape_type shape_type;    
  typedef typename policy::pmap_interface
      pmap_interface;  
 
  static constexpr bool consumable = true;
  static constexpr unsigned int leaves = 1;
};
 
 
template <typename Derived>
class BlkTsrEngineBase : public LeafEngine<Derived> {
 public:
  // Class hierarchy typedefs
  typedef BlkTsrEngineBase<Derived> BlkTsrEngineBase_;  
  typedef LeafEngine<Derived> LeafEngine_;  
  typedef typename LeafEngine_::ExprEngine_
      ExprEngine_;  
 
  // Argument typedefs
  typedef typename EngineTrait<Derived>::array_type
      array_type;  
 
  // Operational typedefs
  typedef typename EngineTrait<Derived>::value_type
      value_type;  
  typedef
      typename EngineTrait<Derived>::op_type op_type;  
  typedef
      typename EngineTrait<Derived>::policy policy;  
  typedef typename EngineTrait<Derived>::dist_eval_type
      dist_eval_type;  
 
  // Meta data typedefs
  typedef typename EngineTrait<Derived>::size_type size_type;  
  typedef typename EngineTrait<Derived>::trange_type
      trange_type;  
  typedef typename EngineTrait<Derived>::shape_type
      shape_type;  
  typedef typename EngineTrait<Derived>::pmap_interface
      pmap_interface;  
 
 protected:
  // Import base class variables to this scope
  using ExprEngine_::indices_;
  using ExprEngine_::perm_;
  using ExprEngine_::permute_tiles_;
  using ExprEngine_::pmap_;
  using ExprEngine_::shape_;
  using ExprEngine_::trange_;
  using ExprEngine_::world_;
  using LeafEngine_::array_;
 
  container::svector<std::size_t>
      lower_bound_;  
  container::svector<std::size_t>
      upper_bound_;  
 
 public:
  template <typename Array, bool Alias>
  BlkTsrEngineBase(const BlkTsrExpr<Array, Alias>& expr)
      : LeafEngine_(expr),
        lower_bound_(expr.lower_bound()),
        upper_bound_(expr.upper_bound()) {}
 
  template <typename Array, typename Scalar>
  BlkTsrEngineBase(const ScalBlkTsrExpr<Array, Scalar>& expr)
      : LeafEngine_(expr),
        lower_bound_(expr.lower_bound()),
        upper_bound_(expr.upper_bound()) {}
 
 
  trange_type make_trange() const {
    const unsigned int rank = array_.trange().tiles_range().rank();
 
    std::vector<TiledRange1> trange_data;
    trange_data.reserve(rank);
    std::vector<std::size_t> trange1_data;
 
    // Get temporary data pointers
    const auto* MADNESS_RESTRICT const trange = array_.trange().data().data();
    const auto* MADNESS_RESTRICT const lower = lower_bound_.data();
    const auto* MADNESS_RESTRICT const upper = upper_bound_.data();
 
    for (unsigned int d = 0u; d < rank; ++d) {
      // Copy the tiling for the block
      const auto lower_d = lower[d];
      const auto upper_d = upper[d];
 
      // Copy and shift the tiling for the block
      auto i = lower_d;
      const auto base_d = trange[d].tile(i).first;
      trange1_data.emplace_back(0ul);
      for (; i < upper_d; ++i)
        trange1_data.emplace_back(trange[d].tile(i).second - base_d);
 
      // Add the trange1 to the tiled range data
      trange_data.emplace_back(trange1_data.begin(), trange1_data.end());
      trange1_data.resize(0ul);
    }
 
    return TiledRange(trange_data.begin(), trange_data.end());
  }
 
 
  trange_type make_trange(const Permutation& perm) const {
    const unsigned int rank = array_.trange().tiles_range().rank();
 
    std::vector<TiledRange1> trange_data;
    trange_data.reserve(rank);
    std::vector<std::size_t> trange1_data;
 
    // Get temporary data pointers
    const auto* MADNESS_RESTRICT const trange = array_.trange().data().data();
    const auto* MADNESS_RESTRICT const lower = lower_bound_.data();
    const auto* MADNESS_RESTRICT const upper = upper_bound_.data();
 
    // Construct the inverse permutation
    const auto inv_perm = -perm;
    for (unsigned int d = 0u; d < rank; ++d) {
      const auto inv_perm_d = inv_perm[d];
 
      // Copy the tiling for the block
      const auto lower_i = lower[inv_perm_d];
      const auto upper_i = upper[inv_perm_d];
 
      // Copy, shift, and permute the tiling of the block
      auto i = lower_i;
      const auto base_d = trange[inv_perm_d].tile(i).first;
      trange1_data.emplace_back(0ul);
      for (; i < upper_i; ++i)
        trange1_data.emplace_back(trange[inv_perm_d].tile(i).second - base_d);
 
      // Add the trange1 to the tiled range data
      trange_data.emplace_back(trange1_data.begin(), trange1_data.end());
      trange1_data.resize(0ul);
    }
 
    return TiledRange(trange_data.begin(), trange_data.end());
  }
 
  void init_distribution(World* world,
                         const std::shared_ptr<pmap_interface>& pmap) {
    ExprEngine_::init_distribution(
        world,
        (pmap ? pmap
              : policy::default_pmap(*world, trange_.tiles_range().volume())));
  }
 
  dist_eval_type make_dist_eval() const {
    // Define the distributed evaluator implementation type
    typedef TiledArray::detail::ArrayEvalImpl<array_type, op_type, policy>
        impl_type;
 
    std::shared_ptr<impl_type> pimpl = std::make_shared<impl_type>(
        array_, *world_, trange_, shape_, pmap_, perm_, ExprEngine_::make_op(),
        lower_bound_, upper_bound_);
 
    return dist_eval_type(pimpl);
  }
 
 
  std::string make_tag() const {
    std::stringstream ss;
    ss << "[Block ";
    TiledArray::detail::print_array(ss, lower_bound_);
    ss << " - ";
    TiledArray::detail::print_array(ss, upper_bound_);
    ss << "] ";
    return ss.str();
  }
 
};  // class BlkTsrEngineBase
 
 
template <typename Array, typename Result, bool Alias>
class BlkTsrEngine
    : public BlkTsrEngineBase<BlkTsrEngine<Array, Result, Alias>> {
 public:
  // Class hierarchy typedefs
  typedef BlkTsrEngine<Array, Result, Alias>
      BlkTsrEngine_;  
  typedef BlkTsrEngineBase<BlkTsrEngine_>
      BlkTsrEngineBase_;  
  typedef typename BlkTsrEngineBase_::LeafEngine_
      LeafEngine_;  
  typedef typename LeafEngine_::ExprEngine_
      ExprEngine_;  
 
  // Argument typedefs
  typedef typename EngineTrait<BlkTsrEngine_>::array_type
      array_type;  
 
  // Operational typedefs
  typedef typename EngineTrait<BlkTsrEngine_>::value_type
      value_type;  
  typedef typename EngineTrait<BlkTsrEngine_>::op_base_type
      op_base_type;  
  typedef typename EngineTrait<BlkTsrEngine_>::op_type
      op_type;  
  typedef typename EngineTrait<BlkTsrEngine_>::policy
      policy;  
  typedef typename EngineTrait<BlkTsrEngine_>::dist_eval_type
      dist_eval_type;  
 
  // Meta data typedefs
  typedef
      typename EngineTrait<BlkTsrEngine_>::size_type size_type;  
  typedef typename EngineTrait<BlkTsrEngine_>::trange_type
      trange_type;  
  typedef typename EngineTrait<BlkTsrEngine_>::shape_type
      shape_type;  
  typedef typename EngineTrait<BlkTsrEngine_>::pmap_interface
      pmap_interface;  
 
 protected:
  // Import base class variables to this scope
  using BlkTsrEngineBase_::lower_bound_;
  using BlkTsrEngineBase_::upper_bound_;
  using ExprEngine_::indices_;
  using ExprEngine_::perm_;
  using ExprEngine_::permute_tiles_;
  using ExprEngine_::pmap_;
  using ExprEngine_::shape_;
  using ExprEngine_::trange_;
  using ExprEngine_::world_;
  using LeafEngine_::array_;
 
 public:
  template <typename A>
  BlkTsrEngine(const BlkTsrExpr<A, Alias>& expr) : BlkTsrEngineBase_(expr) {}
 
 
  shape_type make_shape() {
    return array_.shape().block(lower_bound_, upper_bound_);
  }
 
 
  shape_type make_shape(const Permutation& perm) {
    return array_.shape().block(lower_bound_, upper_bound_, perm);
  }
 
 
  op_type make_tile_op() const {
    const unsigned int rank = trange_.tiles_range().rank();
 
    // Construct and allocate memory for the shift range
    std::vector<long> range_shift;
    range_shift.reserve(rank);
 
    // Get temporary data pointers
    const auto* MADNESS_RESTRICT const trange = array_.trange().data().data();
    const auto* MADNESS_RESTRICT const lower = lower_bound_.data();
 
    // Initialize the range shift vector
    for (unsigned int d = 0u; d < rank; ++d) {
      const auto lower_d = lower[d];
      const auto base_d = trange[d].tile(lower_d).first;
      range_shift.emplace_back(-base_d);
    }
 
    return op_type(op_base_type(range_shift));
  }
 
 
  template <typename Perm, typename = std::enable_if_t<
                               TiledArray::detail::is_permutation_v<Perm>>>
  op_type make_tile_op(const Perm& perm) const {
    const unsigned int rank = trange_.tiles_range().rank();
 
    // Construct and allocate memory for the shift range
    std::vector<long> range_shift(rank, 0l);
 
    // Get temporary data pointers
    const auto* MADNESS_RESTRICT const trange = array_.trange().data().data();
    const auto* MADNESS_RESTRICT const lower = lower_bound_.data();
 
    // Initialize the permuted range shift vector
    auto outer_perm = outer(perm);
    TA_ASSERT(outer_perm.size() == rank);
    for (unsigned int d = 0u; d < rank; ++d) {
      const auto perm_d = outer_perm[d];
      const auto lower_d = lower[d];
      const auto base_d = trange[d].tile(lower_d).first;
      range_shift[perm_d] = -base_d;
    }
 
    return op_type(op_base_type(range_shift), perm);
  }
 
 
  std::string make_tag() const {
    std::stringstream ss;
    ss << "[block] ";
    return BlkTsrEngineBase_::make_tag() + ss.str();
  }
 
};  // class BlkTsrEngine
 
 
template <typename Array, typename Scalar, typename Result>
class ScalBlkTsrEngine
    : public BlkTsrEngineBase<ScalBlkTsrEngine<Array, Scalar, Result>> {
 public:
  // Class hierarchy typedefs
  typedef ScalBlkTsrEngine<Array, Scalar, Result>
      ScalBlkTsrEngine_;  
  typedef BlkTsrEngineBase<ScalBlkTsrEngine_>
      BlkTsrEngineBase_;  
  typedef typename BlkTsrEngineBase_::LeafEngine_
      LeafEngine_;  
  typedef typename LeafEngine_::ExprEngine_
      ExprEngine_;  
 
  // Argument typedefs
  typedef typename EngineTrait<ScalBlkTsrEngine_>::array_type
      array_type;  
 
  // Operational typedefs
  typedef typename EngineTrait<ScalBlkTsrEngine_>::value_type
      value_type;  
  typedef typename EngineTrait<ScalBlkTsrEngine_>::scalar_type
      scalar_type;  
  typedef typename EngineTrait<ScalBlkTsrEngine_>::op_base_type
      op_base_type;  
  typedef typename EngineTrait<ScalBlkTsrEngine_>::op_type
      op_type;  
  typedef typename EngineTrait<ScalBlkTsrEngine_>::policy
      policy;  
  typedef typename EngineTrait<ScalBlkTsrEngine_>::dist_eval_type
      dist_eval_type;  
 
  // Meta data typedefs
  typedef typename EngineTrait<ScalBlkTsrEngine_>::size_type
      size_type;  
  typedef typename EngineTrait<ScalBlkTsrEngine_>::trange_type
      trange_type;  
  typedef typename EngineTrait<ScalBlkTsrEngine_>::shape_type
      shape_type;  
  typedef typename EngineTrait<ScalBlkTsrEngine_>::pmap_interface
      pmap_interface;  
 
 protected:
  // Import base class variables to this scope
  using BlkTsrEngineBase_::lower_bound_;
  using BlkTsrEngineBase_::upper_bound_;
  using ExprEngine_::indices_;
  using ExprEngine_::perm_;
  using ExprEngine_::permute_tiles_;
  using ExprEngine_::pmap_;
  using ExprEngine_::shape_;
  using ExprEngine_::trange_;
  using ExprEngine_::world_;
  using LeafEngine_::array_;
 
  scalar_type factor_;
 
 public:
  template <typename A, typename S>
  ScalBlkTsrEngine(const ScalBlkTsrExpr<A, S>& expr)
      : BlkTsrEngineBase_(expr), factor_(expr.factor()) {}
 
 
  shape_type make_shape() {
    return array_.shape().block(lower_bound_, upper_bound_, factor_);
  }
 
 
  shape_type make_shape(const Permutation& perm) {
    return array_.shape().block(lower_bound_, upper_bound_, factor_, perm);
  }
 
 
  op_type make_tile_op() const {
    const unsigned int rank = trange_.tiles_range().rank();
 
    // Construct and allocate memory for the shift range
    std::vector<long> range_shift;
    range_shift.reserve(rank);
 
    // Get temporary data pointers
    const auto* MADNESS_RESTRICT const trange = array_.trange().data().data();
    const auto* MADNESS_RESTRICT const lower = lower_bound_.data();
 
    // Construct the inverse permutation
    for (unsigned int d = 0u; d < rank; ++d) {
      const auto lower_d = lower[d];
      const auto base_d = trange[d].tile(lower_d).first;
      range_shift.emplace_back(-base_d);
    }
 
    return op_type(op_base_type(range_shift, factor_));
  }
 
 
  template <typename Perm, typename = std::enable_if_t<
                               TiledArray::detail::is_permutation_v<Perm>>>
  op_type make_tile_op(const Perm& perm) const {
    const unsigned int rank = trange_.tiles_range().rank();
 
    // Construct and allocate memory for the shift range
    std::vector<long> range_shift(rank, 0l);
 
    // Get temporary data pointers
    const auto* MADNESS_RESTRICT const trange = array_.trange().data().data();
    const auto* MADNESS_RESTRICT const lower = lower_bound_.data();
 
    // Initialize the permuted range shift vector
    auto outer_perm = outer(perm);
    TA_ASSERT(outer_perm.size() == rank);
    for (unsigned int d = 0u; d < rank; ++d) {
      const auto perm_d = outer_perm[d];
      const auto lower_d = lower[d];
      const auto base_d = trange[d].tile(lower_d).first;
      range_shift[perm_d] = -base_d;
    }
 
    return op_type(op_base_type(range_shift, factor_), perm);
  }
 
 
  std::string make_tag() const {
    std::stringstream ss;
    ss << "[block] [" << factor_ << "] ";
    return BlkTsrEngineBase_::make_tag() + ss.str();
  }
 
};  // class ScalBlkTsrEngine
 
}  // namespace expressions
}  // namespace TiledArray
 
#endif  // TILEDARRAY_EXPRESSIONS_BLK_TSR_ENGINE_H__INCLUDED