lub_constrain() [9/24]

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

auto stan::math::lub_constrain ( const T &  x, const L &  lb, const U &  ub  )

inline

Overload for Eigen matrix and matrix bounds.

Specialization for Eigen matrix and matrix bounds.

Return the lower and upper-bounded scalar derived by transforming the specified free scalar given the specified lower and upper bounds.

The transform is the transformed and scaled inverse logit,

\(f(x) = L + (U - L) \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.

Returns

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

Exceptions

std::domain_error

if ub <= lb

Definition at line 206 of file lub_constrain.hpp.