ub_constrain.hpp

Go to the documentation of this file.

#ifndef STAN_MATH_PRIM_CONSTRAINT_UB_CONSTRAIN_HPP
#define STAN_MATH_PRIM_CONSTRAINT_UB_CONSTRAIN_HPP
 
#include <stan/math/prim/meta.hpp>
#include <stan/math/prim/err.hpp>
#include <stan/math/prim/fun/constants.hpp>
#include <stan/math/prim/fun/exp.hpp>
#include <stan/math/prim/constraint/identity_constrain.hpp>
#include <stan/math/prim/constraint/identity_free.hpp>
#include <stan/math/prim/fun/subtract.hpp>
#include <stan/math/prim/fun/sum.hpp>
#include <stan/math/prim/fun/value_of.hpp>
#include <cmath>
 
namespace stan {
namespace math {
 
template <typename T, typename U, require_all_stan_scalar_t<T, U>* = nullptr,
          require_all_not_st_var<T, U>* = nullptr>
inline auto ub_constrain(const T& x, const U& ub) {
  if (value_of_rec(ub) == INFTY) {
    return identity_constrain(x, ub);
  } else {
    return subtract(ub, exp(x));
  }
}
 
template <typename T, typename U, typename Lp,
          require_all_stan_scalar_t<T, U>* = nullptr,
          require_all_not_st_var<T, U>* = nullptr,
          require_convertible_t<return_type_t<T, U>, Lp>* = nullptr>
inline auto ub_constrain(const T& x, const U& ub, Lp& lp) {
  if (value_of_rec(ub) == INFTY) {
    return identity_constrain(x, ub);
  } else {
    lp += x;
    return subtract(ub, exp(x));
  }
}
 
template <typename T, typename U, require_eigen_t<T>* = nullptr,
          require_stan_scalar_t<U>* = nullptr,
          require_all_not_st_var<T, U>* = nullptr>
inline auto ub_constrain(const T& x, const U& ub) {
  return eval(x.unaryExpr([ub](auto&& xx) { return ub_constrain(xx, ub); }));
}
 
template <typename T, typename U, typename Lp, require_eigen_t<T>* = nullptr,
          require_stan_scalar_t<U>* = nullptr,
          require_all_not_st_var<T, U>* = nullptr,
          require_convertible_t<return_type_t<T, U>, Lp>* = nullptr>
inline auto ub_constrain(const T& x, const U& ub, Lp& lp) {
  return eval(
      x.unaryExpr([ub, &lp](auto&& xx) { return ub_constrain(xx, ub, lp); }));
}
 
template <typename T, typename U, require_all_eigen_t<T, U>* = nullptr,
          require_all_not_st_var<T, U>* = nullptr>
inline auto ub_constrain(const T& x, const U& ub) {
  check_matching_dims("ub_constrain", "x", x, "ub", ub);
  return eval(x.binaryExpr(
      ub, [](auto&& xx, auto&& ubb) { return ub_constrain(xx, ubb); }));
}
 
template <typename T, typename U, typename Lp,
          require_all_eigen_t<T, U>* = nullptr,
          require_all_not_st_var<T, U>* = nullptr,
          require_convertible_t<return_type_t<T, U>, Lp>* = nullptr>
inline auto ub_constrain(const T& x, const U& ub, Lp& lp) {
  check_matching_dims("ub_constrain", "x", x, "ub", ub);
  return eval(x.binaryExpr(
      ub, [&lp](auto&& xx, auto&& ubb) { return ub_constrain(xx, ubb, lp); }));
}
 
template <typename T, typename U, require_not_std_vector_t<U>* = nullptr>
inline auto ub_constrain(const std::vector<T>& x, const U& ub) {
  std::vector<plain_type_t<decltype(ub_constrain(x[0], ub))>> ret(x.size());
  for (size_t i = 0; i < x.size(); ++i) {
    ret[i] = ub_constrain(x[i], ub);
  }
  return ret;
}
 
template <typename T, typename U, typename Lp,
          require_convertible_t<return_type_t<T, U>, Lp>* = nullptr,
          require_not_std_vector_t<U>* = nullptr>
inline auto ub_constrain(const std::vector<T>& x, const U& ub, Lp& lp) {
  std::vector<plain_type_t<decltype(ub_constrain(x[0], ub))>> ret(x.size());
  for (size_t i = 0; i < x.size(); ++i) {
    ret[i] = ub_constrain(x[i], ub, lp);
  }
  return ret;
}
 
template <typename T, typename U>
inline auto ub_constrain(const std::vector<T>& x, const std::vector<U>& ub) {
  check_matching_dims("ub_constrain", "x", x, "ub", ub);
  std::vector<plain_type_t<decltype(ub_constrain(x[0], ub[0]))>> ret(x.size());
  for (size_t i = 0; i < x.size(); ++i) {
    ret[i] = ub_constrain(x[i], ub[i]);
  }
  return ret;
}
 
template <typename T, typename U, typename Lp,
          require_convertible_t<return_type_t<T, U>, Lp>* = nullptr>
inline auto ub_constrain(const std::vector<T>& x, const std::vector<U>& ub,
                         Lp& lp) {
  check_matching_dims("ub_constrain", "x", x, "ub", ub);
  std::vector<plain_type_t<decltype(ub_constrain(x[0], ub[0]))>> ret(x.size());
  for (size_t i = 0; i < x.size(); ++i) {
    ret[i] = ub_constrain(x[i], ub[i], lp);
  }
  return ret;
}
 
template <bool Jacobian, typename T, typename U, typename Lp,
          require_convertible_t<return_type_t<T, U>, Lp>* = nullptr>
inline auto ub_constrain(const T& x, const U& ub, Lp& lp) {
  if constexpr (Jacobian) {
    return ub_constrain(x, ub, lp);
  } else {
    return ub_constrain(x, ub);
  }
}
 
}  // namespace math
}  // namespace stan
 
#endif