Rate This Document
Findability
Accuracy
Completeness
Readability

KmlIssCgSet?I?

Set parameters related to iterative solution.

Interface Definition

C interface:

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

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

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

int KmlIssCgSetDID(KmlSolverTask **handle, enum KML_SOLVER_PARAM param, const 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

  • THRESHOLD indicates the iteration residual threshold.
  • MAX_ITERATIONS_COUNT indicates the maximum number of iterations.

Input

data

  • const int * in KmlIssCgSetSII
  • const int * in KmlIssCgSetDII
  • const float * in KmlIssCgSetSIS
  • const double * in KmlIssCgSetDID

Iterative solution-related parameter array (for example, maximum number of iterations)

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};
    KmlIssCgInitDI(&handle, n, a, ja, ia);
    KML_SOLVER_PARAM param = MAX_ITERATIONS_COUNT;
    int data[] = {1000};
    double data1[] = {1e-5};
    int nd = 1;
    int ierr;
    ierr = KmlIssCgSetDII(&handle, param, data, nd);
    param = THRESHOLD;
    ierr = KmlIssCgSetDID(&handle, param, data1, nd);