positive_ordered_constrain() [2/4]

template<typename Vec , typename Lp , require_col_vector_t< Vec > * = nullptr, require_convertible_t< return_type_t< Vec >, Lp > * = nullptr>

auto stan::math::positive_ordered_constrain ( const Vec &  x, Lp &  lp  )

inline

Return a positive valued, increasing positive ordered vector derived from the specified free vector and increment the specified log probability reference with the log absolute Jacobian determinant of the transform.

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

The returned constrained vector will have the same dimensionality as the specified free vector.

Template Parameters

Vec	type of the vector
Lp	A scalar type for the lp argument. The scalar type of Vec should be convertable to this.

Parameters

x	Free vector of scalars.
lp	Log probability reference.

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
Vec	A type inheriting from Eigen::EigenBase, a var_value with inner type inheriting from Eigen::EigenBase, or a vector thereof
Lp	A scalar type for the lp argument. The scalar type of Vec should be convertable to this.

Parameters

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

Returns

Positive, increasing ordered vector

Definition at line 56 of file positive_ordered_constrain.hpp.