Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 12/16/2022
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

dcg_check

Checks consistency and correctness of the user defined data.

Syntax

void dcg_check (const MKL_INT *n , const double *x , const double *b , MKL_INT *RCI_request , MKL_INT *ipar , double *dpar , double *tmp );

Include Files
  • mkl.h
Description

The routine dcg_check checks consistency and correctness of the parameters to be passed to the solver routine dcg. However this operation does not guarantee that the solver returns the correct result. It only reduces the chance of making a mistake in the parameters of the method. Skip this operation only if you are sure that the correct data is specified in the solver parameters.

The lengths of all vectors must be defined in a previous call to the dcg_init routine.

If none of the stopping criteria (ipar[7]-ipar[9]) has been enabled, both ipar[7] and ipar[8] will be set to 1.

Input Parameters
ipar

Array of size 128. Refer to the FGMRES Common Parameters.

n

Sets the size of the problem.

x

Array of size n. Contains the initial approximation to the solution vector. Normally it is equal to 0 or to b.

b

Array of size n. Contains the right-hand side vector.

Output Parameters
RCI_request

Gives information about result of the routine.

ipar

Array of size 128. Refer to the CG Common Parameters. Only ipar[7]-ipar[8] might be changed

dpar

Array of size 128. Refer to the CG Common Parameters.

tmp

Array of size (n*4). Refer to the CG Common Parameters.

Return Values
RCI_request= 0

Indicates that the task completed normally.

RCI_request= -1100

Indicates that the task is interrupted and the errors occur.

RCI_request= -1001

Indicates that there are some warning messages.

RCI_request= -1010

Indicates that the routine changed some parameters to make them consistent or correct.

RCI_request= -1011

Indicates that there are some warning messages and that the routine changed some parameters.