spm_get_diagonal_zeros.c

Go to the documentation of this file.

/**
 *
 * @file spm_get_diagonal_zeros.c
 *
 * SParse Matrix package routine to detect unknowns with zero or absent entry on
 * the diagonal.
 *
 * @copyright 2016-2026 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
 *                      Univ. Bordeaux. All rights reserved.
 *
 * @version 1.3.0
 * @author Fatima-Zahra Salhi
 * @date 2026-07-09
 * @addtogroup spm
 * @{
 **/
#include "common.h"
 
/**
 *******************************************************************************
 *
 * @ingroup spm
 *
 * @brief Detect unknowns whose diagonal entry is zero or absent
 *
 *******************************************************************************
 *
 * @param[in] spm
 *          The sparse matrix.
 *
 * @param[out] zeros_n
 *          The number of unknowns with a zero or missing diagonal entry.
 *
 * @param[out] zeros_list
 *          Array containing the indices of unknowns with a zero or missing
 *          diagonal entry. The caller is responsible for freeing this array.
 *
 *******************************************************************************
 *
 * @retval SPM_SUCCESS
 *          Success.
 *
 * @retval SPM_ERR_BADPARAMETER
 *          If the coefficient type or the sparse matrix format is unsupported.
 *
 * @retval SPM_ERR_OUTOFMEMORY
 *          If the internal allocation of zeros_list failed.
 *
 *******************************************************************************/
 
int
spmGetDiagonalZeros( const spmatrix_t *spm,
                     spm_int_t        *zeros_n,
                     spm_int_t       **zeros_list )
{
    int ret;
 
    *zeros_n    = 0;
    *zeros_list = NULL;
 
    switch ( spm->flttype ) {
    case SpmFloat:
        ret = s_spmGetDiagonalZeros( spm, zeros_n, zeros_list );
        break;
 
    case SpmDouble:
        ret = d_spmGetDiagonalZeros( spm, zeros_n, zeros_list );
        break;
 
    case SpmComplex32:
        ret = c_spmGetDiagonalZeros( spm, zeros_n, zeros_list );
        break;
 
    case SpmComplex64:
        ret = z_spmGetDiagonalZeros( spm, zeros_n, zeros_list );
        break;
 
    case SpmPattern:
    default:
        ret = SPM_ERR_BADPARAMETER;
    }
 
    return ret;
}