.. default-role:: cpp
.. highlight:: cpp

cuTENSOR Functions
==================

Helper Functions
----------------------------------

The helper functions initialize cuTENSOR, create tensor descriptors,
check error codes, and retrieve library and CUDA runtime versions.

------------

:code:`cutensorInit()`
^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorInit

------------

:code:`cutensorInitTensorDescriptor()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorInitTensorDescriptor

------------

:code:`cutensorGetAlignmentRequirement()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorGetAlignmentRequirement

------------

:code:`cutensorGetErrorString()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorGetErrorString

------------

:code:`cutensorGetVersion()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorGetVersion

------------

:code:`cutensorGetCudartVersion()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorGetCudartVersion

.. _elementwise-operations-label:

Element-wise Operations
-------------------------------------

The following functions perform element-wise operations between tensors.

------------

:code:`cutensorElementwiseTrinary()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorElementwiseTrinary

------------

:code:`cutensorElementwiseBinary()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorElementwiseBinary

------------

:code:`cutensorPermutation()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorPermutation

.. _contraction-operations-label:

Contraction Operations
-------------------------------

The following functions perform contractions between tensors.

------------

:code:`cutensorInitContractionDescriptor()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorInitContractionDescriptor

------------

:code:`cutensorInitContractionFind()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorInitContractionFind

------------

:code:`cutensorContractionGetWorkspace()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorContractionGetWorkspace

------------

:code:`cutensorInitContractionPlan()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorInitContractionPlan

------------

:code:`cutensorContraction()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorContraction

------------

:code:`cutensorContractionMaxAlgos()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorContractionMaxAlgos

.. _reduction-operations-label:

Reduction Operations
-----------------------------

The following functions perform tensor reductions.

------------

:code:`cutensorReduction()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorReduction

------------

:code:`cutensorReductionGetWorkspace()`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenfunction:: cutensorReductionGetWorkspace