Developer Reference

Contents

mkl_sparse_set_memory_hint

Provides memory requirements for performance optimization purposes.

Syntax

sparse_status_t mkl_sparse_set_memory_hint
(
const sparse_matrix_t
A
,
const sparse_memory_usage_t
policy
);
Include Files
  • mkl_spblas.h
Description
The
mkl_sparse_set_memory_hint
routine allocates additional memory for further performance optimization purposes.
Product and Performance Information
Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.
Notice revision #20201201
Input Parameters
policy
Specify memory utilization policy for optimization routine using these types:
SPARSE_MEMORY_NONE
Routine can allocate memory only for auxiliary structures (such as for workload balancing); the amount of memory is proportional to vector size.
SPARSE_MEMORY_AGGRESSIVE
Default.
Routine can allocate memory up to the size of matrix
A
for converting into the appropriate sparse format.
Output Parameters
A
Handle containing internal data.
Return Values
The function returns a value indicating whether the operation was successful or not, and why.
SPARSE_STATUS_SUCCESS
The operation was successful.
SPARSE_STATUS_NOT_INITIALIZED
The routine encountered an empty handle or matrix array.
SPARSE_STATUS_ALLOC_FAILED
Internal memory allocation failed.
SPARSE_STATUS_INVALID_VALUE
The input parameters contain an invalid value.
SPARSE_STATUS_EXECUTION_FAILED
Execution failed.
SPARSE_STATUS_INTERNAL_ERROR
An error in algorithm implementation occurred.
SPARSE_STATUS_NOT_SUPPORTED
The requested operation is not supported.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.