read_corr_matrix() [4/4]

template<typename T_CPCs , require_var_vector_t< T_CPCs > * = nullptr>

var_value< Eigen::MatrixXd > stan::math::read_corr_matrix ( const T_CPCs &  CPCs, size_t  K, scalar_type_t< T_CPCs > &  log_prob  )

inline

Return the correlation matrix of the specified dimensionality corresponding to the specified canonical partial correlations, incrementing the specified scalar reference with the log absolute determinant of the Jacobian of the transformation.

It is usually preferable to utilize the version that returns the Cholesky factor of the correlation matrix rather than the correlation matrix itself in statistical calculations.

Template Parameters

T_CPCs

type of input vector (must be a var_value<T> where T inherits from EigenBase)

Parameters

CPCs	The (K choose 2) canonical partial correlations in (-1, 1).
K	Dimensionality of correlation matrix.
log_prob	Reference to variable to increment with the log Jacobian determinant.

Returns

Correlation matrix for specified partial correlations.

Definition at line 56 of file read_corr_matrix.hpp.