Function return status - 5.2 English - 68552

Values returned by the library API to indicate success or failure.

This table provides a brief explanation on the reason why a function call failed. It is strongly encouraged during the development cycle of applications or services to check the exit status of any call.

Values:

enumerator aoclsparse_status_success#

success.

enumerator aoclsparse_status_not_implemented#

functionality is not implemented.

enumerator aoclsparse_status_invalid_pointer#

invalid pointer parameter.

enumerator aoclsparse_status_invalid_size#

invalid size parameter.

enumerator aoclsparse_status_internal_error#

internal library failure.

enumerator aoclsparse_status_invalid_value#

invalid parameter value.

enumerator aoclsparse_status_invalid_index_value#

invalid index value.

enumerator aoclsparse_status_maxit#

function stopped after reaching number of iteration limit.

enumerator aoclsparse_status_user_stop#

user requested termination.

enumerator aoclsparse_status_wrong_type#

function called on the wrong type (double/float).

enumerator aoclsparse_status_memory_error#

memory allocation failure.

enumerator aoclsparse_status_numerical_error#

numerical error, e.g., matrix is not positive definite, divide-by-zero error

enumerator aoclsparse_status_invalid_operation#

cannot proceed with the request at this point.

enumerator aoclsparse_status_unsorted_input#

the input matrices are not sorted

enumerator aoclsparse_status_invalid_kid#

user requested kernel id was not available.