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_?gepack_compact

Packs matrices from standard (row or column-major) format to Compact format.

Syntax

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

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

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

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

Description

The routine packs nm matrices A from standard format (row or column-major, pointer to pointer) in a into Compact format, storing the new compact format matrices Ac in array ap.

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.
a
A standard format (row or column-major, pointer-to-pointer) array, storing nm input A matrices.
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).

ldap
Leading dimension 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_?gepack_compact must be consistent with the values used in mkl_?get_size_compact and mkl_?geunpack_compact.

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

Application Notes:

Directly after calling this routine, any BLAS or LAPACK compact routine can be called. Unpacking matrices from Compact format can be done by calling mkl_?geunpack_compact.

Output Parameters

ap
Array storing the compact format input matrices Ac. ap must have size at least size = mkl_?get_size_compact.