bsc_inform_type structure#

#include <galahad_bsc.h>

struct bsc_inform_type {
    // fields

    ipc_ status;
    ipc_ alloc_status;
    char bad_alloc[81];
    ipc_ max_col_a;
    ipc_ exceeds_max_col;
    rpc_ time;
    rpc_ clock_time;
};

detailed documentation#

inform derived type as a C struct

components#

ipc_ status

the return status from the package. Possible values are:

  • 0

    The call was succcesful

  • -1

    An allocation error occurred. A message indicating the offending array is written on unit control.error, and the returned allocation status and a string containing the name of the offending array are held in inform.alloc_status and inform.bad_alloc respectively.

  • -2

    A deallocation error occurred. A message indicating the offending array is written on unit control.error and the returned allocation status and a string containing the name of the offending array are held in inform.alloc_status and inform.bad_alloc respectively.

  • -3

    The restrictions n > 0 or m > 0 or requirement that a type contains its relevant string ‘dense’, ‘coordinate’ or ‘sparse_by_rows’ has been violated.

ipc_ alloc_status

the status of the last attempted allocation/deallocation

char bad_alloc[81]

the name of the array for which an allocation/deallocation error occurred.

ipc_ max_col_a

the maximum number of entries in a column of \(A\)

ipc_ exceeds_max_col

the number of columns of \(A\) that have more than control.max_col entries

rpc_ time

the total CPU time spent in the package

rpc_ clock_time

the total clock time spent in the package