lub_constrain() [6/19]

template<typename T , typename L , typename U , require_all_stan_scalar_t< T, L, U > * = nullptr, require_not_var_t< return_type_t< T, L, U > > * = nullptr>

auto stan::math::lub_constrain ( T &&  x, L &&  lb, U &&  ub, return_type_t< T, L, U > &  lp  )

inline

Return the lower- and upper-bounded scalar derived by transforming the specified free scalar given the specified lower and upper bounds and increment the specified log density with the log absolute Jacobian determinant.

The transform is as defined in lub_constrain(T, double, double). The log absolute Jacobian determinant is given by

\(\log \left| \frac{d}{dx} \left( L + (U-L) \mbox{logit}^{-1}(x) \right) \right|\)

\( {} = \log | (U-L) \, (\mbox{logit}^{-1}(x)) \, (1 - \mbox{logit}^{-1}(x)) |\)

\( {} = \log (U - L) + \log (\mbox{logit}^{-1}(x)) + \log (1 - \mbox{logit}^{-1}(x))\)

Template Parameters

T	Scalar.
L	Scalar.
U	Scalar.

Parameters

[in]	x	Free scalar to transform.
[in]	lb	Lower bound.
[in]	ub	Upper bound.
[in,out]	lp	Log probability scalar reference.

Returns

Lower- and upper-bounded scalar derived from transforming the free scalar.

Exceptions

std::domain_error

if ub <= lb

Definition at line 97 of file lub_constrain.hpp.