.. _sprout-index_tuple:

###############################################################################
Sprout.IndexTuple
###############################################################################

.. toctree::
    :hidden:

    index_t
    uindex_t
    integer_sequence/index
    index_tuple
    uindex_tuple
    index_sequence
    make_integer_sequence
    make_index_tuple
    make_uindex_tuple
    integer_pack
    index_pack
    uindex_pack
    integer_range
    index_range
    uindex_range
    integer_n
    index_n
    uindex_n
    make_index_sequence
    index_sequence_for
    enable_make_indexes
    literal-_indexes
    literal-_uindexes
    integer_sequence/std-tuple_size
    integer_sequence/std-tuple_element
    integer_sequence/tuple_get

Description
========================================

Index types
----------------------------------------

.. csv-table::
    :header: type
    :widths: 4, 8

    :doc:`index_t <./index_t>`, ""
    :doc:`uindex_t <./uindex_t>`, ""

Integer sequence class
----------------------------------------

.. csv-table::
    :header: class
    :widths: 4, 8

    :doc:`integer_sequence <./integer_sequence/index>`, ""

integer_sequence aliases
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. csv-table::
    :header: alias
    :widths: 4, 8

    :doc:`index_tuple <./index_tuple>`, ""
    :doc:`uindex_tuple <./uindex_tuple>`, ""
    :doc:`index_sequence <./index_sequence>`, ""

Generator metafunctions
----------------------------------------

.. csv-table::
    :header: metafunction
    :widths: 4, 8

    :doc:`make_integer_sequence <./make_integer_sequence>`, ""
    :doc:`make_index_tuple <./make_index_tuple/index>`, ""
    :doc:`make_uindex_tuple <./make_uindex_tuple/index>`, ""
    :doc:`integer_pack <./integer_pack>`, ""
    :doc:`index_pack <./index_pack>`, ""
    :doc:`uindex_pack <./uindex_pack>`, ""
    :doc:`integer_range <./integer_range>`, ""
    :doc:`index_range <./uindex_range>`, ""
    :doc:`uindex_range <./uindex_range>`, ""
    :doc:`integer_n <./integer_n>`, ""
    :doc:`index_n <./uindex_range>`, ""
    :doc:`uindex_n <./uindex_range>`, ""
    :doc:`make_index_sequence <./make_index_sequence>`, ""
    :doc:`index_sequence_for <./index_sequence_for>`, ""

Integer sequence utilities
----------------------------------------

.. csv-table::
    :header: class
    :widths: 4, 8

    :doc:`enable_make_indexes <./enable_make_indexes>`, ""

.. csv-table::
    :header: user-defined literal
    :widths: 4, 8

    :doc:`operator"" _indexes <./literal-_indexes>`, ""
    :doc:`operator"" _uindexes <./literal-_uindexes>`, ""

Tuple interface
----------------------------------------

.. csv-table::
    :header: matafunction
    :widths: 4, 8

    :doc:`std::tuple_size <./integer_sequence/std-tuple_size>`, ""
    :doc:`std::tuple_element <./integer_sequence/std-tuple_element>`, ""

.. csv-table::
    :header: function
    :widths: 4, 8

    :doc:`tuple_get <./integer_sequence/tuple_get>`, ""

Header
========================================

``sprout/index_tuple.hpp``