add doc: basic_string (array compatible)

This commit is contained in:
Bolero-MURAKAMI 2013-09-06 16:46:03 +09:00
parent 260291ea69
commit 7b0f0541e3
68 changed files with 4688 additions and 50 deletions

View file

@ -0,0 +1,39 @@
.. _sprout-string-basic_string-c_array:
###############################################################################
back
###############################################################################
Interface
========================================
.. sourcecode:: c++
pointer c_array() SPROUT_NOEXCEPT;
SPROUT_CONSTEXPR const_pointer c_array() const SPROUT_NOEXCEPT;
Returns
========================================
| Pointer to the data contained by the string.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto input = string<8>("homuhomu");
static_assert(input.c_array()[0] == 'h', "a first element is h.");
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``