prob_constrain() [3/3]

template<bool Jacobian, typename T >

auto stan::math::prob_constrain ( const T &  x, T &  lp  )

inline

Return a probability value constrained to fall between 0 and 1 (inclusive) for the specified free scalar.

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	type of scalar

Parameters

[in]	x	unconstrained value
[in,out]	lp	log density accumulator

Returns

result constrained to fall in (0, 1)

Definition at line 72 of file prob_constrain.hpp.