callable functions

    function gls_initialize(T, data, control)

Set default control values and initialize private data

Parameters:

data	holds private internal data
control	is a structure containing control information (see gls_control)

    function gls_read_specfile(T, control, specfile)

Read the content of a specification file, and assign values associated with given keywords to the corresponding control parameters. An in-depth discussion of specification files is available, and a detailed list of keywords with associated default values is provided in $GALAHAD/src/gls/GLS.template. See also Table 2.1 in the Fortran documentation provided in $GALAHAD/doc/gls.pdf for a list of how these keywords relate to the components of the control structure.

Parameters:

control	is a structure containing control information (see gls_control)
specfile	is a one-dimensional array of type Vararg{Cchar} that must give the name of the specification file

    function gls_import(T, control, data, status)

Import problem data into internal storage prior to solution.

Parameters:

control	is a structure whose members provide control parameters for the remaining procedures (see gls_control)
data	holds private internal data
status	is a scalar variable of type Int32 that gives the exit status from the package. Possible values are: 1 The import was successful, and the package is ready for the solve phase -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 restriction n > 0 or requirement that type contains its relevant string ‘dense’, ‘coordinate’, ‘sparse_by_rows’, ‘diagonal’ or ‘absent’ has been violated.

    function gls_reset_control(T, control, data, status)

Reset control parameters after import if required.

Parameters:

control	is a structure whose members provide control parameters for the remaining procedures (see gls_control)
data	holds private internal data
status	is a scalar variable of type Int32 that gives the exit status from the package. Possible values are: 1 The import was successful, and the package is ready for the solve phase

    function gls_information(T, data, ainfo, finfo, sinfo, status)

Provides output information

Parameters:

data	holds private internal data
ainfo	is a structure containing analysis output information (see gls_ainfo)
finfo	is a structure containing factorization output information (see gls_finfo)
sinfo	is a structure containing solver output information (see gls_sinfo)
status	is a scalar variable of type Int32 that gives the exit status from the package. Possible values are (currently): 0 The values were recorded successfully

    function gls_finalize(T, data, control, status)

Deallocate all internal private storage

Parameters:

data	holds private internal data
control	is a structure containing control information (see gls_control)
status	is a scalar variable of type Int32 that gives the exit status from the package. Possible values are (currently): 0 The values were recorded successfully