nls_inform_type structure#

#include <galahad_nls.h>

struct nls_inform_type {
    // components

    ipc_ status;
    ipc_ alloc_status;
    char bad_alloc[81];
    char bad_eval[13];
    ipc_ iter;
    ipc_ cg_iter;
    ipc_ c_eval;
    ipc_ j_eval;
    ipc_ h_eval;
    ipc_ factorization_max;
    ipc_ factorization_status;
    int64_t max_entries_factors;
    int64_t factorization_integer;
    int64_t factorization_real;
    rpc_ factorization_average;
    rpc_ obj;
    rpc_ norm_c;
    rpc_ norm_g;
    rpc_ weight;
    struct nls_time_type time;
    struct rqs_inform_type rqs_inform;
    struct glrt_inform_type glrt_inform;
    struct psls_inform_type psls_inform;
    struct bsc_inform_type bsc_inform;
    struct roots_inform_type roots_inform;
    struct nls_subproblem_inform_type subproblem_inform;
};

detailed documentation#

inform derived type as a C struct

components#

ipc_ status

return status. See NLS_solve for details

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

char bad_eval[13]

the name of the user-supplied evaluation routine for which an error occurred

ipc_ iter

the total number of iterations performed

ipc_ cg_iter

the total number of CG iterations performed

ipc_ c_eval

the total number of evaluations of the residual function c(x)

ipc_ j_eval

the total number of evaluations of the Jacobian J(x) of c(x)

ipc_ h_eval

the total number of evaluations of the scaled Hessian H(x,y) of c(x)

ipc_ factorization_max

the maximum number of factorizations in a sub-problem solve

ipc_ factorization_status

the return status from the factorization

int64_t max_entries_factors

the maximum number of entries in the factors

int64_t factorization_integer

the total integer workspace required for the factorization

int64_t factorization_real

the total real workspace required for the factorization

rpc_ factorization_average

the average number of factorizations per sub-problem solve

rpc_ obj

the value of the objective function \(\frac{1}{2}\|c(x)\|^2_W\) at the best estimate the solution, x, determined by NLS_solve

rpc_ norm_c

the norm of the residual \(\|c(x)\|_W\) at the best estimate of the solution x, determined by NLS_solve

rpc_ norm_g

the norm of the gradient of \(\|c(x)\|_W\) of the objective function at the best estimate, x, of the solution determined by NLS_solve

rpc_ weight

the final regularization weight used

struct nls_time_type time

timings (see above)

struct rqs_inform_type rqs_inform

inform parameters for RQS

struct glrt_inform_type glrt_inform

inform parameters for GLRT

struct psls_inform_type psls_inform

inform parameters for PSLS

struct bsc_inform_type bsc_inform

inform parameters for BSC

struct roots_inform_type roots_inform

inform parameters for ROOTS

struct nls_subproblem_inform_type subproblem_inform

inform parameters for subproblem