Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 7/13/2023
Public

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

Document Table of Contents

pilaenv

Returns the positive integer value of the logical blocking size.

Syntax

MKL_INT pilaenv (const MKL_INT *ictxt , const char *prec);

Include Files

  • mkl_pblas.h

Description

pilaenv returns the positive integer value of the logical blocking size. This value is machine and precision specific. This version provides a logical blocking size which should give good though not optimal performance on many of the currently available distributed-memory concurrent computers. You are encouraged to modify this subroutine to set this tuning parameter for your particular machine.

Input Parameters

ictxt

On entry, ictxt specifies the BLACS context handle, indicating the global context of the operation. The context itself is global, but the value of ictxt is local.

prec

On input, prec specifies the precision for which the logical block size should be returned as follows:

prec = 'S' or 's' single precision real,

prec = 'D' or 'd' double precision real,

prec = 'C' or 'c' single precision complex,

prec = 'Z' or 'z' double precision complex,

prec = 'I' or 'i' integer.

Application Notes

Before modifying this routine to tune the library performance on your system, be aware of the following:

  1. The value this function returns must be strictly larger than zero,

  2. If you are planning to link your program with different instances of the library (for example, on a heterogeneous machine), you must compile each instance of the library with exactly the same version of this routine for obvious interoperability reasons.