mirror/Sprout
1
0
Fork 0
mirror of https://github.com/bolero-MURAKAMI/Sprout.git synced 2024-11-25 00:43:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add doc: basic_string constructor

Browse source
This commit is contained in:
Bolero-MURAKAMI 2013-09-09 19:49:37 +09:00
parent e312af77fc
commit 60814eec8a
11 changed files with 1265 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

346
docs/_sources/libs/string/basic_string/constructor-.txt Normal file
View file

@ -0,0 +1,346 @@
.. _sprout-string-basic_string-constructor-:
###############################################################################
basic_string
###############################################################################
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR basic_string() = default;
Effects
========================================
| Constructs an empty object of class basic_string.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>();
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
----
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR basic_string(basic_string const&) = default;
template<std::size_t N2, typename Enable = typename std::enable_if<(N2 < N)>::type>
SPROUT_CONSTEXPR basic_string(basic_string<T, N2, Traits> const& str);
Effects
========================================
| Constructs an object of class basic_string.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>("homuhomu");
SPROUT_STATIC_CONSTEXPR auto y = string<8>(x);
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
----
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR basic_string(basic_string const& str, size_type pos, size_type n = npos);
template<std::size_t N2, typename Enable = typename std::enable_if<(N2 < N)>::type>
SPROUT_CONSTEXPR basic_string(basic_string<T, N2, Traits> const& str, size_type pos, size_type n = npos);
Requires
========================================
| ``pos <= str.size()``.
Effects
========================================
| Constructs an object of class basic_string and determines the effective length rlen of the initial string value as the smaller of n and ``str.size() - pos``.
Throws
========================================
| std::out_of_range if ``pos > str.size()``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>("homuhomu");
SPROUT_STATIC_CONSTEXPR auto y = string<8>(x, 4, 4);
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
----
Interface
========================================
.. sourcecode:: c++
template<std::size_t N2, typename Enable = typename std::enable_if<(N2 - 1 <= N)>::type>
SPROUT_CONSTEXPR basic_string(T const(& arr)[N2]);
template<std::size_t N2, typename Enable = typename std::enable_if<(N2 - 1 <= N)>::type>
SPROUT_CONSTEXPR basic_string(T const(& arr)[N2], size_type n);
Requires
========================================
| ``min(n, rlen) <= N`` where rlen is length of arr.
Effects
========================================
| Constructs an object of class basic_string.
Throws
========================================
| std::out_of_range if ``min(n, rlen) > N`` where rlen is length of arr.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>("homuhomu");
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
----
Interface
========================================
.. sourcecode:: c++
explicit SPROUT_CONSTEXPR basic_string(value_type const* s);
Requires
========================================
| s points to an array of at least ``traits_type::length(s) + 1`` elements of value_type.
| ``traits_type::length(s) <= N``.
Effects
========================================
| Constructs an object of class basic_string and determines its initial string value from the array of value_type of length ``traits_type::length(s)`` whose first element is designated by s.
Throws
========================================
| std::out_of_range if ``traits_type::length(s) > N``.
Remarks
========================================
| Uses ``traits_type::length()``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR char const* input = "homuhomu";
SPROUT_STATIC_CONSTEXPR auto x = string<8>(input);
Complexity
========================================
| Recursive function invocations in *O(logN)* (logarithmic) depth.
----
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR basic_string(value_type const* s, size_type n);
Requires
========================================
| s points to an array of at least n elements of value_type.
| ``min(n, traits_type::length(s)) <= N``.
Effects
========================================
| Constructs an object of class basic_string and determines its initial string value from the array of value_type of length n whose first element is designated by s.
Throws
========================================
| std::out_of_range if ``min(n, traits_type::length(s)) > N``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR char const* input = "homuhomu";
SPROUT_STATIC_CONSTEXPR auto x = string<8>(input, 4);
Complexity
========================================
| Recursive function invocations in *O(logN)* (logarithmic) depth.
----
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR basic_string(size_type n, value_type c);
Requires
========================================
| ``n < N``.
Effects
========================================
| Constructs an object of class basic_string and determines its initial string value by repeating the char-like object c for all n elements.
Throws
========================================
| std::out_of_range if ``n > N``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>(8, 'H');
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
----
Interface
========================================
.. sourcecode:: c++
template<typename InputIterator>
SPROUT_CONSTEXPR basic_string(InputIterator first, InputIterator last);
Requires
========================================
| ``distance(first, last) <= N``.
Effects
========================================
| If InputIterator is an integral type, equivalent to ``basic_string(static_cast<size_type>(first), static_cast<value_type>(last))``.
| Otherwise constructs a string from the values in the range [begin,end).
Throws
========================================
| std::out_of_range if ``distance(first, last) > N``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>("homuhomu");
SPROUT_STATIC_CONSTEXPR auto y = string<8>(x.begin(), x.end());
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth if InputIterator meets ConstexprRandomAccessIterator requirements or an integral type, and *O(logN)* (logarithmic) depth otherwise.
----
Interface
========================================
.. sourcecode:: c++
basic_string(std::initializer_list<value_type> il);
Requires
========================================
| ``il.size() <= N``.
Effects
========================================
| Same as ``basic_string(il.begin(), il.end())``.
Throws
========================================
| std::out_of_range if ``il.size() > N``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>({'h', 'o', 'm', 'u', 'h', 'o', 'm', 'u'});
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

1
docs/_sources/libs/string/basic_string/index.txt
View file

@ -253,6 +253,7 @@ Interface of all
SPROUT_CONSTEXPR basic_string(T const(& arr)[N2], size_type n);
explicit SPROUT_CONSTEXPR basic_string(value_type const* s);
SPROUT_CONSTEXPR basic_string(value_type const* s, size_type n);
SPROUT_CONSTEXPR basic_string(size_type n, value_type c);
template<typename InputIterator>
SPROUT_CONSTEXPR basic_string(InputIterator first, InputIterator last);
basic_string(std::initializer_list<value_type> il);

2
docs/_sources/libs/string/basic_string/substr.txt
View file

@ -17,7 +17,7 @@ Requires
Returns
========================================
| ``basic_string(data() + pos, rlen)`` when rlen is the smaller of n and ``size() - pos``.
| ``basic_string(data() + pos, rlen)`` where rlen is the smaller of n and ``size() - pos``.
Throws
========================================

556
docs/libs/string/basic_string/constructor-.html Normal file
View file

@ -0,0 +1,556 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-43764535-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<title>basic_string &mdash; Sprout 1.0 documentation</title>
<link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="top" title="Sprout 1.0 documentation" href="../../../index.html" />
<link rel="up" title="basic_string" href="index.html" />
<link rel="next" title="operator=" href="operator-assign.html" />
<link rel="prev" title="basic_string" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="operator-assign.html" title="operator="
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="basic_string"
accesskey="P">previous</a> |</li>
<li><a href="../../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Libraries</a> &raquo;</li>
<li><a href="../index.html" >Sprout.String</a> &raquo;</li>
<li><a href="index.html" accesskey="U">basic_string</a> &raquo;</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">basic_string</a><ul>
<li><a class="reference internal" href="#interface">Interface</a></li>
<li><a class="reference internal" href="#effects">Effects</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#complexity">Complexity</a></li>
<li><a class="reference internal" href="#id1">Interface</a></li>
<li><a class="reference internal" href="#id2">Effects</a></li>
<li><a class="reference internal" href="#id3">Examples</a></li>
<li><a class="reference internal" href="#id4">Complexity</a></li>
<li><a class="reference internal" href="#id5">Interface</a></li>
<li><a class="reference internal" href="#requires">Requires</a></li>
<li><a class="reference internal" href="#id6">Effects</a></li>
<li><a class="reference internal" href="#throws">Throws</a></li>
<li><a class="reference internal" href="#id7">Examples</a></li>
<li><a class="reference internal" href="#id8">Complexity</a></li>
<li><a class="reference internal" href="#id9">Interface</a></li>
<li><a class="reference internal" href="#id10">Requires</a></li>
<li><a class="reference internal" href="#id11">Effects</a></li>
<li><a class="reference internal" href="#id12">Throws</a></li>
<li><a class="reference internal" href="#id13">Examples</a></li>
<li><a class="reference internal" href="#id14">Complexity</a></li>
<li><a class="reference internal" href="#id15">Interface</a></li>
<li><a class="reference internal" href="#id16">Requires</a></li>
<li><a class="reference internal" href="#id17">Effects</a></li>
<li><a class="reference internal" href="#id18">Throws</a></li>
<li><a class="reference internal" href="#remarks">Remarks</a></li>
<li><a class="reference internal" href="#id19">Examples</a></li>
<li><a class="reference internal" href="#id20">Complexity</a></li>
<li><a class="reference internal" href="#id21">Interface</a></li>
<li><a class="reference internal" href="#id22">Requires</a></li>
<li><a class="reference internal" href="#id23">Effects</a></li>
<li><a class="reference internal" href="#id24">Throws</a></li>
<li><a class="reference internal" href="#id25">Examples</a></li>
<li><a class="reference internal" href="#id26">Complexity</a></li>
<li><a class="reference internal" href="#id27">Interface</a></li>
<li><a class="reference internal" href="#id28">Requires</a></li>
<li><a class="reference internal" href="#id29">Effects</a></li>
<li><a class="reference internal" href="#id30">Throws</a></li>
<li><a class="reference internal" href="#id31">Examples</a></li>
<li><a class="reference internal" href="#id32">Complexity</a></li>
<li><a class="reference internal" href="#id33">Interface</a></li>
<li><a class="reference internal" href="#id34">Requires</a></li>
<li><a class="reference internal" href="#id35">Effects</a></li>
<li><a class="reference internal" href="#id36">Throws</a></li>
<li><a class="reference internal" href="#id37">Examples</a></li>
<li><a class="reference internal" href="#id38">Complexity</a></li>
<li><a class="reference internal" href="#id39">Interface</a></li>
<li><a class="reference internal" href="#id40">Requires</a></li>
<li><a class="reference internal" href="#id41">Effects</a></li>
<li><a class="reference internal" href="#id42">Throws</a></li>
<li><a class="reference internal" href="#id43">Examples</a></li>
<li><a class="reference internal" href="#id44">Complexity</a></li>
<li><a class="reference internal" href="#header">Header</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">basic_string</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="operator-assign.html"
title="next chapter">operator=</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/constructor-.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="basic-string">
<h1>basic_string<a class="headerlink" href="#basic-string" title="Permalink to this headline"></a></h1>
<div class="section" id="interface">
<h2>Interface<a class="headerlink" href="#interface" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">()</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span>
</pre></div>
</div>
</div>
<div class="section" id="effects">
<h2>Effects<a class="headerlink" href="#effects" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Constructs an empty object of class basic_string.</div>
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;sprout/string.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">x</span> <span class="o">=</span> <span class="n">string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">();</span>
</pre></div>
</div>
</div>
<div class="section" id="complexity">
<h2>Complexity<a class="headerlink" href="#complexity" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Recursive function invocations in <em>O(1)</em> (constant) depth.</div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="id1">
<h2>Interface<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">basic_string</span> <span class="k">const</span><span class="o">&amp;</span><span class="p">)</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span>
<span class="k">template</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">N2</span><span class="p">,</span> <span class="k">typename</span> <span class="n">Enable</span> <span class="o">=</span> <span class="k">typename</span> <span class="n">std</span><span class="o">::</span><span class="n">enable_if</span><span class="o">&lt;</span><span class="p">(</span><span class="n">N2</span> <span class="o">&lt;</span> <span class="n">N</span><span class="p">)</span><span class="o">&gt;::</span><span class="n">type</span><span class="o">&gt;</span>
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">basic_string</span><span class="o">&lt;</span><span class="n">T</span><span class="p">,</span> <span class="n">N2</span><span class="p">,</span> <span class="n">Traits</span><span class="o">&gt;</span> <span class="k">const</span><span class="o">&amp;</span> <span class="n">str</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id2">
<h2>Effects<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Constructs an object of class basic_string.</div>
</div>
</div>
<div class="section" id="id3">
<h2>Examples<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;sprout/string.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">x</span> <span class="o">=</span> <span class="n">string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">(</span><span class="s">&quot;homuhomu&quot;</span><span class="p">);</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">y</span> <span class="o">=</span> <span class="n">string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">(</span><span class="n">x</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id4">
<h2>Complexity<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Recursive function invocations in <em>O(1)</em> (constant) depth.</div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="id5">
<h2>Interface<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">basic_string</span> <span class="k">const</span><span class="o">&amp;</span> <span class="n">str</span><span class="p">,</span> <span class="n">size_type</span> <span class="n">pos</span><span class="p">,</span> <span class="n">size_type</span> <span class="n">n</span> <span class="o">=</span> <span class="n">npos</span><span class="p">);</span>
<span class="k">template</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">N2</span><span class="p">,</span> <span class="k">typename</span> <span class="n">Enable</span> <span class="o">=</span> <span class="k">typename</span> <span class="n">std</span><span class="o">::</span><span class="n">enable_if</span><span class="o">&lt;</span><span class="p">(</span><span class="n">N2</span> <span class="o">&lt;</span> <span class="n">N</span><span class="p">)</span><span class="o">&gt;::</span><span class="n">type</span><span class="o">&gt;</span>
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">basic_string</span><span class="o">&lt;</span><span class="n">T</span><span class="p">,</span> <span class="n">N2</span><span class="p">,</span> <span class="n">Traits</span><span class="o">&gt;</span> <span class="k">const</span><span class="o">&amp;</span> <span class="n">str</span><span class="p">,</span> <span class="n">size_type</span> <span class="n">pos</span><span class="p">,</span> <span class="n">size_type</span> <span class="n">n</span> <span class="o">=</span> <span class="n">npos</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="requires">
<h2>Requires<a class="headerlink" href="#requires" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">pos</span> <span class="pre">&lt;=</span> <span class="pre">str.size()</span></tt>.</div>
</div>
</div>
<div class="section" id="id6">
<h2>Effects<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Constructs an object of class basic_string and determines the effective length rlen of the initial string value as the smaller of n and <tt class="docutils literal"><span class="pre">str.size()</span> <span class="pre">-</span> <span class="pre">pos</span></tt>.</div>
</div>
</div>
<div class="section" id="throws">
<h2>Throws<a class="headerlink" href="#throws" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">std::out_of_range if <tt class="docutils literal"><span class="pre">pos</span> <span class="pre">&gt;</span> <span class="pre">str.size()</span></tt>.</div>
</div>
</div>
<div class="section" id="id7">
<h2>Examples<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;sprout/string.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">x</span> <span class="o">=</span> <span class="n">string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">(</span><span class="s">&quot;homuhomu&quot;</span><span class="p">);</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">y</span> <span class="o">=</span> <span class="n">string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">4</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id8">
<h2>Complexity<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Recursive function invocations in <em>O(1)</em> (constant) depth.</div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="id9">
<h2>Interface<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="k">template</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">N2</span><span class="p">,</span> <span class="k">typename</span> <span class="n">Enable</span> <span class="o">=</span> <span class="k">typename</span> <span class="n">std</span><span class="o">::</span><span class="n">enable_if</span><span class="o">&lt;</span><span class="p">(</span><span class="n">N2</span> <span class="o">-</span> <span class="mi">1</span> <span class="o">&lt;=</span> <span class="n">N</span><span class="p">)</span><span class="o">&gt;::</span><span class="n">type</span><span class="o">&gt;</span>
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">T</span> <span class="k">const</span><span class="p">(</span><span class="o">&amp;</span> <span class="n">arr</span><span class="p">)[</span><span class="n">N2</span><span class="p">]);</span>
<span class="k">template</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">N2</span><span class="p">,</span> <span class="k">typename</span> <span class="n">Enable</span> <span class="o">=</span> <span class="k">typename</span> <span class="n">std</span><span class="o">::</span><span class="n">enable_if</span><span class="o">&lt;</span><span class="p">(</span><span class="n">N2</span> <span class="o">-</span> <span class="mi">1</span> <span class="o">&lt;=</span> <span class="n">N</span><span class="p">)</span><span class="o">&gt;::</span><span class="n">type</span><span class="o">&gt;</span>
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">T</span> <span class="k">const</span><span class="p">(</span><span class="o">&amp;</span> <span class="n">arr</span><span class="p">)[</span><span class="n">N2</span><span class="p">],</span> <span class="n">size_type</span> <span class="n">n</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id10">
<h2>Requires<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">min(n,</span> <span class="pre">rlen)</span> <span class="pre">&lt;=</span> <span class="pre">N</span></tt> where rlen is length of arr.</div>
</div>
</div>
<div class="section" id="id11">
<h2>Effects<a class="headerlink" href="#id11" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Constructs an object of class basic_string.</div>
</div>
</div>
<div class="section" id="id12">
<h2>Throws<a class="headerlink" href="#id12" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">std::out_of_range if <tt class="docutils literal"><span class="pre">min(n,</span> <span class="pre">rlen)</span> <span class="pre">&gt;</span> <span class="pre">N</span></tt> where rlen is length of arr.</div>
</div>
</div>
<div class="section" id="id13">
<h2>Examples<a class="headerlink" href="#id13" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;sprout/string.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">x</span> <span class="o">=</span> <span class="n">string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">(</span><span class="s">&quot;homuhomu&quot;</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id14">
<h2>Complexity<a class="headerlink" href="#id14" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Recursive function invocations in <em>O(1)</em> (constant) depth.</div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="id15">
<h2>Interface<a class="headerlink" href="#id15" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="k">explicit</span> <span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">value_type</span> <span class="k">const</span><span class="o">*</span> <span class="n">s</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id16">
<h2>Requires<a class="headerlink" href="#id16" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">s points to an array of at least <tt class="docutils literal"><span class="pre">traits_type::length(s)</span> <span class="pre">+</span> <span class="pre">1</span></tt> elements of value_type.</div>
<div class="line"><tt class="docutils literal"><span class="pre">traits_type::length(s)</span> <span class="pre">&lt;=</span> <span class="pre">N</span></tt>.</div>
</div>
</div>
<div class="section" id="id17">
<h2>Effects<a class="headerlink" href="#id17" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Constructs an object of class basic_string and determines its initial string value from the array of value_type of length <tt class="docutils literal"><span class="pre">traits_type::length(s)</span></tt> whose first element is designated by s.</div>
</div>
</div>
<div class="section" id="id18">
<h2>Throws<a class="headerlink" href="#id18" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">std::out_of_range if <tt class="docutils literal"><span class="pre">traits_type::length(s)</span> <span class="pre">&gt;</span> <span class="pre">N</span></tt>.</div>
</div>
</div>
<div class="section" id="remarks">
<h2>Remarks<a class="headerlink" href="#remarks" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Uses <tt class="docutils literal"><span class="pre">traits_type::length()</span></tt>.</div>
</div>
</div>
<div class="section" id="id19">
<h2>Examples<a class="headerlink" href="#id19" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;sprout/string.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="kt">char</span> <span class="k">const</span><span class="o">*</span> <span class="n">input</span> <span class="o">=</span> <span class="s">&quot;homuhomu&quot;</span><span class="p">;</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">x</span> <span class="o">=</span> <span class="n">string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">(</span><span class="n">input</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id20">
<h2>Complexity<a class="headerlink" href="#id20" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Recursive function invocations in <em>O(logN)</em> (logarithmic) depth.</div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="id21">
<h2>Interface<a class="headerlink" href="#id21" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">value_type</span> <span class="k">const</span><span class="o">*</span> <span class="n">s</span><span class="p">,</span> <span class="n">size_type</span> <span class="n">n</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id22">
<h2>Requires<a class="headerlink" href="#id22" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">s points to an array of at least n elements of value_type.</div>
<div class="line"><tt class="docutils literal"><span class="pre">min(n,</span> <span class="pre">traits_type::length(s))</span> <span class="pre">&lt;=</span> <span class="pre">N</span></tt>.</div>
</div>
</div>
<div class="section" id="id23">
<h2>Effects<a class="headerlink" href="#id23" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Constructs an object of class basic_string and determines its initial string value from the array of value_type of length n whose first element is designated by s.</div>
</div>
</div>
<div class="section" id="id24">
<h2>Throws<a class="headerlink" href="#id24" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">std::out_of_range if <tt class="docutils literal"><span class="pre">min(n,</span> <span class="pre">traits_type::length(s))</span> <span class="pre">&gt;</span> <span class="pre">N</span></tt>.</div>
</div>
</div>
<div class="section" id="id25">
<h2>Examples<a class="headerlink" href="#id25" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;sprout/string.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="kt">char</span> <span class="k">const</span><span class="o">*</span> <span class="n">input</span> <span class="o">=</span> <span class="s">&quot;homuhomu&quot;</span><span class="p">;</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">x</span> <span class="o">=</span> <span class="n">string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">(</span><span class="n">input</span><span class="p">,</span> <span class="mi">4</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id26">
<h2>Complexity<a class="headerlink" href="#id26" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Recursive function invocations in <em>O(logN)</em> (logarithmic) depth.</div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="id27">
<h2>Interface<a class="headerlink" href="#id27" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">size_type</span> <span class="n">n</span><span class="p">,</span> <span class="n">value_type</span> <span class="n">c</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id28">
<h2>Requires<a class="headerlink" href="#id28" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">n</span> <span class="pre">&lt;</span> <span class="pre">N</span></tt>.</div>
</div>
</div>
<div class="section" id="id29">
<h2>Effects<a class="headerlink" href="#id29" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Constructs an object of class basic_string and determines its initial string value by repeating the char-like object c for all n elements.</div>
</div>
</div>
<div class="section" id="id30">
<h2>Throws<a class="headerlink" href="#id30" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">std::out_of_range if <tt class="docutils literal"><span class="pre">n</span> <span class="pre">&gt;</span> <span class="pre">N</span></tt>.</div>
</div>
</div>
<div class="section" id="id31">
<h2>Examples<a class="headerlink" href="#id31" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;sprout/string.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">x</span> <span class="o">=</span> <span class="n">string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">(</span><span class="mi">8</span><span class="p">,</span> <span class="sc">&#39;H&#39;</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id32">
<h2>Complexity<a class="headerlink" href="#id32" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Recursive function invocations in <em>O(1)</em> (constant) depth.</div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="id33">
<h2>Interface<a class="headerlink" href="#id33" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="k">template</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">InputIterator</span><span class="o">&gt;</span>
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">InputIterator</span> <span class="n">first</span><span class="p">,</span> <span class="n">InputIterator</span> <span class="n">last</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id34">
<h2>Requires<a class="headerlink" href="#id34" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">distance(first,</span> <span class="pre">last)</span> <span class="pre">&lt;=</span> <span class="pre">N</span></tt>.</div>
</div>
</div>
<div class="section" id="id35">
<h2>Effects<a class="headerlink" href="#id35" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">If InputIterator is an integral type, equivalent to <tt class="docutils literal"><span class="pre">basic_string(static_cast&lt;size_type&gt;(first),</span> <span class="pre">static_cast&lt;value_type&gt;(last))</span></tt>.</div>
<div class="line">Otherwise constructs a string from the values in the range [begin,end).</div>
</div>
</div>
<div class="section" id="id36">
<h2>Throws<a class="headerlink" href="#id36" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">std::out_of_range if <tt class="docutils literal"><span class="pre">distance(first,</span> <span class="pre">last)</span> <span class="pre">&gt;</span> <span class="pre">N</span></tt>.</div>
</div>
</div>
<div class="section" id="id37">
<h2>Examples<a class="headerlink" href="#id37" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;sprout/string.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">x</span> <span class="o">=</span> <span class="n">string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">(</span><span class="s">&quot;homuhomu&quot;</span><span class="p">);</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">y</span> <span class="o">=</span> <span class="n">string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">(</span><span class="n">x</span><span class="p">.</span><span class="n">begin</span><span class="p">(),</span> <span class="n">x</span><span class="p">.</span><span class="n">end</span><span class="p">());</span>
</pre></div>
</div>
</div>
<div class="section" id="id38">
<h2>Complexity<a class="headerlink" href="#id38" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Recursive function invocations in <em>O(1)</em> (constant) depth if InputIterator meets ConstexprRandomAccessIterator requirements or an integral type, and <em>O(logN)</em> (logarithmic) depth otherwise.</div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="id39">
<h2>Interface<a class="headerlink" href="#id39" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="n">basic_string</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">initializer_list</span><span class="o">&lt;</span><span class="n">value_type</span><span class="o">&gt;</span> <span class="n">il</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id40">
<h2>Requires<a class="headerlink" href="#id40" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">il.size()</span> <span class="pre">&lt;=</span> <span class="pre">N</span></tt>.</div>
</div>
</div>
<div class="section" id="id41">
<h2>Effects<a class="headerlink" href="#id41" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Same as <tt class="docutils literal"><span class="pre">basic_string(il.begin(),</span> <span class="pre">il.end())</span></tt>.</div>
</div>
</div>
<div class="section" id="id42">
<h2>Throws<a class="headerlink" href="#id42" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">std::out_of_range if <tt class="docutils literal"><span class="pre">il.size()</span> <span class="pre">&gt;</span> <span class="pre">N</span></tt>.</div>
</div>
</div>
<div class="section" id="id43">
<h2>Examples<a class="headerlink" href="#id43" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;sprout/string.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">x</span> <span class="o">=</span> <span class="n">string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">({</span><span class="sc">&#39;h&#39;</span><span class="p">,</span> <span class="sc">&#39;o&#39;</span><span class="p">,</span> <span class="sc">&#39;m&#39;</span><span class="p">,</span> <span class="sc">&#39;u&#39;</span><span class="p">,</span> <span class="sc">&#39;h&#39;</span><span class="p">,</span> <span class="sc">&#39;o&#39;</span><span class="p">,</span> <span class="sc">&#39;m&#39;</span><span class="p">,</span> <span class="sc">&#39;u&#39;</span><span class="p">});</span>
</pre></div>
</div>
</div>
<div class="section" id="id44">
<h2>Complexity<a class="headerlink" href="#id44" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Recursive function invocations in <em>O(1)</em> (constant) depth.</div>
</div>
</div>
<div class="section" id="header">
<h2>Header<a class="headerlink" href="#header" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">sprout/string/string.hpp</span></tt></div>
<div class="line">Convenience header: <tt class="docutils literal"><span class="pre">sprout/string.hpp</span></tt></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="operator-assign.html" title="operator="
>next</a> |</li>
<li class="right" >
<a href="index.html" title="basic_string"
>previous</a> |</li>
<li><a href="../../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Libraries</a> &raquo;</li>
<li><a href="../index.html" >Sprout.String</a> &raquo;</li>
<li><a href="index.html" >basic_string</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013, Bolero MURAKAMI.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>

13
docs/libs/string/basic_string/index.html
View file

@ -38,7 +38,7 @@
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="top" title="Sprout 1.0 documentation" href="../../../index.html" />
<link rel="up" title="Sprout.String" href="../index.html" />
<link rel="next" title="operator=" href="operator-assign.html" />
<link rel="next" title="basic_string" href="constructor-.html" />
<link rel="prev" title="assign" href="../char_traits/assign-iterator.html" />
</head>
<body>
@ -49,7 +49,7 @@
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="operator-assign.html" title="operator="
<a href="constructor-.html" title="basic_string"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../char_traits/assign-iterator.html" title="assign"
@ -92,8 +92,8 @@
<p class="topless"><a href="../char_traits/assign-iterator.html"
title="previous chapter">assign</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="operator-assign.html"
title="next chapter">operator=</a></p>
<p class="topless"><a href="constructor-.html"
title="next chapter">basic_string</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/index.txt"
@ -217,7 +217,7 @@ convertible to pointer</td>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><tt class="xref doc docutils literal"><span class="pre">(constructor)</span></tt></td>
<tr class="row-even"><td><a class="reference internal" href="constructor-.html"><em>(constructor)</em></a></td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="operator-assign.html"><em>operator=</em></a></td>
@ -533,6 +533,7 @@ convertible to pointer</td>
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">T</span> <span class="k">const</span><span class="p">(</span><span class="o">&amp;</span> <span class="n">arr</span><span class="p">)[</span><span class="n">N2</span><span class="p">],</span> <span class="n">size_type</span> <span class="n">n</span><span class="p">);</span>
<span class="k">explicit</span> <span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">value_type</span> <span class="k">const</span><span class="o">*</span> <span class="n">s</span><span class="p">);</span>
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">value_type</span> <span class="k">const</span><span class="o">*</span> <span class="n">s</span><span class="p">,</span> <span class="n">size_type</span> <span class="n">n</span><span class="p">);</span>
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">size_type</span> <span class="n">n</span><span class="p">,</span> <span class="n">value_type</span> <span class="n">c</span><span class="p">);</span>
<span class="k">template</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">InputIterator</span><span class="o">&gt;</span>
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">basic_string</span><span class="p">(</span><span class="n">InputIterator</span> <span class="n">first</span><span class="p">,</span> <span class="n">InputIterator</span> <span class="n">last</span><span class="p">);</span>
<span class="n">basic_string</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">initializer_list</span><span class="o">&lt;</span><span class="n">value_type</span><span class="o">&gt;</span> <span class="n">il</span><span class="p">);</span>
@ -698,7 +699,7 @@ convertible to pointer</td>
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="operator-assign.html" title="operator="
<a href="constructor-.html" title="basic_string"
>next</a> |</li>
<li class="right" >
<a href="../char_traits/assign-iterator.html" title="assign"

8
docs/libs/string/basic_string/operator-assign.html
View file

@ -39,7 +39,7 @@
<link rel="top" title="Sprout 1.0 documentation" href="../../../index.html" />
<link rel="up" title="basic_string" href="index.html" />
<link rel="next" title="begin" href="begin.html" />
<link rel="prev" title="basic_string" href="index.html" />
<link rel="prev" title="basic_string" href="constructor-.html" />
</head>
<body>
<div class="related">
@ -52,7 +52,7 @@
<a href="begin.html" title="begin"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="basic_string"
<a href="constructor-.html" title="basic_string"
accesskey="P">previous</a> |</li>
<li><a href="../../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Libraries</a> &raquo;</li>
@ -78,7 +78,7 @@
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
<p class="topless"><a href="constructor-.html"
title="previous chapter">basic_string</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="begin.html"
@ -191,7 +191,7 @@
<a href="begin.html" title="begin"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="basic_string"
<a href="constructor-.html" title="basic_string"
>previous</a> |</li>
<li><a href="../../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Libraries</a> &raquo;</li>

2
docs/libs/string/basic_string/substr.html
View file

@ -124,7 +124,7 @@
<div class="section" id="returns">
<h2>Returns<a class="headerlink" href="#returns" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">basic_string(data()</span> <span class="pre">+</span> <span class="pre">pos,</span> <span class="pre">rlen)</span></tt> when rlen is the smaller of n and <tt class="docutils literal"><span class="pre">size()</span> <span class="pre">-</span> <span class="pre">pos</span></tt>.</div>
<div class="line"><tt class="docutils literal"><span class="pre">basic_string(data()</span> <span class="pre">+</span> <span class="pre">pos,</span> <span class="pre">rlen)</span></tt> where rlen is the smaller of n and <tt class="docutils literal"><span class="pre">size()</span> <span class="pre">-</span> <span class="pre">pos</span></tt>.</div>
</div>
</div>
<div class="section" id="throws">

2
docs/searchindex.js
View file

File diff suppressed because one or more lines are too long

346
source/libs/string/basic_string/constructor-.rst Normal file
View file

@ -0,0 +1,346 @@
.. _sprout-string-basic_string-constructor-:
###############################################################################
basic_string
###############################################################################
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR basic_string() = default;
Effects
========================================
| Constructs an empty object of class basic_string.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>();
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
----
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR basic_string(basic_string const&) = default;
template<std::size_t N2, typename Enable = typename std::enable_if<(N2 < N)>::type>
SPROUT_CONSTEXPR basic_string(basic_string<T, N2, Traits> const& str);
Effects
========================================
| Constructs an object of class basic_string.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>("homuhomu");
SPROUT_STATIC_CONSTEXPR auto y = string<8>(x);
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
----
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR basic_string(basic_string const& str, size_type pos, size_type n = npos);
template<std::size_t N2, typename Enable = typename std::enable_if<(N2 < N)>::type>
SPROUT_CONSTEXPR basic_string(basic_string<T, N2, Traits> const& str, size_type pos, size_type n = npos);
Requires
========================================
| ``pos <= str.size()``.
Effects
========================================
| Constructs an object of class basic_string and determines the effective length rlen of the initial string value as the smaller of n and ``str.size() - pos``.
Throws
========================================
| std::out_of_range if ``pos > str.size()``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>("homuhomu");
SPROUT_STATIC_CONSTEXPR auto y = string<8>(x, 4, 4);
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
----
Interface
========================================
.. sourcecode:: c++
template<std::size_t N2, typename Enable = typename std::enable_if<(N2 - 1 <= N)>::type>
SPROUT_CONSTEXPR basic_string(T const(& arr)[N2]);
template<std::size_t N2, typename Enable = typename std::enable_if<(N2 - 1 <= N)>::type>
SPROUT_CONSTEXPR basic_string(T const(& arr)[N2], size_type n);
Requires
========================================
| ``min(n, rlen) <= N`` where rlen is length of arr.
Effects
========================================
| Constructs an object of class basic_string.
Throws
========================================
| std::out_of_range if ``min(n, rlen) > N`` where rlen is length of arr.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>("homuhomu");
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
----
Interface
========================================
.. sourcecode:: c++
explicit SPROUT_CONSTEXPR basic_string(value_type const* s);
Requires
========================================
| s points to an array of at least ``traits_type::length(s) + 1`` elements of value_type.
| ``traits_type::length(s) <= N``.
Effects
========================================
| Constructs an object of class basic_string and determines its initial string value from the array of value_type of length ``traits_type::length(s)`` whose first element is designated by s.
Throws
========================================
| std::out_of_range if ``traits_type::length(s) > N``.
Remarks
========================================
| Uses ``traits_type::length()``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR char const* input = "homuhomu";
SPROUT_STATIC_CONSTEXPR auto x = string<8>(input);
Complexity
========================================
| Recursive function invocations in *O(logN)* (logarithmic) depth.
----
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR basic_string(value_type const* s, size_type n);
Requires
========================================
| s points to an array of at least n elements of value_type.
| ``min(n, traits_type::length(s)) <= N``.
Effects
========================================
| Constructs an object of class basic_string and determines its initial string value from the array of value_type of length n whose first element is designated by s.
Throws
========================================
| std::out_of_range if ``min(n, traits_type::length(s)) > N``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR char const* input = "homuhomu";
SPROUT_STATIC_CONSTEXPR auto x = string<8>(input, 4);
Complexity
========================================
| Recursive function invocations in *O(logN)* (logarithmic) depth.
----
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR basic_string(size_type n, value_type c);
Requires
========================================
| ``n < N``.
Effects
========================================
| Constructs an object of class basic_string and determines its initial string value by repeating the char-like object c for all n elements.
Throws
========================================
| std::out_of_range if ``n > N``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>(8, 'H');
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
----
Interface
========================================
.. sourcecode:: c++
template<typename InputIterator>
SPROUT_CONSTEXPR basic_string(InputIterator first, InputIterator last);
Requires
========================================
| ``distance(first, last) <= N``.
Effects
========================================
| If InputIterator is an integral type, equivalent to ``basic_string(static_cast<size_type>(first), static_cast<value_type>(last))``.
| Otherwise constructs a string from the values in the range [begin,end).
Throws
========================================
| std::out_of_range if ``distance(first, last) > N``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>("homuhomu");
SPROUT_STATIC_CONSTEXPR auto y = string<8>(x.begin(), x.end());
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth if InputIterator meets ConstexprRandomAccessIterator requirements or an integral type, and *O(logN)* (logarithmic) depth otherwise.
----
Interface
========================================
.. sourcecode:: c++
basic_string(std::initializer_list<value_type> il);
Requires
========================================
| ``il.size() <= N``.
Effects
========================================
| Same as ``basic_string(il.begin(), il.end())``.
Throws
========================================
| std::out_of_range if ``il.size() > N``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>({'h', 'o', 'm', 'u', 'h', 'o', 'm', 'u'});
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

1
source/libs/string/basic_string/index.rst
View file

@ -253,6 +253,7 @@ Interface of all
SPROUT_CONSTEXPR basic_string(T const(& arr)[N2], size_type n);
explicit SPROUT_CONSTEXPR basic_string(value_type const* s);
SPROUT_CONSTEXPR basic_string(value_type const* s, size_type n);
SPROUT_CONSTEXPR basic_string(size_type n, value_type c);
template<typename InputIterator>
SPROUT_CONSTEXPR basic_string(InputIterator first, InputIterator last);
basic_string(std::initializer_list<value_type> il);

2
source/libs/string/basic_string/substr.rst
View file

@ -17,7 +17,7 @@ Requires
Returns
========================================
| ``basic_string(data() + pos, rlen)`` when rlen is the smaller of n and ``size() - pos``.
| ``basic_string(data() + pos, rlen)`` where rlen is the smaller of n and ``size() - pos``.
Throws
========================================