vsip_dchold_create_p - Create Cholesky Decomposition Object

Core

This manual is preliminary and incomplete.
While our Core implementation implements all functions given in the standard we are still working on completing this documentation.

Please refer to the VSIPL standard for a complete function reference of the Core profile until we have completed work on this documentation.

[next] [prev] [prev-tail] [tail] [up]

6.4.1 vsip_dchold_create_p - Create Cholesky Decomposition Object

typedef enum _vsip_mat_uplo { 
  VSIP_TR_LOW = 0, // Lower triangular 
  VSIP_TR_UPP = 1  // Upper triangular 
} vsip_mat_uplo; 
 
vsip_chol_f* vsip_chold_create_f(vsip_mat_uplo uplo, vsip_length n); 
vsip_cchol_f* vsip_cchold_create_f(vsip_mat_uplo uplo, vsip_length n);

Description

This function creates a Cholesky decomposition object for a symmetric positive definite matrix of size $n ×n$ . The Cholesky decomposition expresses a matrix $A$ as the product of a lower triangular matrix $L$ and its transpose: $T A = LL$ (when uplo = VSIP_MAT_LOWER) or $T A = U U$ (when uplo = VSIP_MAT_UPPER).

Parameters

vsip_mat_uplo uplo: Specifies whether to store the upper (VSIP_MAT_UPP) or lower (VSIP_MAT_LOW) triangle of the matrix.
vsip_length n: The dimension of the square matrix ( $n ×n$ ).

Return Value

On success: Pointer to the newly created Cholesky decomposition object
On error (e.g., memory allocation failure): NULL

Example

vsip_chol_f *chold; 
vsip_length n = 100; 
 
// Create Cholesky decomposition object for lower triangle 
chold = vsip_chold_create_f(VSIP_MAT_LOW, n); 
if (chold == NULL) { 
    fprintf(stderr, "Error: Could not create Cholesky object\n"); 
    return -1; 
}

Notes

The matrix must be symmetric and positive definite, otherwise the decomposition will fail.
The object should be freed with vsip_dchold_destroy_p when no longer needed.

[next] [prev] [prev-tail] [front] [up]