indexing.hpp

Go to the documentation of this file.

#ifndef STAN_MATH_OPENCL_KERNEL_GENERATOR_indexing_HPP
#define STAN_MATH_OPENCL_KERNEL_GENERATOR_indexing_HPP
#ifdef STAN_OPENCL
 
#include <stan/math/prim/meta.hpp>
#include <stan/math/opencl/kernel_generator/type_str.hpp>
#include <stan/math/opencl/kernel_generator/name_generator.hpp>
#include <stan/math/opencl/kernel_generator/operation_cl.hpp>
#include <stan/math/opencl/kernel_generator/as_operation_cl.hpp>
#include <map>
#include <string>
#include <utility>
 
namespace stan {
namespace math {
 
template <typename T_mat, typename T_row_index, typename T_col_index>
class indexing_
    : public operation_cl_lhs<indexing_<T_mat, T_row_index, T_col_index>,
                              typename std::remove_reference_t<T_mat>::Scalar,
                              T_mat, T_row_index, T_col_index> {
  static_assert(std::is_integral<value_type_t<T_row_index>>::value,
                "indexing: Row index scalar type must be an integer!");
  static_assert(std::is_integral<value_type_t<T_col_index>>::value,
                "indexing: Column index scalar type must be an integer!");
 
 public:
  using Scalar = typename std::remove_reference_t<T_mat>::Scalar;
  using base = operation_cl_lhs<indexing_<T_mat, T_row_index, T_col_index>,
                                Scalar, T_mat, T_row_index, T_col_index>;
  using base::var_name_;
  using base::operator=;
 
  indexing_(T_mat&& mat, T_row_index&& row_index, T_col_index&& col_index)
      : base(std::forward<T_mat>(mat), std::forward<T_row_index>(row_index),
             std::forward<T_col_index>(col_index)) {
    const char* function = "indexing";
    if (col_index.rows() != base::dynamic
        && row_index.rows() != base::dynamic) {
      check_size_match(function, "Rows of ", "col_index", col_index.rows(),
                       "rows of ", "row_index", row_index.rows());
    }
    if (col_index.cols() != base::dynamic
        && row_index.cols() != base::dynamic) {
      check_size_match(function, "Columns of ", "col_index", col_index.cols(),
                       "columns of ", "row_index", row_index.cols());
    }
  }
 
  inline auto deep_copy() const {
    auto&& mat_copy = this->template get_arg<0>().deep_copy();
    auto&& row_index_copy = this->template get_arg<1>().deep_copy();
    auto&& col_index_copy = this->template get_arg<2>().deep_copy();
    return indexing_<std::remove_reference_t<decltype(mat_copy)>,
                     std::remove_reference_t<decltype(row_index_copy)>,
                     std::remove_reference_t<decltype(col_index_copy)>>{
        std::move(mat_copy), std::move(row_index_copy),
        std::move(col_index_copy)};
  }
 
  inline kernel_parts get_kernel_parts(
      std::unordered_map<const void*, const char*>& generated,
      std::unordered_map<const void*, const char*>& generated_all,
      name_generator& name_gen, const std::string& row_index_name,
      const std::string& col_index_name, bool view_handled) const {
    kernel_parts res{};
    if (generated.count(this) == 0) {
      generated[this] = "";
 
      const auto& mat = this->template get_arg<0>();
      const auto& row_index = this->template get_arg<1>();
      const auto& col_index = this->template get_arg<2>();
 
      kernel_parts parts_row_idx = row_index.get_kernel_parts(
          generated, generated_all, name_gen, row_index_name, col_index_name,
          view_handled);
      kernel_parts parts_col_idx = col_index.get_kernel_parts(
          generated, generated_all, name_gen, row_index_name, col_index_name,
          view_handled);
      std::unordered_map<const void*, const char*> generated2;
      kernel_parts parts_mat = mat.get_kernel_parts(
          generated2, generated_all, name_gen, row_index.var_name_,
          col_index.var_name_, false);
 
      res = parts_row_idx + parts_col_idx + parts_mat;
      var_name_ = mat.var_name_;
    }
    return res;
  }
 
  inline kernel_parts get_kernel_parts_lhs(
      std::unordered_map<const void*, const char*>& generated,
      std::unordered_map<const void*, const char*>& generated_all,
      name_generator& name_gen, const std::string& row_index_name,
      const std::string& col_index_name) const {
    if (generated.count(this) == 0) {
      generated[this] = "";
    }
    const auto& mat = this->template get_arg<0>();
    const auto& row_index = this->template get_arg<1>();
    const auto& col_index = this->template get_arg<2>();
 
    kernel_parts parts_row_idx
        = row_index.get_kernel_parts(generated, generated_all, name_gen,
                                     row_index_name, col_index_name, false);
    kernel_parts parts_col_idx
        = col_index.get_kernel_parts(generated, generated_all, name_gen,
                                     row_index_name, col_index_name, false);
    std::unordered_map<const void*, const char*> generated2;
    kernel_parts parts_mat
        = mat.get_kernel_parts_lhs(generated2, generated_all, name_gen,
                                   row_index.var_name_, col_index.var_name_);
 
    kernel_parts res = parts_row_idx + parts_col_idx + parts_mat;
    var_name_ = mat.var_name_;
    return res;
  }
 
  inline void set_args(
      std::unordered_map<const void*, const char*>& generated,
      std::unordered_map<const void*, const char*>& generated_all,
      cl::Kernel& kernel, int& arg_num) const {
    if (generated.count(this) == 0) {
      generated[this] = "";
      this->template get_arg<1>().set_args(generated, generated_all, kernel,
                                           arg_num);
      this->template get_arg<2>().set_args(generated, generated_all, kernel,
                                           arg_num);
      std::unordered_map<const void*, const char*> generated2;
      this->template get_arg<0>().set_args(generated2, generated_all, kernel,
                                           arg_num);
    }
  }
 
  inline int rows() const {
    return std::max(this->template get_arg<1>().rows(),
                    this->template get_arg<2>().rows());
  }
 
  inline int cols() const {
    return std::max(this->template get_arg<1>().cols(),
                    this->template get_arg<2>().cols());
  }
 
  inline void set_view(int bottom_diagonal, int top_diagonal,
                       int bottom_zero_diagonal, int top_zero_diagonal) const {
    this->template get_arg<0>().set_view(
        std::numeric_limits<int>::min(), std::numeric_limits<int>::max(),
        std::numeric_limits<int>::min(), std::numeric_limits<int>::max());
  }
 
  inline std::pair<int, int> extreme_diagonals() const {
    return {std::numeric_limits<int>::min(), std::numeric_limits<int>::max()};
  }
 
  inline void check_assign_dimensions(int rows, int cols) const {
    check_size_match("indexing_.check_assign_dimensions", "Rows of ",
                     "indexing", this->rows(), "rows of ", "expression", rows);
    check_size_match("indexing_.check_assign_dimensions", "Columns of ",
                     "indexing", this->cols(), "columns of ", "expression",
                     cols);
  }
 
  inline void add_write_event(cl::Event& e) const {
    this->template get_arg<1>().add_read_event(e);
    this->template get_arg<2>().add_read_event(e);
    this->template get_arg<0>().add_write_event(e);
  }
 
  inline void get_clear_read_write_events(
      std::vector<cl::Event>& events) const {
    this->template get_arg<0>().get_clear_read_write_events(events);
    this->template get_arg<1>().get_write_events(events);
    this->template get_arg<2>().get_write_events(events);
  }
};
 
template <typename T_mat, typename T_row_index, typename T_col_index,
          require_all_kernel_expressions_t<T_mat, T_row_index,
                                           T_col_index>* = nullptr>
inline auto indexing(T_mat&& mat, T_row_index&& row_index,
                     T_col_index&& col_index) {
  auto&& mat_operation = as_operation_cl(std::forward<T_mat>(mat)).deep_copy();
  return indexing_<std::remove_reference_t<decltype(mat_operation)>,
                   as_operation_cl_t<T_row_index>,
                   as_operation_cl_t<T_col_index>>(
      std::move(mat_operation),
      as_operation_cl(std::forward<T_row_index>(row_index)),
      as_operation_cl(std::forward<T_col_index>(col_index)));
}
 
}  // namespace math
}  // namespace stan
 
#endif
#endif