.. meta::
  :description: rocPRIM documentation and API reference library
  :keywords: rocPRIM, ROCm, API, documentation

.. _rocprim:

********************************************************************
 rocPRIM documentation
********************************************************************

rocPRIM is a header-only library that provides HIP parallel primitives. The purpose of the library is to ease the maintainability of performant, yet portable GPU-accelerated code on the AMD ROCm platform. rocPRIM is written in HIP and has been optimized for AMD's latest discrete GPUs. For more information refer to :ref:`rocprim-intro`.

The code is open and hosted at: https://github.com/ROCmSoftwarePlatform/rocPRIM

The rocPRIM documentation is structured as follows:

.. grid:: 2

  .. grid-item-card:: Conceptual

    * :ref:`rocprim-intro`
    * :ref:`glossary`
    * :ref:`tuning`
    * :ref:`developer`

  .. grid-item-card:: API reference

    * :ref:`ops-summary`
    * :ref:`data-type-support`
    * :ref:`dev-index`
    * :ref:`block-index`
    * :ref:`warp-index` 
    * :ref:`thread-index`
    * :ref:`iterators` 
    * :ref:`intrinsics` 
    * :ref:`type_traits`

To contribute to the documentation refer to `Contributing to ROCm  <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.

You can find licensing information on the `Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.



