.. index:: py::builtins::range

.. _doxycast_pypp_classpy_1_1builtins_1_1range:

.. _py-builtins-range:

*py::builtins::*\ range
=======================

*Defined in* ``<pypp/builtins/range.hpp>``

.. code-block:: cpp

     template <class type>
     class range;

Class for holding a range of values.

``py::builtins::range`` holds a range of values. The range is
specified by three value:

*    :ref:`start <py-builtins-range-start>`: The start value of the
     range.

*    :ref:`stop <py-builtins-range-stop>`: The end value of the
     range (exclusive).

*    :ref:`step <py-builtins-range-step>`: The difference between
     values.

.. warning::

     Although ``range`` support iterators, it's iterators don't
     support ``operator ->`` as objects are constructed on demand.
     It's iterators also don't return any references to object, they
     return the object.


Template parameters
-------------------

``type``: The type of values.


Members types
-------------

.. list-table::
     :class: width-full
     :widths: 25 75

     *   -   :ref:`value_type <py-builtins-range-value_type>`
         -   The type of values

     *   -   :ref:`iterator <py-builtins-range-iterator>`
         -   The type of iterators

     *   -   :ref:`const_iterator <py-builtins-range-const_iterator>`
         -   The type of constant iterators

     *   -   :ref:`reverse_iterator <py-builtins-range-reverse_iterator>`
         -   The type of reverse iterators

     *   -   :ref:`const_reverse_iterator <py-builtins-range-const_reverse_iterator>`
         -   The type of constant reverse iterators


Members functions
-----------------

.. list-table::
     :class: width-full
     :widths: 25 75

     *   -   :ref:`(constructor) <py-builtins-range-range>`
         -   Constructs a range

     *   -   :ref:`operator = <py-builtins-range-operator-assign>`
         -   Assigns a range to the range

**Value access**

.. list-table::
     :class: width-full
     :widths: 25 75

     *   -   :ref:`operator [] <py-builtins-range-operator-subscript>`
         -   Accesses value at specified index

     *   -   :ref:`operator [] <py-builtins-range-operator-subscript>`
         -   Returns a slice of the range

     *   -   :ref:`front <py-builtins-range-front>`
         -   Acceses the first value

     *   -   :ref:`back <py-builtins-range-back>`
         -   Acceses the last value

**Capacity**

.. list-table::
     :class: width-full
     :widths: 25 75

     *   -   :ref:`size <py-builtins-range-size>`
         -   Returns the size of the range

**Iterators**

.. list-table::
     :class: width-full
     :widths: 25 75

     *   -   :ref:`begin <py-builtins-range-begin>`

             :ref:`cbegin <py-builtins-range-cbegin>`
         -   Returns an iterator to the beginning

     *   -   :ref:`end <py-builtins-range-end>`

             :ref:`cend <py-builtins-range-cend>`
         -   Returns an iterator to the end

     *   -   :ref:`rbegin <py-builtins-range-rbegin>`

             :ref:`crbegin <py-builtins-range-crbegin>`
         -   Returns a reverse iterator to the beginning

     *   -   :ref:`rend <py-builtins-range-rend>`

             :ref:`crend <py-builtins-range-crend>`
         -   Returns a reverse iterator to the end

**Observers**

.. list-table::
     :class: width-full
     :widths: 25 75

     *   -   :ref:`start <py-builtins-range-start>`
         -   Returns the start value of the range

     *   -   :ref:`stop <py-builtins-range-stop>`
         -   Returns the stop value of the range

     *   -   :ref:`step <py-builtins-range-step>`
         -   Returns the step value of the range


**Lookup**

.. list-table::
     :class: width-full
     :widths: 25 75

     *   -   :ref:`count <py-builtins-range-count>`
         -   Returns the count of a value in the range

     *   -   :ref:`index <py-builtins-range-index>`
         -   Returns the index of a value in the range

     *   -   :ref:`find <py-builtins-range-find>`
         -   Finds and returns an iterator to a value in the range

**Modifiers**

.. list-table::
     :class: width-full
     :widths: 25 75

     *   -   :ref:`swap <py-builtins-range-swap>`
         -   Swaps the range with another


Non-member functions
--------------------

.. list-table::
     :class: width-full
     :widths: 25 75

     *   -   :ref:`operator \< <py-builtins-operator-less_than-range>`

             :ref:`operator > <py-builtins-operator-more_than-range>`

             :ref:`operator == <py-builtins-operator-equals-range>`

             :ref:`operator != <py-builtins-operator-not_equals-range>`

             :ref:`operator \<= <py-builtins-operator-less_than_or_equal-range>`

             :ref:`operator >= <py-builtins-operator-more_than_or_equal-range>`

         -   Compares two ranges lexicographically

     *   -   :ref:`operator ->* <py-builtins-operator-pointer_to_member-range>`
         -   Specializes the
             :ref:`py-builtins-operator-pointer_to_member-in`
             algorithm

     *   -   :ref:`::std::swap <std-swap-py-builtins-range>`
         -   Specializes the ``std::swap`` algorithm


Example
-------

.. code-block:: cpp

     #include <pypp/builtins/range.hpp>
     #include <pypp/builtins/list.hpp>
     #include <pypp/builtins/print.hpp>

     int main()
     {
         py::range<int> nums(10);
         py::print(py::list(nums));
     }

**Output**:

.. code-block:: text

     {0, 1, 2, 3, 4, 5, 6, 7, 8, 9}


Member hierarchy
----------------

*   :ref:`value_type <doxycast_pypp_classpy_1_1builtins_1_1range_1ab759d64c422bd21ef7b9c27834f17dd6>`

*   :ref:`iterator <doxycast_pypp_classpy_1_1builtins_1_1range_1a67ce39e9cff09b28fc0c17899950c684>`

*   :ref:`const_iterator <doxycast_pypp_classpy_1_1builtins_1_1range_1a937d93526a9bb533bcf28c84d3d68835>`

*   :ref:`reverse_iterator <doxycast_pypp_classpy_1_1builtins_1_1range_1a6e670c3f837140c7943817c2be7c5bbe>`

*   :ref:`const_reverse_iterator <doxycast_pypp_classpy_1_1builtins_1_1range_1a59b3468840ddf6989a3d04dff747ccdf>`

*   :ref:`range <doxycast_pypp_classpy_1_1builtins_1_1range_1aca90576d0b3b5f2033597b141305adae>`

*   :ref:`size <doxycast_pypp_classpy_1_1builtins_1_1range_1abdc4b94d71e285f3a1160eaad153634f>`

*   :ref:`count <doxycast_pypp_classpy_1_1builtins_1_1range_1abc643a58d80f5bbfd86591f649b6e059>`

*   :ref:`index <doxycast_pypp_classpy_1_1builtins_1_1range_1a6de9d773a22daa3246210e3c9bceaf52>`

*   :ref:`find <doxycast_pypp_classpy_1_1builtins_1_1range_1a8e7b2c0f9ac145037b67bf702daab51a>`

*   :ref:`start <doxycast_pypp_classpy_1_1builtins_1_1range_1a5cb6c93843d2d09d3e635ad0d1994b9d>`

*   :ref:`stop <doxycast_pypp_classpy_1_1builtins_1_1range_1a829ab44e32fcb1cb830aacd4463a3115>`

*   :ref:`step <doxycast_pypp_classpy_1_1builtins_1_1range_1a280c47caa5b491b9c212836b1585a679>`

*   :ref:`front <doxycast_pypp_classpy_1_1builtins_1_1range_1a8948525499e8289860de25dc2e205be1>`

*   :ref:`back <doxycast_pypp_classpy_1_1builtins_1_1range_1acafc3956513dfb99e2045e5586370979>`

*   :ref:`swap <doxycast_pypp_classpy_1_1builtins_1_1range_1aa78d1ee6b842a776c1baf906cbc1ae9a>`

*   :ref:`begin <doxycast_pypp_classpy_1_1builtins_1_1range_1a58b65b86fbeeea14819ad1a0946cdea4>`

*   :ref:`cbegin <doxycast_pypp_classpy_1_1builtins_1_1range_1ae233904675dccb6ecc79c495cab2aaf1>`

*   :ref:`rbegin <doxycast_pypp_classpy_1_1builtins_1_1range_1ae7c4bf75b2f7fdd6b2cc6bebc57e6c3d>`

*   :ref:`crbegin <doxycast_pypp_classpy_1_1builtins_1_1range_1a5aa09c53a4bed0119852b6469caa035b>`

*   :ref:`end <doxycast_pypp_classpy_1_1builtins_1_1range_1af93c7e91471958b7b52e17359ce11098>`

*   :ref:`cend <doxycast_pypp_classpy_1_1builtins_1_1range_1a55dfe4714f218f11d819f4a72b558f9b>`

*   :ref:`rend <doxycast_pypp_classpy_1_1builtins_1_1range_1ad9067bf6234caf9a535365b825bb701a>`

*   :ref:`crend <doxycast_pypp_classpy_1_1builtins_1_1range_1a8bef9b74ff9bebe6eaf0fa71bd2cc7c6>`

*   :ref:`operator [] <doxycast_pypp_classpy_1_1builtins_1_1range_1a5f247e203331077e177534a81b398e7d>`

*   :ref:`operator = <doxycast_pypp_classpy_1_1builtins_1_1range_1ad40ad05e6a49abfb28b4d899a9308c93>`



.. toctree::
     :hidden:

     
     value_type <classpy_1_1builtins_1_1range_1ab759d64c422bd21ef7b9c27834f17dd6>
     iterator <classpy_1_1builtins_1_1range_1a67ce39e9cff09b28fc0c17899950c684>
     const_iterator <classpy_1_1builtins_1_1range_1a937d93526a9bb533bcf28c84d3d68835>
     reverse_iterator <classpy_1_1builtins_1_1range_1a6e670c3f837140c7943817c2be7c5bbe>
     const_reverse_iterator <classpy_1_1builtins_1_1range_1a59b3468840ddf6989a3d04dff747ccdf>
     range <classpy_1_1builtins_1_1range_1aca90576d0b3b5f2033597b141305adae>
     size <classpy_1_1builtins_1_1range_1abdc4b94d71e285f3a1160eaad153634f>
     count <classpy_1_1builtins_1_1range_1abc643a58d80f5bbfd86591f649b6e059>
     index <classpy_1_1builtins_1_1range_1a6de9d773a22daa3246210e3c9bceaf52>
     find <classpy_1_1builtins_1_1range_1a8e7b2c0f9ac145037b67bf702daab51a>
     start <classpy_1_1builtins_1_1range_1a5cb6c93843d2d09d3e635ad0d1994b9d>
     stop <classpy_1_1builtins_1_1range_1a829ab44e32fcb1cb830aacd4463a3115>
     step <classpy_1_1builtins_1_1range_1a280c47caa5b491b9c212836b1585a679>
     front <classpy_1_1builtins_1_1range_1a8948525499e8289860de25dc2e205be1>
     back <classpy_1_1builtins_1_1range_1acafc3956513dfb99e2045e5586370979>
     swap <classpy_1_1builtins_1_1range_1aa78d1ee6b842a776c1baf906cbc1ae9a>
     begin <classpy_1_1builtins_1_1range_1a58b65b86fbeeea14819ad1a0946cdea4>
     cbegin <classpy_1_1builtins_1_1range_1ae233904675dccb6ecc79c495cab2aaf1>
     rbegin <classpy_1_1builtins_1_1range_1ae7c4bf75b2f7fdd6b2cc6bebc57e6c3d>
     crbegin <classpy_1_1builtins_1_1range_1a5aa09c53a4bed0119852b6469caa035b>
     end <classpy_1_1builtins_1_1range_1af93c7e91471958b7b52e17359ce11098>
     cend <classpy_1_1builtins_1_1range_1a55dfe4714f218f11d819f4a72b558f9b>
     rend <classpy_1_1builtins_1_1range_1ad9067bf6234caf9a535365b825bb701a>
     crend <classpy_1_1builtins_1_1range_1a8bef9b74ff9bebe6eaf0fa71bd2cc7c6>
     operator [] <classpy_1_1builtins_1_1range_1a5f247e203331077e177534a81b398e7d>
     operator = <classpy_1_1builtins_1_1range_1ad40ad05e6a49abfb28b4d899a9308c93>