uls_inform_type structure

#include <galahad_uls.h>

struct uls_inform_type {
    // fields

    ipc_ status;
    ipc_ alloc_status;
    char bad_alloc[81];
    ipc_ more_info;
    int64_t out_of_range;
    int64_t duplicates;
    int64_t entries_dropped;
    int64_t workspace_factors;
    ipc_ compresses;
    int64_t entries_in_factors;
    ipc_ rank;
    ipc_ structural_rank;
    ipc_ pivot_control;
    ipc_ iterative_refinements;
    bool alternative;
    char solver[21];
    struct gls_ainfo gls_ainfo;
    struct gls_finfo gls_finfo;
    struct gls_sinfo gls_sinfo;
    struct ma48_ainfo ma48_ainfo;
    struct ma48_finfo ma48_finfo;
    struct ma48_sinfo ma48_sinfo;
    ipc_ lapack_error;
};

detailed documentation

inform derived type as a C struct

components

ipc_ status

reported return status:

• 0

  success

• -1

  allocation error

• -2

  deallocation error

• -3

  matrix data faulty (m < 1, n < 1, ne < 0)

• -26

  unknown solver

• -29

  unavailable option

• -31

  input order is not a permutation or is faulty in some other way

• -32

  error with integer workspace

• -33

  error with real workspace

• -50

  solver-specific error; see the solver’s info parameter

ipc_ alloc_status

STAT value after allocate failure.

char bad_alloc[81]

name of array which provoked an allocate failure

ipc_ more_info

further information on failure

int64_t out_of_range

number of indices out-of-range

int64_t duplicates

number of duplicates

int64_t entries_dropped

number of entries dropped during the factorization

int64_t workspace_factors

predicted or actual number of reals and integers to hold factors

ipc_ compresses

number of compresses of data required

int64_t entries_in_factors

number of entries in factors

ipc_ rank

estimated rank of the matrix

ipc_ structural_rank

structural rank of the matrix

ipc_ pivot_control

pivot control:

• 1

  Threshold Partial Pivoting has been used

• 2

  Threshold Rook Pivoting has been used

• 3

  Threshold Complete Pivoting has been desired

• 4

  Threshold Symmetric Pivoting has been desired

• 5

  Threshold Diagonal Pivoting has been desired

ipc_ iterative_refinements

number of iterative refinements performed

bool alternative

has an “alternative” y: A^T y = 0 and yT b > 0 been found when trying to solve A x = b ?

char solver[21]

name of external solver used to factorize and solve

struct gls_ainfo gls_ainfo

the output arrays from GLS

struct gls_finfo gls_finfo

see gls_ainfo

struct gls_sinfo gls_sinfo

see gls_ainfo

struct ma48_ainfo ma48_ainfo

the output arrays from HSL’s MA48

struct ma48_finfo ma48_finfo

see ma48_ainfo

struct ma48_sinfo ma48_sinfo

see ma48_ainfo

ipc_ lapack_error

the LAPACK error return code