Return Values¶

All NVPL RAND APIs have a return value of nvplRandStatus. Calls that succeed without errors return NVPL_RAND_STATUS_SUCCESS. If errors occur, a non-zero value is returned depending on the error type.

enum nvplRandStatus

NVPL RAND API return status.

Values:

enumerator NVPL_RAND_STATUS_SUCCESS

enumerator NVPL_RAND_STATUS_GENERATOR_NOT_INITIALIZED: Generator not initialized.

enumerator NVPL_RAND_STATUS_GENERATOR_TYPE_ERROR: Generator is wrong type.

enumerator NVPL_RAND_STATUS_DATA_NULLPTR: Data ptr is nullptr.

enumerator NVPL_RAND_STATUS_LENGTH_NOT_MULTIPLE: Length requested is not a multiple of dimension, or not a multiple of two.

enumerator NVPL_RAND_STATUS_PCG_INCREMENT_NOT_ODD: Increment requested for PCG is not odd.

enumerator NVPL_RAND_STATUS_OUT_OF_RANGE: Argument out of range.

enumerator NVPL_RAND_STATUS_DISTRIBUTION_CONFIGS_ERROR: Distribution parameters are not acceptable.

enumerator NVPL_RAND_STATUS_DISTRIBUTION_TYPE_ERROR: Distribution type is not supported by the generator.

enumerator NVPL_RAND_STATUS_INTERNAL_ERROR: Internal library error.

typedef enum nvplRandStatus nvplRandStatus_t: NVPL RAND API return status.