operands_and_partials.hpp

Go to the documentation of this file.

#ifndef STAN_MATH_FWD_META_OPERANDS_AND_PARTIALS_HPP
#define STAN_MATH_FWD_META_OPERANDS_AND_PARTIALS_HPP
 
#include <stan/math/prim/fun/Eigen.hpp>
#include <stan/math/prim/meta.hpp>
#include <stan/math/prim/fun/size.hpp>
#include <stan/math/fwd/functor/broadcast_array.hpp>
#include <stan/math/fwd/core/fvar.hpp>
#include <stan/math/fwd/meta.hpp>
#include <stan/math/fwd/fun/sum.hpp>
#include <stan/math/prim/fun/as_column_vector_or_scalar.hpp>
#include <stan/math/prim/fun/elt_multiply.hpp>
#include <stan/math/prim/functor/apply.hpp>
#include <stan/math/prim/functor/for_each.hpp>
#include <stan/math/prim/functor/operands_and_partials.hpp>
#include <vector>
 
namespace stan {
namespace math {
namespace internal {
 
static constexpr auto sum_dx() { return static_cast<double>(0.0); }
 
template <typename... Types>
inline constexpr auto sum_dx(Types&... args) {
  return (args.dx() + ...);
}
 
template <typename InnerType, typename T>
class ops_partials_edge<InnerType, T, require_fvar_t<T>> {
 public:
  using Op = std::decay_t<T>;
  using Dx = std::decay_t<InnerType>;
  Dx partial_{0};
  broadcast_array<Dx> partials_{partial_};
 
  explicit ops_partials_edge(const T& op)
      : partial_(0), partials_(partial_), operands_(op) {}
 
  explicit ops_partials_edge(
      const ops_partials_edge<InnerType, T, require_fvar_t<T>>& other)
      : partial_(other.partial_),
        partials_(partial_),
        operands_(other.operands_) {}
 
  explicit ops_partials_edge(
      ops_partials_edge<InnerType, T, require_fvar_t<T>>&& other)
      : partial_(other.partial_),
        partials_(partial_),
        operands_(other.operands_) {}
 
  const Op& operands_;
 
  inline Dx dx() { return this->partial_ * this->operands_.d_; }
};
 
// Vectorized Univariate
template <typename InnerType, typename T>
class ops_partials_edge<InnerType, T, require_std_vector_vt<is_fvar, T>> {
 public:
  using Op = std::decay_t<T>;
  using Dx = std::decay_t<InnerType>;
  using partials_t = Eigen::Matrix<Dx, -1, 1>;
  partials_t partials_;  // For univariate use-cases
  broadcast_array<partials_t> partials_vec_{partials_};  // For multivariate
  explicit ops_partials_edge(const Op& ops)
      : partials_(partials_t::Zero(ops.size()).eval()), operands_(ops) {}
 
  explicit ops_partials_edge(
      const ops_partials_edge<InnerType, T, require_std_vector_vt<is_fvar, T>>&
          other)
      : partials_(other.partials_),
        partials_vec_(partials_),
        operands_(other.operands_) {}
 
  explicit ops_partials_edge(
      ops_partials_edge<InnerType, T, require_std_vector_vt<is_fvar, T>>&&
          other)
      : partials_(std::move(other.partials_)),
        partials_vec_(partials_),
        operands_(other.operands_) {}
 
  const Op& operands_;
  inline Dx dx() {
    return dot_product(as_column_vector_or_scalar(this->partials_),
                       as_column_vector_or_scalar(this->operands_).d());
  }
};
 
template <typename Dx, typename ViewElt>
class ops_partials_edge<Dx, ViewElt, require_eigen_vt<is_fvar, ViewElt>> {
 public:
  using partials_t = promote_scalar_t<Dx, ViewElt>;
  using Op = plain_type_t<ViewElt>;
  partials_t partials_;  // For univariate use-cases
  broadcast_array<partials_t> partials_vec_{partials_};  // For multivariate
  template <typename OpT, require_eigen_vt<is_fvar, OpT>* = nullptr>
  explicit ops_partials_edge(const OpT& ops)
      : partials_(partials_t::Zero(ops.rows(), ops.cols())), operands_(ops) {}
 
  explicit ops_partials_edge(
      const ops_partials_edge<Dx, ViewElt, require_eigen_vt<is_fvar, ViewElt>>&
          other)
      : partials_(other.partials_),
        partials_vec_(partials_),
        operands_(other.operands_) {}
 
  explicit ops_partials_edge(
      ops_partials_edge<Dx, ViewElt, require_eigen_vt<is_fvar, ViewElt>>&&
          other)
      : partials_(std::move(other.partials_)),
        partials_vec_(partials_),
        operands_(other.operands_) {}
 
  Op operands_;
 
  inline Dx dx() {
    return sum(elt_multiply(this->partials_, this->operands_.d()));
  }
};
 
// Multivariate; vectors of eigen types
template <typename Dx, int R, int C>
class ops_partials_edge<Dx, std::vector<Eigen::Matrix<fvar<Dx>, R, C>>> {
 public:
  using Op = std::vector<Eigen::Matrix<fvar<Dx>, R, C>>;
  using partial_t = Eigen::Matrix<Dx, R, C>;
  std::vector<partial_t> partials_vec_;
  explicit ops_partials_edge(const Op& ops)
      : partials_vec_(ops.size()), operands_(ops) {
    for (size_t i = 0; i < ops.size(); ++i) {
      partials_vec_[i] = partial_t::Zero(ops[i].rows(), ops[i].cols());
    }
  }
 
  Op operands_;
 
  inline Dx dx() {
    Dx derivative(0);
    for (size_t i = 0; i < this->operands_.size(); ++i) {
      derivative
          += sum(elt_multiply(this->partials_vec_[i], this->operands_[i].d()));
    }
    return derivative;
  }
};
 
template <typename Dx>
class ops_partials_edge<Dx, std::vector<std::vector<fvar<Dx>>>> {
 public:
  using Op = std::vector<std::vector<fvar<Dx>>>;
  using partial_t = std::vector<Dx>;
  std::vector<partial_t> partials_vec_;
  explicit ops_partials_edge(const Op& ops)
      : partials_vec_(stan::math::size(ops)), operands_(ops) {
    for (size_t i = 0; i < stan::math::size(ops); ++i) {
      partials_vec_[i] = partial_t(stan::math::size(ops[i]), 0.0);
    }
  }
 
  Op operands_;
  inline Dx dx() {
    Dx derivative(0);
    for (size_t i = 0; i < this->operands_.size(); ++i) {
      for (size_t j = 0; j < this->operands_[i].size(); ++j) {
        derivative += this->partials_vec_[i][j] * this->operands_[i][j].d_;
      }
    }
    return derivative;
  }
};
 
}  // namespace internal
 
template <typename Op1, typename Op2, typename Op3, typename Op4, typename Op5,
          typename Op6, typename Op7, typename Op8, typename Dx>
class operands_and_partials<Op1, Op2, Op3, Op4, Op5, Op6, Op7, Op8, fvar<Dx>> {
 public:
  internal::ops_partials_edge<Dx, std::decay_t<Op1>> edge1_;
  internal::ops_partials_edge<Dx, std::decay_t<Op2>> edge2_;
  internal::ops_partials_edge<Dx, std::decay_t<Op3>> edge3_;
  internal::ops_partials_edge<Dx, std::decay_t<Op4>> edge4_;
  internal::ops_partials_edge<Dx, std::decay_t<Op5>> edge5_;
  internal::ops_partials_edge<Dx, std::decay_t<Op6>> edge6_;
  internal::ops_partials_edge<Dx, std::decay_t<Op7>> edge7_;
  internal::ops_partials_edge<Dx, std::decay_t<Op8>> edge8_;
  using T_return_type = fvar<Dx>;
  explicit operands_and_partials(const Op1& o1) : edge1_(o1) {}
  operands_and_partials(const Op1& o1, const Op2& o2)
      : edge1_(o1), edge2_(o2) {}
  operands_and_partials(const Op1& o1, const Op2& o2, const Op3& o3)
      : edge1_(o1), edge2_(o2), edge3_(o3) {}
  operands_and_partials(const Op1& o1, const Op2& o2, const Op3& o3,
                        const Op4& o4)
      : edge1_(o1), edge2_(o2), edge3_(o3), edge4_(o4) {}
  operands_and_partials(const Op1& o1, const Op2& o2, const Op3& o3,
                        const Op4& o4, const Op5& o5)
      : edge1_(o1), edge2_(o2), edge3_(o3), edge4_(o4), edge5_(o5) {}
  operands_and_partials(const Op1& o1, const Op2& o2, const Op3& o3,
                        const Op4& o4, const Op5& o5, const Op6& o6)
      : edge1_(o1),
        edge2_(o2),
        edge3_(o3),
        edge4_(o4),
        edge5_(o5),
        edge6_(o6) {}
  operands_and_partials(const Op1& o1, const Op2& o2, const Op3& o3,
                        const Op4& o4, const Op5& o5, const Op6& o6,
                        const Op7& o7)
      : edge1_(o1),
        edge2_(o2),
        edge3_(o3),
        edge4_(o4),
        edge5_(o5),
        edge6_(o6),
        edge7_(o7) {}
  operands_and_partials(const Op1& o1, const Op2& o2, const Op3& o3,
                        const Op4& o4, const Op5& o5, const Op6& o6,
                        const Op7& o7, const Op8& o8)
      : edge1_(o1),
        edge2_(o2),
        edge3_(o3),
        edge4_(o4),
        edge5_(o5),
        edge6_(o6),
        edge7_(o7),
        edge8_(o8) {}
 
  T_return_type build(Dx value) {
    Dx deriv = edge1_.dx() + edge2_.dx() + edge3_.dx() + edge4_.dx()
               + edge5_.dx() + edge6_.dx() + edge7_.dx() + edge8_.dx();
    return T_return_type(value, deriv);
  }
};
 
}  // namespace math
}  // namespace stan
#endif