.. _Iterator:

#############
BasisIterator
#############

The :ref:`BasisIterator<Iterator>` class is built on top of the :ref:`BasisU1 class<BasisU1>` and allows an easy handling of :ref:`basis states<State>`.
It is returned by the :ref:`BasisU1 class<BasisU1>` and follows standard **cpp** syntax.

.. code-block:: cpp
   :linenos:

    using State = danceq::internal::State<256,4> State;
    using Container = danceq::internal::ContainerTable<State>;
    using Basis = danceq::internal::BasisU1<Container>;
    using BasisIterator = danceq::internal::BasisIterator<Basis>;

    /* basis is Basis class instance with L = 164 and n = 4 */
    Basis basis(164,4)

    /* Using begin() and end() */
    for(auto it = basis.begin(); it < basis.end(); ++it){
        std::cout << *it << std::endl;
    }

    /* Using first() and last() */
    for(auto it = basis.first(); it <= basis.last(); ++it){
        std::cout << *it << std::endl;
    }

The current :ref:`State<State>` can be retrieved with ``*it``.

.. toctree::
    :maxdepth: 2
    :titlesonly:

    Iterator/Members.rst
    Iterator/Constructors.rst
    Iterator/Functions.rst
    Iterator/Autodocs.rst