Developer Reference for Intel® oneAPI Math Kernel Library - C

Developer Reference

  • 0.9
  • 09/09/2020
  • Public Content
Contents

mkl_graph_vector_get_sparse

Exports a sparse representation of a graph vector.

Syntax

mkl_graph_status_t
mkl_graph_vector_get_sparse (mkl_graph_vector_t
v
,
int64_t *
dim
,
int64_t *
nnz
,
void **
indices
,
mkl_graph_type_t *
indices_type
,
void **
values
,
mkl_graph_type_t *
values_type
);
Include Files
  • mkl_graph.h
Description
The
mkl_graph_vector_get_sparse
 routine exports the sparse representation of a graph vector. All output arguments are optional and will not be used if NULL pointers are passed. For
indices
 and
values
 the type of the elements can be obtained from a corresponding parameter of type
mkl_graph_type_t
.
The routine
mkl_graph_vector_get_sparse
 does not change the ownership of the data. In particular, you should not directly deallocate the returned pointers. A call to
mkl_graph_vector_destroy
 will deallocate any data allocated by
Intel® oneAPI Math Kernel Library
.
If only information about the number of rows or the number of columns is needed,
mkl_graph_vector_get_property
 can be used instead of
mkl_graph_vector_get_sparse
.
Input Parameters
v
A graph vector from which data are retrieved.
Output Parameters
dim
Dimension of the vector. Ignored if NULL is passed.
nnz
Number of non-zero entries in the vector. Ignored if NULL is passed.
indices
A pointer to an array which contains zero-based indices for the non-zero entries in the vector
v
. Type of the array elements can be deduced from
indices_type
. Ignored if NULL.
indices_type
Type of the elements of the
indices
 array. Refer to Graph API Glossary for a list of possible options. Ignored if NULL is passed.
values
A pointer to an array which contains values for the nonzero entries in the vector
v
. The type of the array elements can be deduced from
values_type
. Ignored if NULL.
values_type
Type of the elements of the
values
 array. Refer to Graph API Glossary for a list of possible options. Ignored if NULL is passed.
Return Values
The function returns a value indicating whether the operation was successful or not and why. Refer to Graph API Glossary for a list of possible options.
Optimization Notice
Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.
Notice revision #20110804
This notice covers the following instruction sets: SSE2, SSE4.2, AVX2, AVX-512.

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804