Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 3/22/2024
Public

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

Document Table of Contents

mkl_cbwr_set

Configures the CNR mode of Intel® oneAPI Math Kernel Library (oneMKL). The mkl_cbwr_set function must be called only once, before any other Intel® oneAPI Math Kernel Library (oneMKL) functions.

Syntax

status = mkl_cbwr_set( setting )

Fortran Include Files/Modules

  • Include file: mkl.fi
  • Module (compiled): mkl_service.mod
  • Module (source): mkl_service.f90

Input Parameters

Name

Type

Description

setting

INTEGER*4

CNR branch to set. See Named Constants for CNR Control for a list of named constants that specify the settings.

Description

The mkl_cbwr_set function configures the CNR mode. (Specifically, it sets the CNR branch and then turns on the CNR mode.)

The mkl_cbwr_set function must be called only once, before any other Intel® oneAPI Math Kernel Library (oneMKL) functions.

NOTE:

Settings specified by the mkl_cbwr_set function take precedence over the settings specified by the MKL_CBWR environment variable.

Return Values

Name

Type

Description

status

INTEGER*4

The status of the function completion:

  • MKL_CBWR_SUCCESS - the function completed successfully.

  • MKL_CBWR_ERR_INVALID_INPUT - an invalid setting is requested.

  • MKL_CBWR_ERR_UNSUPPORTED_BRANCH - the input value of the branch does not match the instruction set architecture (ISA) of your system. See Named Constants for CNR Control for more details.

  • MKL_CBWR_ERR_MODE_CHANGE_FAILURE - the mkl_cbwr_setfunction requested to change the current CNR branch after a call to some Intel® oneAPI Math Kernel Library (oneMKL) function other than a CNR function.