unit_vector_constrain() [9/11]

template<bool Jacobian, typename T , require_not_std_vector_t< T > * = nullptr>

auto stan::math::unit_vector_constrain ( const T &  y, return_type_t< T > &  lp  )

inline

Return the unit length vector corresponding to the free vector y.

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::DenseBase or a var_value with inner type inheriting from Eigen::DenseBase with compile time dynamic rows and 1 column

Parameters

	y	vector of K unrestricted variables
[in,out]	lp	log density accumulator

Returns

Unit length vector of dimension K

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 standard vector with inner type inheriting from Eigen::DenseBase or a var_value with inner type inheriting from Eigen::DenseBase with compile time dynamic rows and 1 column

Parameters

	y	vector of K unrestricted variables
[in,out]	lp	log density accumulator

Returns

Unit length vector of dimension K

Definition at line 76 of file unit_vector_constrain.hpp.