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 transfers a variable defined previously.	Input/Output
param	enum KML_SOLVER_PARAM	KMLSS_ITERATION_COUNT indicates the number of iterations. KMLSS_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.	Output
nd	int	Number of elements in the data array.	Input

Return Values

Return Value	Type	Description
KMLSS_NO_ERROR	int	The execution is successful.
KMLSS_DATA_SIZE	int	The value of nd is not 1.
KMLSS_NULL_ARGUMENT	int	A null argument exists in {handle, data}.
KMLSS_BAD_SELECTOR	int	Parameter param is invalid.

Dependency

#include "kml_iss.h"

Example

C interface:

KmlSolverTask *handle;
int ierr;
int n = 8;  

double a[26] = {1.0, 1.0, 2.0, 9.0, 2.0, 1.0, -3.0, 2.0, 3.0, 2.0, 1.0, 1.0, 9.0, -5.0, 2.0, 6.0, 1.0, -3.0, 1.0, 4.0, 1.0, -5.0, 7.0, 2.0,1.0, 2.0};
int ja[26] = {0, 3, 4, 1, 2, 3, 5, 1, 2, 7, 0, 1, 3, 6, 0, 4, 5, 1, 4, 5, 7, 3, 6, 2, 5, 7};
int ia[9] = {0, 3, 7, 10, 14, 17, 21, 23, 26};

ierr = KmlIssCgInitDI(&handle, n, a, ja, ia);
ierr = KmlIssCgAnalyzeDI(&handle);
ierr = KmlIssCgFactorizeDI(&handle);

int nd = 1;
int idata[] = {0};
double ddata[] = {0};
double eps = 1e-4;
ierr = KmlIssCgSetDID(&handle, KMLSS_THRESHOLD, &eps, nd);
int max_iters = 2000;
ierr = KmlIssCgSetDII(&handle, KMLSS_MAX_ITERATION_COUNT, &max_iters, nd);

int ldx = n;
int ldb = n; 
int nb = 1;
double b[8] = {4.0, 9.0, 7.0, 6.0, 9.0, 3.0, 2.0, 5.0};
double x[8];
ierr = KmlIssCgSolveDI(&handle, nb, x, ldx, b, ldb);
ierr = KmlIssCgGetDII(&handle, KMLSS_ITERATION_COUNT, idata, nd);
if (ierr != 0) {
    printf("\nERROR in KmlIssCgGetDII: %d", ierr);
    return 1;
    }
ierr = KmlIssCgGetDID(&handle, KMLSS_TOLERANCE, ddata, nd);
if (ierr != 0) {
    printf("\nERROR in KmlIssCgGetDID: %d", ierr);
    return 1;
    }
printf("[Solve info] Res= \t%.12g\t, iteration = \t%d\t\n", sqrt(ddata[0]), idata[0]); 

Output:

[Solve info] Res=       1.25581676326e-12       , iteration =   8

Parent topic: CG