.. _dpctl.memory_pyapi:

############
dpctl.memory
############

.. currentmodule:: dpctl.memory

.. automodule:: dpctl.memory


.. _dpctl.memory_classes:

Classes
-------

.. toctree::
   :hidden:

   MemoryUSMDevice
   MemoryUSMHost
   MemoryUSMShared

.. list-table::
    :widths: 25,50

    * - :class:`MemoryUSMDevice`
      - An object representing allocation of SYCL USM-device memory.
    * - :class:`MemoryUSMHost`
      - An object representing allocation of SYCL USM-host memory.
    * - :class:`MemoryUSMShared`
      - An object representing allocation of SYCL USM-shared memory.





Exceptions
----------

.. list-table::
    :widths: 25,50

    * - :class:`USMAllocationError`
      - An exception raised when Universal Shared Memory (USM) allocation call returns a null pointer, signaling a failure to perform the allocation.