nv::index::IOut_of_memory_error Class Reference

The base class for out-of-memory errors generated by NVIDIA IndeX. More...

#include <ierror.h>

Inherits mi::base::Interface_declare< 0x565cc068, ... >.

Public Types
enum	Failure_hint {   OOM_FAIL_HINT_NONE = 0x00u ,   OOM_FAIL_INVALID_ALLOC_REQUEST = 0x01u ,   OOM_FAIL_FRAGMENTED_MEMORY = 0x02u ,   OOM_FAIL_INSUFFICIENT_DYNAMIC_RESOURCES = 0x04u }
	Failure codes that describe the potential issue. More...

Public Member Functions
virtual mi::Size	get_memory_available () const =0
	Returns the amount of memory available on the specific memory system (i.e. More...
virtual mi::Size	get_memory_requested () const =0
	Returns the amount of memory requested from the specific memory system (i.e. More...
virtual mi::Uint32	get_failure_hints () const =0
	Returns a bitmask describing potential reasons of the memory allocation failure. More...

Detailed Description

The base class for out-of-memory errors generated by NVIDIA IndeX.

This class of errors contains additional information regarding the available memory resources and the size of the memory allocation request causing the runtime failure. The specializations of this class IHost_out_of_memory_error and IDevice_out_of_memory_error indicate the host or GPU-device memory system as the source of the resource allocation failure.

Member Enumeration Documentation

Failure_hint

enum nv::index::IOut_of_memory_error::Failure_hint

Failure codes that describe the potential issue.

Enumerator
OOM_FAIL_HINT_NONE	! Unknown issue.
OOM_FAIL_INVALID_ALLOC_REQUEST	! Denotes invalid allocation request.
OOM_FAIL_FRAGMENTED_MEMORY	! Denotes fragmented memory.
OOM_FAIL_INSUFFICIENT_DYNAMIC_RESOURCES	! Denoted insufficient memory resources for dynamic memory management.

Member Function Documentation

get_failure_hints()

virtual mi::Uint32 nv::index::IOut_of_memory_error::get_failure_hints ( ) const

pure virtual

Returns a bitmask describing potential reasons of the memory allocation failure.

Returns

Returns a bitmask containing one or more of the Failure_hint constants.

get_memory_available()

virtual mi::Size nv::index::IOut_of_memory_error::get_memory_available ( ) const

pure virtual

Returns the amount of memory available on the specific memory system (i.e.

host GPU device) on which the resource allocation failure was detected.

Returns

Returns the amount of memory available on the specific memory system.

get_memory_requested()

virtual mi::Size nv::index::IOut_of_memory_error::get_memory_requested ( ) const

pure virtual

Returns the amount of memory requested from the specific memory system (i.e.

host GPU device) which caused the resource allocation failure.

Returns

Returns the amount of memory requested from the specific memory system.

---

The documentation for this class was generated from the following file:

• ierror.h