.. index:: py::builtins::list

.. _doxycast_pypp_classpy_1_1builtins_1_1list:

.. _py-builtins-list:

*py::builtins::*\ list
======================

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

.. code-block:: cpp

     template <
         class type,
         class allocator = std::allocator<type>
     >
     class list;

Container for holding and randomly accessing elements of a single
type.

``py::builtins::list`` allows to hold elements of a single type and
access them randomly in constant time.

This container stores element contiguously, so elements can be
accessed with offsets on pointers to other elements (not applicable
when element type is ``bool``, see :ref:`below
<list-uses-std-vector>`).

.. _list-uses-std-vector:

.. note::

     ``py::builtins::list`` uses ``std::vector`` to hold elements, so
     when using this container to hold element of type ``bool``,
     every element usually uses a bit instead of a byte
     (*depends on the C++ standard library implementation*).


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

``type``: The type of elements.

``allocator``: The type of allocator.


Members
-------

*   :ref:`value_type <doxycast_pypp_classpy_1_1builtins_1_1list_1a46fcf156327e5c6c111b84d75189e4f2>`

*   :ref:`allocator_type <doxycast_pypp_classpy_1_1builtins_1_1list_1a747d7891003fc39411a9bf1194e1319b>`

*   :ref:`size_type <doxycast_pypp_classpy_1_1builtins_1_1list_1aa58f7611081b2b79017ebb66dfca709e>`

*   :ref:`difference_type <doxycast_pypp_classpy_1_1builtins_1_1list_1a2d213023fb0998bd18cdfec1e4a5fd9b>`

*   :ref:`reference <doxycast_pypp_classpy_1_1builtins_1_1list_1a34b731230c3e2656a9d8877404506e12>`

*   :ref:`const_reference <doxycast_pypp_classpy_1_1builtins_1_1list_1abf3d76c142b9117e27fc4da936882cf8>`

*   :ref:`pointer <doxycast_pypp_classpy_1_1builtins_1_1list_1a82a4f4c9b26388a91525de44a2ce60cf>`

*   :ref:`const_pointer <doxycast_pypp_classpy_1_1builtins_1_1list_1a25d3dab14bb72bb9e9accbe15e8b330e>`

*   :ref:`iterator <doxycast_pypp_classpy_1_1builtins_1_1list_1a172db697ee4461f7133a1f8553f2f974>`

*   :ref:`const_iterator <doxycast_pypp_classpy_1_1builtins_1_1list_1a47a51aee738e6e65c75764226adf3aff>`

*   :ref:`reverse_iterator <doxycast_pypp_classpy_1_1builtins_1_1list_1a432b1dc9d4c6d45a727fc773b685663d>`

*   :ref:`const_reverse_iterator <doxycast_pypp_classpy_1_1builtins_1_1list_1ac74a55bdcac812cfbb58f8f9e69bb211>`

*   :ref:`list <doxycast_pypp_classpy_1_1builtins_1_1list_1a0381cce6c80ea8efc953f3a658158951>`

*   :ref:`count <doxycast_pypp_classpy_1_1builtins_1_1list_1a4f6ce359d14978916d598cc1ea34a931>`

*   :ref:`size <doxycast_pypp_classpy_1_1builtins_1_1list_1a9d446e20098803a14be2fc04a34aed7b>`

*   :ref:`index <doxycast_pypp_classpy_1_1builtins_1_1list_1a15eece8d1b9d1122d921a2af783b4d15>`

*   :ref:`append <doxycast_pypp_classpy_1_1builtins_1_1list_1ad0de2085023c26b41d9ee44bdeed2520>`

*   :ref:`insert <doxycast_pypp_classpy_1_1builtins_1_1list_1a3d351bbcbfb550954b3602b36251032d>`

*   :ref:`extend <doxycast_pypp_classpy_1_1builtins_1_1list_1a060018bcb62b4e248f629332466d4999>`

*   :ref:`clear <doxycast_pypp_classpy_1_1builtins_1_1list_1a52b1f4d12d0c43ebdab7626c8ea7eb4f>`

*   :ref:`pop <doxycast_pypp_classpy_1_1builtins_1_1list_1a6caf93b05b1451f9fa718dcbf1416bdb>`

*   :ref:`remove <doxycast_pypp_classpy_1_1builtins_1_1list_1af71e78f945299cdfd980035e9a1642b1>`

*   :ref:`sort <doxycast_pypp_classpy_1_1builtins_1_1list_1a1fc099803619c4698b6067679b4e804d>`

*   :ref:`reverse <doxycast_pypp_classpy_1_1builtins_1_1list_1ac0299faaff27fc2fa9cc6f1aa4e025a2>`

*   :ref:`begin <doxycast_pypp_classpy_1_1builtins_1_1list_1a4d359619d89bf0575e68b396d5baad8e>`

*   :ref:`cbegin <doxycast_pypp_classpy_1_1builtins_1_1list_1a4c3199db1e2ba87c481825e646b2d989>`

*   :ref:`rbegin <doxycast_pypp_classpy_1_1builtins_1_1list_1a988328a882678ec7ebf128688b1c1777>`

*   :ref:`crbegin <doxycast_pypp_classpy_1_1builtins_1_1list_1aa9aa6f7d0633b4311e094cebcbbe91f0>`

*   :ref:`end <doxycast_pypp_classpy_1_1builtins_1_1list_1a18e1fa1991ed253b98fb1cbe5fb01781>`

*   :ref:`cend <doxycast_pypp_classpy_1_1builtins_1_1list_1a76155b3f53d358fa040628e707175dc4>`

*   :ref:`rend <doxycast_pypp_classpy_1_1builtins_1_1list_1a31c24e3701f71782fda72dcbd3b1577d>`

*   :ref:`crend <doxycast_pypp_classpy_1_1builtins_1_1list_1a4978b0be3fd6de504c440ac316bb49ee>`

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

*   :ref:`operator = <doxycast_pypp_classpy_1_1builtins_1_1list_1abc031d4f0e2215bec0d2970cd697cfdc>`



.. toctree::
     :hidden:

     
     value_type <classpy_1_1builtins_1_1list_1a46fcf156327e5c6c111b84d75189e4f2>
     allocator_type <classpy_1_1builtins_1_1list_1a747d7891003fc39411a9bf1194e1319b>
     size_type <classpy_1_1builtins_1_1list_1aa58f7611081b2b79017ebb66dfca709e>
     difference_type <classpy_1_1builtins_1_1list_1a2d213023fb0998bd18cdfec1e4a5fd9b>
     reference <classpy_1_1builtins_1_1list_1a34b731230c3e2656a9d8877404506e12>
     const_reference <classpy_1_1builtins_1_1list_1abf3d76c142b9117e27fc4da936882cf8>
     pointer <classpy_1_1builtins_1_1list_1a82a4f4c9b26388a91525de44a2ce60cf>
     const_pointer <classpy_1_1builtins_1_1list_1a25d3dab14bb72bb9e9accbe15e8b330e>
     iterator <classpy_1_1builtins_1_1list_1a172db697ee4461f7133a1f8553f2f974>
     const_iterator <classpy_1_1builtins_1_1list_1a47a51aee738e6e65c75764226adf3aff>
     reverse_iterator <classpy_1_1builtins_1_1list_1a432b1dc9d4c6d45a727fc773b685663d>
     const_reverse_iterator <classpy_1_1builtins_1_1list_1ac74a55bdcac812cfbb58f8f9e69bb211>
     list <classpy_1_1builtins_1_1list_1a0381cce6c80ea8efc953f3a658158951>
     count <classpy_1_1builtins_1_1list_1a4f6ce359d14978916d598cc1ea34a931>
     size <classpy_1_1builtins_1_1list_1a9d446e20098803a14be2fc04a34aed7b>
     index <classpy_1_1builtins_1_1list_1a15eece8d1b9d1122d921a2af783b4d15>
     append <classpy_1_1builtins_1_1list_1ad0de2085023c26b41d9ee44bdeed2520>
     insert <classpy_1_1builtins_1_1list_1a3d351bbcbfb550954b3602b36251032d>
     extend <classpy_1_1builtins_1_1list_1a060018bcb62b4e248f629332466d4999>
     clear <classpy_1_1builtins_1_1list_1a52b1f4d12d0c43ebdab7626c8ea7eb4f>
     pop <classpy_1_1builtins_1_1list_1a6caf93b05b1451f9fa718dcbf1416bdb>
     remove <classpy_1_1builtins_1_1list_1af71e78f945299cdfd980035e9a1642b1>
     sort <classpy_1_1builtins_1_1list_1a1fc099803619c4698b6067679b4e804d>
     reverse <classpy_1_1builtins_1_1list_1ac0299faaff27fc2fa9cc6f1aa4e025a2>
     begin <classpy_1_1builtins_1_1list_1a4d359619d89bf0575e68b396d5baad8e>
     cbegin <classpy_1_1builtins_1_1list_1a4c3199db1e2ba87c481825e646b2d989>
     rbegin <classpy_1_1builtins_1_1list_1a988328a882678ec7ebf128688b1c1777>
     crbegin <classpy_1_1builtins_1_1list_1aa9aa6f7d0633b4311e094cebcbbe91f0>
     end <classpy_1_1builtins_1_1list_1a18e1fa1991ed253b98fb1cbe5fb01781>
     cend <classpy_1_1builtins_1_1list_1a76155b3f53d358fa040628e707175dc4>
     rend <classpy_1_1builtins_1_1list_1a31c24e3701f71782fda72dcbd3b1577d>
     crend <classpy_1_1builtins_1_1list_1a4978b0be3fd6de504c440ac316bb49ee>
     operator [] <classpy_1_1builtins_1_1list_1a2ccb102a7b2f45d8870f79cdf6cf8017>
     operator = <classpy_1_1builtins_1_1list_1abc031d4f0e2215bec0d2970cd697cfdc>



Non-member helpers
------------------

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

*    :ref:`operator > <py-builtins-operator-more_than-list>`

*    :ref:`operator == <py-builtins-operator-equals-list>`

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

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

*    :ref:`operator >= <py-builtins-operator-more_than_or_equal-list>`


Example
-------

.. code-block:: cpp

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

     int main()
     {
         py::list<int> list = {0, 1, 2, 3, 4, 5, 6};

         py::print(list);

         list.append(7);

         py::print(list);
     }

**Output**:

.. code-block:: text

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