Rate This Document
Findability
Accuracy
Completeness
Readability

KmlIssGcrSet?I?

Set parameters related to iterative solution.

Interface Definition

C interface:

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

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

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

int KmlIssGcrSetDID(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.
  • RESTART_PARAM indicates the number of vectors to be cleared before the next iteration.

Input

data

  • const int * in KmlIssGcrSetSII
  • const int * in KmlIssGcrSetDII
  • const float * in KmlIssGcrSetSIS
  • const double * in KmlIssGcrSetDID

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

Input

nd

int

Size of 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[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};

    KML_SOLVER_PARAM param = MAX_ITERATIONS_COUNT;
    int data[] = {1000,30};
    int *p;
    double data1[] = {1e-5};
    int nd = 1;
    int ierr;
    ierr = KmlIssGcrInitDI(&handle, n, a, ja, ia);
    p = data;
    ierr = KmlIssGcrSetSII(&handle, param, p, nd);
    param = RESTART_PARAM;
    p = p + 1;
    ierr = KmlIssGcrSetSII(&handle, param, p, nd);
    param = THRESHOLD;
    ierr = KmlIssGcrSetDII(&handle, param, data1, nd);