Sprout/source/libs/array/array/cend.rst
2013-08-30 14:02:02 +09:00

37 lines
980 B
ReStructuredText

.. _sprout-array-array-cbegin:
###############################################################################
cbegin
###############################################################################
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR const_iterator cbegin() const SPROUT_NOEXCEPT;
Returns
========================================
| iterator for position after the last element always const.
Examples
========================================
.. sourcecode:: c++
#include <sprout/array.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto input = array<int, 10>{{1, 2, 3, 4, 5, 6, 7, 8, 9, 10}};
static_assert(*(input.cbegin() - 1) == 1, "input last element is 10.");
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
Header
========================================
| ``sprout/array/array.hpp``
| Convenience header: ``sprout/array.hpp``