Matmul algorithm functions#

hipSPARSELt: Matmul algorithm functions
Matmul algorithm functions

Functions

hipsparseStatus_t hipsparseLtMatmulAlgSelectionInit (const hipsparseLtHandle_t *handle, hipsparseLtMatmulAlgSelection_t *algSelection, const hipsparseLtMatmulDescriptor_t *matmulDescr, hipsparseLtMatmulAlg_t alg)
 Initializes the algorithm selection descriptor. More...
 
hipsparseStatus_t hipsparseLtMatmulAlgSetAttribute (const hipsparseLtHandle_t *handle, hipsparseLtMatmulAlgSelection_t *algSelection, hipsparseLtMatmulAlgAttribute_t attribute, const void *data, size_t dataSize)
 Specify the algorithm attribute of a algorithm selection descriptor. More...
 
hipsparseStatus_t hipsparseLtMatmulAlgGetAttribute (const hipsparseLtHandle_t *handle, const hipsparseLtMatmulAlgSelection_t *algSelection, hipsparseLtMatmulAlgAttribute_t attribute, void *data, size_t dataSize)
 Get the specific algorithm attribute from algorithm selection descriptor. More...
 

Detailed Description

Provides algorithms for matrix multiply

Function Documentation

◆ hipsparseLtMatmulAlgGetAttribute()

hipsparseStatus_t hipsparseLtMatmulAlgGetAttribute ( const hipsparseLtHandle_t handle,
const hipsparseLtMatmulAlgSelection_t algSelection,
hipsparseLtMatmulAlgAttribute_t  attribute,
void *  data,
size_t  dataSize 
)

Get the specific algorithm attribute from algorithm selection descriptor.

hipsparseLtMatmulAlgGetAttribute returns the value of the queried attribute belonging to algorithm selection descriptor.

Parameters
[in]handlethe hipsparselt handle
[in]algSelectionthe algorithm selection descriptor
[in]attributeattributes are specify in hipsparseLtMatmulAlgAttribute_t
[in,out]datathe memory address containing the attribute value retrieved by this function
[in]dataSizesize in bytes of the attribute value used for verification.
Return values
HIPSPARSE_STATUS_SUCCESSthe operation completed successfully.
HIPSPARSE_STATUS_INVALID_VALUEhandle , algSelection , attribute , data or dataSize is invalid.
HIPSPARSE_STATUS_NOT_SUPPORTEDattribute is not supported.

◆ hipsparseLtMatmulAlgSelectionInit()

hipsparseStatus_t hipsparseLtMatmulAlgSelectionInit ( const hipsparseLtHandle_t handle,
hipsparseLtMatmulAlgSelection_t algSelection,
const hipsparseLtMatmulDescriptor_t matmulDescr,
hipsparseLtMatmulAlg_t  alg 
)

Initializes the algorithm selection descriptor.

hipsparseLtMatmulAlgSelectionInit creates a algorithm selection descriptor.

Parameters
[in]handlethe hipsparselt handle
[out]algSelectionthe pointer to the algorithm selection descriptor
[in]matmulDescrthe matrix multiplication descriptor
[in]algthe algorithm used to do the matrix multiplication.
Return values
HIPSPARSE_STATUS_SUCCESSthe operation completed successfully.
HIPSPARSE_STATUS_INVALID_VALUEhandle , matmulDescr or algSelection is invalid.

◆ hipsparseLtMatmulAlgSetAttribute()

hipsparseStatus_t hipsparseLtMatmulAlgSetAttribute ( const hipsparseLtHandle_t handle,
hipsparseLtMatmulAlgSelection_t algSelection,
hipsparseLtMatmulAlgAttribute_t  attribute,
const void *  data,
size_t  dataSize 
)

Specify the algorithm attribute of a algorithm selection descriptor.

hipsparseLtMatmulAlgSetAttribute sets the value of the specified attribute belonging to algorithm selection descriptor.

Parameters
[in]handlethe hipsparselt handle
[in,out]algSelectionthe algorithm selection descriptor
[in]attributeattributes are specify in hipsparseLtMatmulAlgAttribute_t
[in]datapointer to the value to which the specified attribute will be set.
[in]dataSizesize in bytes of the attribute value used for verification.
Return values
HIPSPARSE_STATUS_SUCCESSthe operation completed successfully.
HIPSPARSE_STATUS_INVALID_VALUEhandle , algSelection , attribute , data or dataSize is invalid.
HIPSPARSE_STATUS_NOT_SUPPORTEDattribute is not supported.