ordered_constrain() [4/5]

template<typename T , typename Lp , require_std_vector_t< T > * = nullptr, require_convertible_t< return_type_t< T >, Lp > * = nullptr>

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

inline

Return a positive valued, increasing ordered vector derived from the specified free vector.

The returned constrained vector will have the same dimensionality as the specified free vector. This overload handles looping over the elements of a standard vector.

Template Parameters

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
Lp	Scalar type for the lp argument. The scalar type of T should be convertable to this.

Parameters

	x	Free vector of scalars
[in,out]	lp	log density accumulator or empty

Returns

Positive, increasing ordered vector.

The returned constrained vector will have the same dimensionality as the specified free vector. 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, or a standard vector thereof
Lp	A scalar type for the lp argument. The scalar type of T should be convertable to this.

Parameters

	x	Free vector of scalars
[in,out]	lp	log density accumulator

Returns

Positive, increasing ordered vector.

Definition at line 101 of file ordered_constrain.hpp.