KmlIssCgGet?I?

Obtain parameters related to iterative solution.

Interface Definition

C interface:

int KmlIssCgGetSII(KmlSolverTask **handle, enum KML_SOLVER_PARAM param, int *data, int nd);

int KmlIssCgGetDII(KmlSolverTask **handle, enum KML_SOLVER_PARAM param, int *data, int nd);

int KmlIssCgGetSIS(KmlSolverTask **handle, enum KML_SOLVER_PARAM param, float *data, int nd);

int KmlIssCgGetDID(KmlSolverTask **handle, enum KML_SOLVER_PARAM param, double *data, int nd);

Parameters

Parameter	Type	Description	Input/Output
handle	KmlSolverTask **	Solver handle, which is a variable transferred previously	Input/Output
param	enum KML_SOLVER_PARAM	ITERATION_COUNT indicates the number of iterations. TOLERANCE indicates the final iteration residual.	Input
data	int * in KmlIssCgGetSII int * in KmlIssCgGetDII float * in KmlIssCgGetSIS double * in KmlIssCgGetDID	Number of iteration steps in KmlIssCgGetSII Number of iteration steps in KmlIssCgGetDII Residual in KmlIssCgGetSIS Residual in KmlIssCgGetDID	Input
nd	int	Number of elements in the data array	Input

Return Values

Return Value	Type	Description
NO_ERROR	int	The execution is successful.
DATA_SIZE_ERROR	int	The number of data records is incorrect.
KML_SOLVER_INVALID_ARGUMENT	int	Invalid parameter.

Dependencies

#include "kml_iss.h"

Examples

C interface:

    KmlSolverTask *handle
    int n = 8;   
    double a[17] = { 1.0,1.0,2.0,9.0,2.0,1.0,-3.0,3.0,2.0,9.0,-5.0,6.0,1.0,4.0,1.0,7.0,2.0 };
    int ja[17] = { 0,3,4,1,2,3,5,2,7,3,6,4,5,5,7,6,7 };
    int ia[9] = {0, 3, 7, 9, 11, 13, 15, 16, 17};
    int nb = 1;
    double x[8];
    int ldx = n;
    double b[8] = {4.0, 9.0, 7.0, 6.0, 9.0, 3.0, 2.0, 5.0};
    int ldb = n;
    int data[] = {0};
    int nd = 1;
    double data1[] = {0};
    KML_SOLVER_PARAM param = ITERATION_COUNT;
    int ierr;
    ierr = KmlIssCgInitDI(&handle, n, a, ja, ia);
    ierr = KmlIssCgAnalyzeDI(&handle);
    ierr = KmlIssCgFactorizeDI(&handle);
    ierr = KmlIssCgSolveDI(&handle, nb, x, ldx, b, ldb);
    ierr = KmlIssCgGetDII(&handle, param, data, nd);
    param = TOLERANCE;
    ierr = KmlIssCgGetDID(&handle, param, data1, nd);

Parent topic: CG