ordered_constrain.hpp

Go to the documentation of this file.

#ifndef STAN_MATH_PRIM_CONSTRAINT_ORDERED_CONSTRAIN_HPP
#define STAN_MATH_PRIM_CONSTRAINT_ORDERED_CONSTRAIN_HPP
 
#include <stan/math/prim/meta.hpp>
#include <stan/math/prim/fun/Eigen.hpp>
#include <stan/math/prim/fun/exp.hpp>
#include <stan/math/prim/fun/sum.hpp>
#include <stan/math/prim/fun/to_ref.hpp>
#include <cmath>
 
namespace stan {
namespace math {
 
template <typename EigVec, require_eigen_col_vector_t<EigVec>* = nullptr,
          require_not_st_var<EigVec>* = nullptr>
inline plain_type_t<EigVec> ordered_constrain(const EigVec& x) {
  using std::exp;
  Eigen::Index k = x.size();
  plain_type_t<EigVec> y(k);
  const auto& x_ref = to_ref(x);
  if (unlikely(k == 0)) {
    return y;
  }
  y[0] = x_ref[0];
  for (Eigen::Index i = 1; i < k; ++i) {
    y.coeffRef(i) = y.coeff(i - 1) + exp(x_ref.coeff(i));
  }
  return y;
}
 
template <typename EigVec, typename Lp,
          require_eigen_col_vector_t<EigVec>* = nullptr,
          require_convertible_t<value_type_t<EigVec>, Lp>* = nullptr>
inline auto ordered_constrain(const EigVec& x, Lp& lp) {
  const auto& x_ref = to_ref(x);
  if (likely(x.size() > 1)) {
    lp += sum(x_ref.tail(x.size() - 1));
  }
  return ordered_constrain(x_ref);
}
 
template <typename T, require_std_vector_t<T>* = nullptr>
inline auto ordered_constrain(const T& x) {
  return apply_vector_unary<T>::apply(
      x, [](auto&& v) { return ordered_constrain(v); });
}
 
template <typename T, typename Lp, require_std_vector_t<T>* = nullptr,
          require_convertible_t<return_type_t<T>, Lp>* = nullptr>
inline auto ordered_constrain(const T& x, Lp& lp) {
  return apply_vector_unary<T>::apply(
      x, [&lp](auto&& v) { return ordered_constrain(v, lp); });
}
 
template <bool Jacobian, typename T, typename Lp,
          require_convertible_t<return_type_t<T>, Lp>* = nullptr>
inline auto ordered_constrain(const T& x, Lp& lp) {
  if constexpr (Jacobian) {
    return ordered_constrain(x, lp);
  } else {
    return ordered_constrain(x);
  }
}
 
}  // namespace math
}  // namespace stan
 
#endif