Error codes

Interface function return values and error codes. More...

Macros
#define	STARNEIG_SUCCESS   0
	Success. More...
#define	STARNEIG_GENERIC_ERROR   1
	Reneric error. More...
#define	STARNEIG_NOT_INITIALIZED   2
	Not initialized. More...
#define	STARNEIG_INVALID_CONFIGURATION   3
	Invalid configuration. More...
#define	STARNEIG_INVALID_ARGUMENTS   4
	Invalid argument. More...
#define	STARNEIG_INVALID_DISTR_MATRIX   5
	Invalid distributed matrix. More...
#define	STARNEIG_DID_NOT_CONVERGE   6
	Did not converge. More...
#define	STARNEIG_PARTIAL_REORDERING   7
	Partial reordering. More...
#define	STARNEIG_CLOSE_EIGENVALUES   8
	Close eigenvalues. More...

Typedefs
typedef int	starneig_error_t
	Interface function return value data type.

Detailed Description

Interface function return values and error codes.

Macro Definition Documentation

STARNEIG_SUCCESS

#define STARNEIG_SUCCESS   0

Success.

The interface function was executed successfully.

STARNEIG_GENERIC_ERROR

#define STARNEIG_GENERIC_ERROR   1

Reneric error.

The interface function encountered a generic error.

STARNEIG_NOT_INITIALIZED

#define STARNEIG_NOT_INITIALIZED   2

Not initialized.

The library was not initialized when the interface function was called.

STARNEIG_INVALID_CONFIGURATION

#define STARNEIG_INVALID_CONFIGURATION   3

Invalid configuration.

The interface function encountered an invalid configuration argument.

STARNEIG_INVALID_ARGUMENTS

#define STARNEIG_INVALID_ARGUMENTS   4

Invalid argument.

The interface function encountered an invalid argument.

STARNEIG_INVALID_DISTR_MATRIX

#define STARNEIG_INVALID_DISTR_MATRIX   5

Invalid distributed matrix.

One or more of the involved distributed matrices have an invalid distribution, invalid dimensions and/or an invalid distributed block size.

STARNEIG_DID_NOT_CONVERGE

#define STARNEIG_DID_NOT_CONVERGE   6

Did not converge.

The interface function encountered a situation where the QR/QZ algorithm did not converge. The matrix (pair) may be partially in (generalized) Schur form.

STARNEIG_PARTIAL_REORDERING

#define STARNEIG_PARTIAL_REORDERING   7

Partial reordering.

The interface function failed to reorder the (generalized) Schur form. The (generalized) Schur form may be partially reordered.

STARNEIG_CLOSE_EIGENVALUES

#define STARNEIG_CLOSE_EIGENVALUES   8

Close eigenvalues.

The interface function encountered a situation where two selected eigenvalues were close to each other. The computed result may be inaccurate.