apply_scalar_binary.hpp

Go to the documentation of this file.

#ifndef STAN_MATH_PRIM_FUNCTOR_APPLY_SCALAR_BINARY_HPP
#define STAN_MATH_PRIM_FUNCTOR_APPLY_SCALAR_BINARY_HPP
 
#include <stan/math/prim/fun/as_column_vector_or_scalar.hpp>
#include <stan/math/prim/meta/is_stan_scalar.hpp>
#include <stan/math/prim/meta/is_container.hpp>
#include <stan/math/prim/meta/is_eigen.hpp>
#include <stan/math/prim/meta/require_generics.hpp>
#include <stan/math/prim/err/check_matching_dims.hpp>
#include <stan/math/prim/err/check_matching_sizes.hpp>
#include <stan/math/prim/fun/num_elements.hpp>
#include <vector>
 
namespace stan {
namespace math {
 
template <typename T1, typename T2, typename F,
          require_all_stan_scalar_t<T1, T2>* = nullptr>
inline auto apply_scalar_binary(const T1& x, const T2& y, const F& f) {
  return f(x, y);
}
 
template <typename T1, typename T2, typename F,
          require_all_eigen_t<T1, T2>* = nullptr>
inline auto apply_scalar_binary(T1&& x, T2&& y, F&& f) {
  check_matching_dims("Binary function", "x", x, "y", y);
  return make_holder(
      [](auto& f_inner, auto& x_inner, auto& y_inner) {
        return x_inner.binaryExpr(y_inner, f_inner);
      },
      std::forward<F>(f), std::forward<T1>(x), std::forward<T2>(y));
}
 
template <typename T1, typename T2, typename F,
          require_eigen_vector_vt<is_stan_scalar, T1>* = nullptr,
          require_std_vector_vt<std::is_integral, T2>* = nullptr>
inline auto apply_scalar_binary(T1&& x, T2&& y, F&& f) {
  check_matching_sizes("Binary function", "x", x, "y", y);
  return make_holder(
      [](auto& f_inner, auto& x_inner, auto& y_inner) {
        using int_vec_t = promote_scalar_t<value_type_t<decltype(y_inner)>,
                                           plain_type_t<decltype(x_inner)>>;
        Eigen::Map<const int_vec_t> y_map(y_inner.data(), y_inner.size());
        return x_inner.binaryExpr(y_map, f_inner);
      },
      std::forward<F>(f), std::forward<T1>(x), std::forward<T2>(y));
}
 
template <typename T1, typename T2, typename F,
          require_std_vector_vt<std::is_integral, T1>* = nullptr,
          require_eigen_vector_vt<is_stan_scalar, T2>* = nullptr>
inline auto apply_scalar_binary(T1&& x, T2&& y, F&& f) {
  check_matching_sizes("Binary function", "x", x, "y", y);
  return make_holder(
      [](auto& f_inner, auto& x_inner, auto& y_inner) {
        using int_vec_t = promote_scalar_t<value_type_t<decltype(x_inner)>,
                                           plain_type_t<decltype(y_inner)>>;
        Eigen::Map<const int_vec_t> x_map(x_inner.data(), x_inner.size());
        return x_map.binaryExpr(y_inner, f_inner);
      },
      std::forward<F>(f), std::forward<T1>(x), std::forward<T2>(y));
}
 
template <typename T1, typename T2, typename F,
          require_eigen_matrix_dynamic_vt<is_stan_scalar, T1>* = nullptr,
          require_std_vector_vt<is_std_vector, T2>* = nullptr,
          require_std_vector_st<std::is_integral, T2>* = nullptr>
inline auto apply_scalar_binary(const T1& x, const T2& y, const F& f) {
  if (num_elements(x) != num_elements(y)) {
    std::ostringstream msg;
    msg << "Inputs to vectorized binary function must match in"
        << " size if one is not a scalar";
    throw std::invalid_argument(msg.str());
  }
  using return_st = decltype(f(x(0), y[0][0]));
  Eigen::Matrix<return_st, Eigen::Dynamic, Eigen::Dynamic> result(x.rows(),
                                                                  x.cols());
  for (size_t i = 0; i < y.size(); ++i) {
    result.row(i) = apply_scalar_binary(x.row(i).transpose(),
                                        as_column_vector_or_scalar(y[i]), f);
  }
  return result;
}
 
template <typename T1, typename T2, typename F,
          require_std_vector_vt<is_std_vector, T1>* = nullptr,
          require_std_vector_st<std::is_integral, T1>* = nullptr,
          require_eigen_matrix_dynamic_vt<is_stan_scalar, T2>* = nullptr>
inline auto apply_scalar_binary(const T1& x, const T2& y, const F& f) {
  if (num_elements(x) != num_elements(y)) {
    std::ostringstream msg;
    msg << "Inputs to vectorized binary function must match in"
        << " size if one is not a scalar";
    throw std::invalid_argument(msg.str());
  }
  using return_st = decltype(f(x[0][0], y(0)));
  Eigen::Matrix<return_st, Eigen::Dynamic, Eigen::Dynamic> result(y.rows(),
                                                                  y.cols());
  for (size_t i = 0; i < x.size(); ++i) {
    result.row(i) = apply_scalar_binary(as_column_vector_or_scalar(x[i]),
                                        y.row(i).transpose(), f);
  }
  return result;
}
 
template <typename T1, typename T2, typename F, require_eigen_t<T1>* = nullptr,
          require_stan_scalar_t<T2>* = nullptr>
inline auto apply_scalar_binary(T1&& x, T2&& y, F&& f) {
  return make_holder(
      [](auto& f_inner, auto& x_inner, auto& y_inner) {
        return x_inner.unaryExpr(
            [f_inner, y_inner](const auto& v) { return f_inner(v, y_inner); });
      },
      std::forward<F>(f), std::forward<T1>(x), std::forward<T2>(y));
}
 
template <typename T1, typename T2, typename F,
          require_stan_scalar_t<T1>* = nullptr, require_eigen_t<T2>* = nullptr>
inline auto apply_scalar_binary(T1&& x, T2&& y, F&& f) {
  return make_holder(
      [](auto& f_inner, auto& x_inner, auto& y_inner) {
        return y_inner.unaryExpr(
            [f_inner, x_inner](const auto& v) { return f_inner(x_inner, v); });
      },
      std::forward<F>(f), std::forward<T1>(x), std::forward<T2>(y));
}
 
template <typename T1, typename T2, typename F,
          require_all_std_vector_vt<is_stan_scalar, T1, T2>* = nullptr>
inline auto apply_scalar_binary(const T1& x, const T2& y, const F& f) {
  check_matching_sizes("Binary function", "x", x, "y", y);
  decltype(auto) x_vec = as_column_vector_or_scalar(x);
  decltype(auto) y_vec = as_column_vector_or_scalar(y);
  using T_return = std::decay_t<decltype(f(x[0], y[0]))>;
  std::vector<T_return> result(x.size());
  Eigen::Map<Eigen::Matrix<T_return, -1, 1>>(result.data(), result.size())
      = x_vec.binaryExpr(y_vec, f);
  return result;
}
 
template <typename T1, typename T2, typename F,
          require_std_vector_vt<is_stan_scalar, T1>* = nullptr,
          require_stan_scalar_t<T2>* = nullptr>
inline auto apply_scalar_binary(const T1& x, const T2& y, const F& f) {
  decltype(auto) x_vec = as_column_vector_or_scalar(x);
  using T_return = std::decay_t<decltype(f(x[0], y))>;
  std::vector<T_return> result(x.size());
  Eigen::Map<Eigen::Matrix<T_return, -1, 1>>(result.data(), result.size())
      = x_vec.unaryExpr([f, y](const auto& v) { return f(v, y); });
  return result;
}
 
template <typename T1, typename T2, typename F,
          require_stan_scalar_t<T1>* = nullptr,
          require_std_vector_vt<is_stan_scalar, T2>* = nullptr>
inline auto apply_scalar_binary(const T1& x, const T2& y, const F& f) {
  decltype(auto) y_vec = as_column_vector_or_scalar(y);
  using T_return = std::decay_t<decltype(f(x, y[0]))>;
  std::vector<T_return> result(y.size());
  Eigen::Map<Eigen::Matrix<T_return, -1, 1>>(result.data(), result.size())
      = y_vec.unaryExpr([f, x](const auto& v) { return f(x, v); });
  return result;
}
 
template <
    typename T1, typename T2, typename F,
    require_all_std_vector_vt<is_container_or_var_matrix, T1, T2>* = nullptr>
inline auto apply_scalar_binary(const T1& x, const T2& y, const F& f) {
  check_matching_sizes("Binary function", "x", x, "y", y);
  using T_return = plain_type_t<decltype(apply_scalar_binary(x[0], y[0], f))>;
  size_t y_size = y.size();
  std::vector<T_return> result(y_size);
  for (size_t i = 0; i < y_size; ++i) {
    result[i] = apply_scalar_binary(x[i], y[i], f);
  }
  return result;
}
 
template <typename T1, typename T2, typename F,
          require_std_vector_vt<is_container_or_var_matrix, T1>* = nullptr,
          require_stan_scalar_t<T2>* = nullptr>
inline auto apply_scalar_binary(const T1& x, const T2& y, const F& f) {
  using T_return = plain_type_t<decltype(apply_scalar_binary(x[0], y, f))>;
  size_t x_size = x.size();
  std::vector<T_return> result(x_size);
  for (size_t i = 0; i < x_size; ++i) {
    result[i] = apply_scalar_binary(x[i], y, f);
  }
  return result;
}
 
template <typename T1, typename T2, typename F,
          require_stan_scalar_t<T1>* = nullptr,
          require_std_vector_vt<is_container_or_var_matrix, T2>* = nullptr>
inline auto apply_scalar_binary(const T1& x, const T2& y, const F& f) {
  using T_return = plain_type_t<decltype(apply_scalar_binary(x, y[0], f))>;
  size_t y_size = y.size();
  std::vector<T_return> result(y_size);
  for (size_t i = 0; i < y_size; ++i) {
    result[i] = apply_scalar_binary(x, y[i], f);
  }
  return result;
}
 
}  // namespace math
}  // namespace stan
#endif