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

pxerbla

Error handling routine called by ScaLAPACK routines.

Syntax

void pxerbla (MKL_INT* ictxt, char* srname, MKL_INT* info, MKL_INT srname_len);

Include Files
  • mkl_scalapack.h
Input Parameters
ictxt

(local)

MKL_INT*

The BLACS context handle, indicating the global context of the operation. The context itself is global.

srname

(global)

char*

The name of the routine that called pxerbla.

info

(global)

MKL_INT*

The position of the invalid parameter in the parameter list of the calling routine.

srname_len

(global)

MKL_INT

The length of the calling routine name.

Description

This routine is an error handler for the ScaLAPACK routines. It is called if an input parameter has an invalid value. A message is printed and program execution continues. For ScaLAPACK driver and computational routines, a RETURN statement is issued following the call to pxerbla.

Control returns to the higher-level calling routine, and you can determine how the program should proceed. However, in the specialized low-level ScaLAPACK routines (auxiliary routines that are Level 2 equivalents of computational routines), the call to pxerbla() is immediately followed by a call to BLACS_ABORT() to terminate program execution since recovery from an error at this level in the computation is not possible.

It is always good practice to check for a non-zero value of info on return from a ScaLAPACK routine. Installers may consider modifying this routine in order to call system-specific exception-handling facilities.