mdarray: Multi-dimensional Owning Container
===========================================

.. role:: py(code)
   :language: c++
   :class: highlight

``#include <raft/core/mdarray.hpp>``

.. doxygengroup:: mdarray_apis
    :project: RAFT
    :members:
    :content-only:

Device Vocabulary
-----------------

``#include <raft/core/device_mdarray.hpp>``

.. doxygentypedef:: raft::device_mdarray
    :project: RAFT

.. doxygentypedef:: raft::device_matrix
    :project: RAFT

.. doxygentypedef:: raft::device_vector
    :project: RAFT

.. doxygentypedef:: raft::device_scalar
    :project: RAFT


Device Factories
----------------

``#include <raft/core/device_mdarray.hpp>``

.. doxygenfunction:: raft::make_device_matrix
    :project: RAFT

.. doxygenfunction:: raft::make_device_vector
    :project: RAFT

.. doxygenfunction:: raft::make_device_scalar
    :project: RAFT


Host Vocabulary
---------------

``#include <raft/core/host_mdarray.hpp>``

.. doxygentypedef:: raft::host_matrix
    :project: RAFT

.. doxygentypedef:: raft::host_vector
    :project: RAFT

.. doxygentypedef:: raft::host_scalar
    :project: RAFT


Host Factories
--------------

``#include <raft/core/host_mdarray.hpp>``

.. doxygengroup:: host_mdarray_factories
    :project: RAFT
    :members:
    :content-only:

Managed Vocabulary
------------------

``#include <raft/core/managed_mdarray.hpp>``

.. doxygentypedef:: raft::managed_mdarray
    :project: RAFT

.. doxygentypedef:: raft::managed_matrix
    :project: RAFT

.. doxygentypedef:: raft::managed_vector
    :project: RAFT

.. doxygentypedef:: raft::managed_scalar
    :project: RAFT


Managed Factories
-----------------

``#include <raft/core/managed_mdarray.hpp>``

.. doxygenfunction:: raft::make_managed_matrix
    :project: RAFT

.. doxygenfunction:: raft::make_managed_vector
    :project: RAFT

.. doxygenfunction:: raft::make_managed_scalar
    :project: RAFT

Pinned Vocabulary
-----------------

``#include <raft/core/pinned_mdarray.hpp>``

.. doxygentypedef:: raft::pinned_mdarray
    :project: RAFT

.. doxygentypedef:: raft::pinned_matrix
    :project: RAFT

.. doxygentypedef:: raft::pinned_vector
    :project: RAFT

.. doxygentypedef:: raft::pinned_scalar
    :project: RAFT


Pinned Factories
----------------

``#include <raft/core/pinned_mdarray.hpp>``

.. doxygenfunction:: raft::make_pinned_matrix
    :project: RAFT

.. doxygenfunction:: raft::make_pinned_vector
    :project: RAFT

.. doxygenfunction:: raft::make_pinned_scalar
    :project: RAFT