Rate This Document
Findability
Accuracy
Completeness
Readability

KmlScaissCsiGet?I?

Obtain parameters related to iterative solution.

Interface Definition

C interface:

int KmlScaissCsiGetSII(KmlScasolverTask **handle, enum KmlSolverParam param, int *data, int nd);

int KmlScaissCsiGetSIS(KmlScasolverTask **handle, enum KmlSolverParam param, float *data, int nd);

int KmlScaissCsiGetDII(KmlScasolverTask **handle, enum KmlSolverParam param, int *data, int nd);

int KmlScaissCsiGetDID(KmlScasolverTask **handle, enum KmlSolverParam param, double *data, int nd);

Parameters

Parameter

Type

Description

Input/Output

handle

KmlScasolverTask **

Solver handle, which is a variable passed from a previous step.

Input/Output

param

enum KmlSolverParam

  • KMLSS_ITERATION_COUNT indicates the number of iterations.
  • KMLSS_MAX_ITERATION_COUNT indicates the maximum number of iterations.
  • KMLSS_TOLERANCE indicates the relative residual in the final iteration.
  • KMLSS_THRESHOLD indicates the configured relative residual.

Input

data

  • int * in KmlScaissCsiGetSII/KmlScaissCsiGetDII
  • float * in KmlScaissCsiGetSIS
  • double * in KmlScaissCsiGetDID

-

Output

nd

int

Number of elements in the data array.

Input

Return Value

Return Value

Type

Description

KMLSS_NO_ERROR

int

Normal execution.

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

param is invalid.

Dependencies

#include "kml_scaiss.h"

For details about the sample code, see Samples.