**************************************************************************
cuStateVec: A High-Performance Library for State Vector Quantum Simulators
**************************************************************************

Welcome to the cuStateVec library documentation!

**NVIDIA cuStateVec** is a high-performance library dedicated to operations with state vectors for expressing quantum algorithms.
cuStateVec is a component of the :doc:`NVIDIA cuQuantum SDK <../index>`. Functionalities of *cuStateVec* are described in 
:doc:`Overview <overview>` with a usage guide provided under :doc:`Examples <examples>`. 


.. topic:: Key Features

   * Provide APIs for:
   
     * State vector initialization
     * Gate application
     * Measurement
     * Expectation
     * Sampling
     * Qubit reordering on single/multiple device(s)
     * Logging purposes
   
   ..
     * Multi-GPU APIs:
     * Qubit reordering capability to minimize communication among GPUs


.. topic:: Support

   * *Supported GPU Architectures*: ``Volta``, ``Turing``, ``Ampere``, ``Ada``, ``Hopper``
   * *Supported OSes*: ``Linux``
   * *Supported CPU Architectures*: ``x86_64``, ``ARM64``


.. topic:: Prerequisites

   One of the following CUDA Toolkits and a compatible driver are required:

   .. list-table::
      :widths: 25 50
      :header-rows: 1

      * - CUDA Toolkit
        - Minimum Required Linux Driver Version
      * - `CUDA® 11.x <https://developer.nvidia.com/cuda-downloads>`_
        - >= 450.80.02
      * - `CUDA® 12.x <https://developer.nvidia.com/cuda-downloads>`_
        - >= 525.60.13

   Please refer to `CUDA Toolkit Release Notes <https://docs.nvidia.com/cuda/cuda-toolkit-release-notes/index.html#cuda-major-component-versions>`_ for the details.

.. toctree::
   :caption: Contents
   :maxdepth: 2

   release-notes
   overview
   examples
   distributed-index-bit-swap
   host-state-vector-migration
   api/index