ub_constrain() [13/14]

template<bool Jacobian, typename T , typename U , typename Lp , require_convertible_t< return_type_t< T, U >, Lp > * = nullptr>

auto stan::math::ub_constrain ( const T &  x, const U &  ub, Lp &  lp  )

inline

Specialization of ub_constrain to apply a container of upper bounds elementwise to each input element.

If the Jacobian parameter is true, the log density accumulator is incremented with the log absolute Jacobian determinant of the transform. All of the transforms are specified with their Jacobians in the Stan Reference Manual chapter Constraint Transforms.

Template Parameters

Jacobian	if true, increment log density accumulator with log absolute Jacobian determinant of constraining transform
T	A type inheriting from Eigen::EigenBase, a var_value with inner type inheriting from Eigen::EigenBase, a standard vector, or a scalar
U	A type inheriting from Eigen::EigenBase, a var_value with inner type inheriting from Eigen::EigenBase, a standard vector, or a scalar
Lp	A scalar type for the lp argument. The scalar type of T and U should be convertable to this.

Parameters

[in]	x	unconstrained input
[in]	ub	upper bound on output
[in,out]	lp	log density accumulator

Returns

lower-bound constrained value corresponding to inputs

Definition at line 264 of file ub_constrain.hpp.