Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
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_?geunpack_compact

Unpacks matrices from Compact format to standard (row- or column-major, pointer-to-pointer) format.

Syntax

mkl_sgeunpack_compact (MKL_LAYOUT layout, MKL_INT rows, MKL_INT columns, float * const *a, MKL_INT lda, const float *ap, MKL_INT ldap, MKL_COMPACT_PACK format, MKL_INT nm);

mkl_dgeunpack_compact (MKL_LAYOUT layout, MKL_INT rows, MKL_INT columns, double * const *a, MKL_INT lda, const double *ap, MKL_INT ldap, MKL_COMPACT_PACK format, MKL_INT nm);

mkl_cgeunpack_compact (MKL_LAYOUT layout, MKL_INT rows, MKL_INT columns, mkl_compact_complex_float * const *a, MKL_INT lda, const float *ap, MKL_INT ldap, MKL_COMPACT_PACK format, MKL_INT nm);

mkl_zgeunpack_compact (MKL_LAYOUT layout, MKL_INT rows, MKL_INT columns, mkl_compact_complex_double * const *a, MKL_INT lda, const double *ap, MKL_INT ldap, MKL_COMPACT_PACK format, MKL_INT nm);

Description

The routine unpacks nm Compact format matrices Ac from array ap into standard (row- or column-major, pointer-to-pointer) format in array A.

Input Parameters

layout

Specifies whether two-dimensional array storage is row-major (MKL_ROW_MAJOR) or column-major (MKL_COL_MAJOR).

rows
The number of rows of A; rows >= 0.
columns
The number of columns of A; columns >= 0.
lda
Leading dimension of A.

layout = MKL_COL_MAJOR

lda must be at least max (1,rows).

layout = MKL_ROW_MAJOR

lda must be at least max (1,columns).

ap
Array storing the compact format of input matrices Ac. See Compact Formator mkl_get_format_compact for details.

layout = MKL_COL_MAJOR

ap has size ldap*columns*nm.

layout = MKL_ROW_MAJOR

ap has size ldap*rows*nm.

ldap
Leading dimension of of Ac.

layout = MKL_COL_MAJOR

ldap must be at least max (1,rows).

layout = MKL_ROW_MAJOR

ldap must be at least max (1,columns).

NOTE:

The values of ldap used in mkl_?geunpack_compact must be consistent with the values used in mkl_?get_size_compact and mkl_?gepack_compact.

format
Specifies the format of the compact matrices. See Compact Format ormkl_get_format_compact for details.
nm
Total number of matrices that will be stored in Compact format.

Output Parameters

a
A standard format (row- or column-major, pointer-to-pointer) array, storing nm output A matrices.

layout = MKL_COL_MAJOR

a has size lda*columns*nm.

layout = MKL_ROW_MAJOR

a has size lda*rows*nm.