add doc: basic_string assign

This commit is contained in:
Bolero-MURAKAMI 2013-09-08 18:59:50 +09:00
parent c6a9bf338a
commit 5af5e8c300
24 changed files with 1489 additions and 44 deletions

View file

@ -16,7 +16,9 @@ Interface
Effects
========================================
| ``std::copy(rhs.begin(), rhs.end(), begin())``, ``std::move(rhs.begin(), rhs.end(), begin())``.
| ``std::copy(rhs.begin(), rhs.end(), begin())``.
| or
| ``std::move(rhs.begin(), rhs.end(), begin())``.
Returns
========================================
@ -28,10 +30,13 @@ Examples
.. sourcecode:: c++
#include <sprout/array.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
auto x = array<int, 10>{{1, 2, 3, 4, 5, 6, 7, 8, 9, 10}};
x = array<int, 10>{{10, 9, 8, 7, 6, 5, 4, 3, 2, 1}};
SPROUT_STATIC_CONSTEXPR auto y = array<int, 10>{{10, 9, 8, 7, 6, 5, 4, 3, 2, 1}};
x = y;
SPROUT_ASSERT_MSG(x == y, "y is assigned to x.");
Header
========================================

View file

@ -0,0 +1,158 @@
.. _sprout-string-basic_string-assign:
###############################################################################
assign
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<std::size_t N2>
basic_string& assign(basic_string<T, N2, Traits> const& str);
Effects
========================================
| Equivalent to ``assign(str, 0, npos)``.
Returns
========================================
| ``*this``.
----
Interface
========================================
.. sourcecode:: c++
template<std::size_t N2>
basic_string& assign(basic_string<T, N2, Traits> const& str, size_type pos, size_type n);
Requires
========================================
| ``pos <= str.size()``.
Effects
========================================
| Determines the effective length rlen of the string to assign as the smaller of n and ``str.size() - pos`` and calls ``assign(str.data() + pos, rlen)``.
Returns
========================================
| ``*this``.
Throws
========================================
| std::out_of_range if ``pos > str.size()``.
----
Interface
========================================
.. sourcecode:: c++
basic_string& assign(value_type const* s, size_type n);
Requires
========================================
| s points to an array of at least n elements of value_type.
Effects
========================================
| Replaces the string controlled by *this with a string of length n whose elements are a copy of those pointed to by s.
Returns
========================================
| ``*this``.
Throws
========================================
| std::length_error if ``n > max_size()``.
----
Interface
========================================
.. sourcecode:: c++
basic_string& assign(value_type const* s);
Requires
========================================
| s points to an array of at least ``traits_type::length(s) + 1`` elements of value_type.
Effects
========================================
| Calls ``assign(s, traits_type::length(s))``.
Returns
========================================
| ``*this``.
----
Interface
========================================
.. sourcecode:: c++
basic_string& assign(size_type n, value_type c);
Effects
========================================
| Equivalent to ``assign(basic_string(n, c))``.
Returns
========================================
| ``*this``.
----
Interface
========================================
.. sourcecode:: c++
template<typename InputIterator>
basic_string& assign(InputIterator first, InputIterator last);
Effects
========================================
| Equivalent to ``assign(basic_string(first, last))``.
Returns
========================================
| ``*this``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
auto x = string<8>("homuhomu");
SPROUT_STATIC_CONSTEXPR auto y = string<8>("madocchi");
x.assign(y);
SPROUT_ASSERT_MSG(x == y, "y is assigned to x.");
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

View file

@ -0,0 +1,34 @@
.. _sprout-string-basic_string-clear:
###############################################################################
clear
###############################################################################
Interface
========================================
.. sourcecode:: c++
void clear() SPROUT_NOEXCEPT;
Effects
========================================
| Fill [begin,end) with value_type(), and set the 0 to length.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
auto x = string<8>("homuhomu");
x.clear();
SPROUT_ASSERT_MSG(x.size() == 0 && x == "", "string is cleared.");
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

View file

@ -282,7 +282,7 @@ Interface of all
SPROUT_CONSTEXPR size_type max_size() const SPROUT_NOEXCEPT;
void resize(size_type n, value_type c);
void resize(size_type n);
void clear();
void clear() SPROUT_NOEXCEPT;
SPROUT_CONSTEXPR bool empty() const SPROUT_NOEXCEPT;
// element access:

View file

@ -0,0 +1,37 @@
.. _sprout-string-basic_string-length:
###############################################################################
length
###############################################################################
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR size_type length() const SPROUT_NOEXCEPT;
Returns
========================================
| The number of elements contained in the string.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto input = string<8>("homuhomu");
static_assert(input.length() == 8, "input size is 8.");
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

View file

@ -0,0 +1,50 @@
.. _sprout-string-basic_string-resize:
###############################################################################
resize
###############################################################################
Interface
========================================
.. sourcecode:: c++
void resize(size_type n, value_type c);
void resize(size_type n);
Requires
========================================
| ``n <= max_size()``.
Effects
========================================
| Alters the length of the string designated by *this as follows:
* If ``n <= size()``, the function replaces the string designated by ``*this`` with a string of length n whose elements are a copy of the initial elements of the original string designated by ``*this``.
* If ``n > size()``, the function replaces the string designated by ``*this`` with a string of length n whose first size() elements are a copy of the original string designated by ``*this``, and whose remaining elements are all initialized to c.
| Equivalent to ``resize(n, value_type())`` when there is no parameter c.
Throws
========================================
| std::length_error if ``n > max_size()``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
auto x = string<8>("homuhomu");
x.resize(4);
SPROUT_ASSERT_MSG(x.size() == 4 && x == "homu", "string is resized to 4.");
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

View file

@ -121,7 +121,11 @@
<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"><tt class="docutils literal"><span class="pre">std::copy(rhs.begin(),</span> <span class="pre">rhs.end(),</span> <span class="pre">begin())</span></tt>, <tt class="docutils literal"><span class="pre">std::move(rhs.begin(),</span> <span class="pre">rhs.end(),</span> <span class="pre">begin())</span></tt>.</div>
<div class="line"><tt class="docutils literal"><span class="pre">std::copy(rhs.begin(),</span> <span class="pre">rhs.end(),</span> <span class="pre">begin())</span></tt>.</div>
<div class="line">or</div>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">std::move(rhs.begin(),</span> <span class="pre">rhs.end(),</span> <span class="pre">begin())</span></tt>.</div>
</div>
</div>
</div>
<div class="section" id="returns">
@ -133,10 +137,13 @@
<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/array.hpp&gt;</span>
<span class="cp">#include &lt;sprout/assert.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="k">auto</span> <span class="n">x</span> <span class="o">=</span> <span class="n">array</span><span class="o">&lt;</span><span class="kt">int</span><span class="p">,</span> <span class="mi">10</span><span class="o">&gt;</span><span class="p">{{</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">10</span><span class="p">}};</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">array</span><span class="o">&lt;</span><span class="kt">int</span><span class="p">,</span> <span class="mi">10</span><span class="o">&gt;</span><span class="p">{{</span><span class="mi">10</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">1</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">array</span><span class="o">&lt;</span><span class="kt">int</span><span class="p">,</span> <span class="mi">10</span><span class="o">&gt;</span><span class="p">{{</span><span class="mi">10</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">}};</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">y</span><span class="p">;</span>
<span class="n">SPROUT_ASSERT_MSG</span><span class="p">(</span><span class="n">x</span> <span class="o">==</span> <span class="n">y</span><span class="p">,</span> <span class="s">&quot;y is assigned to x.&quot;</span><span class="p">);</span>
</pre></div>
</div>
</div>

View file

@ -0,0 +1,328 @@
<!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>assign &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="swap" href="swap.html" />
<link rel="prev" title="back" href="back.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="swap.html" title="swap"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="back.html" title="back"
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="#">assign</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="#returns">Returns</a></li>
<li><a class="reference internal" href="#id1">Interface</a></li>
<li><a class="reference internal" href="#requires">Requires</a></li>
<li><a class="reference internal" href="#id2">Effects</a></li>
<li><a class="reference internal" href="#id3">Returns</a></li>
<li><a class="reference internal" href="#throws">Throws</a></li>
<li><a class="reference internal" href="#id4">Interface</a></li>
<li><a class="reference internal" href="#id5">Requires</a></li>
<li><a class="reference internal" href="#id6">Effects</a></li>
<li><a class="reference internal" href="#id9">Returns</a></li>
<li><a class="reference internal" href="#id10">Throws</a></li>
<li><a class="reference internal" href="#id11">Interface</a></li>
<li><a class="reference internal" href="#id12">Requires</a></li>
<li><a class="reference internal" href="#id13">Effects</a></li>
<li><a class="reference internal" href="#id14">Returns</a></li>
<li><a class="reference internal" href="#id15">Interface</a></li>
<li><a class="reference internal" href="#id16">Effects</a></li>
<li><a class="reference internal" href="#id17">Returns</a></li>
<li><a class="reference internal" href="#id18">Interface</a></li>
<li><a class="reference internal" href="#id19">Effects</a></li>
<li><a class="reference internal" href="#id20">Returns</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#header">Header</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="back.html"
title="previous chapter">back</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="swap.html"
title="next chapter">swap</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/assign.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="assign">
<h1>assign<a class="headerlink" href="#assign" 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="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="o">&gt;</span>
<span class="n">basic_string</span><span class="o">&amp;</span> <span class="n">assign</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="effects">
<h2>Effects<a class="headerlink" href="#effects" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Equivalent to <tt class="docutils literal"><span class="pre">assign(str,</span> <span class="pre">0,</span> <span class="pre">npos)</span></tt>.</div>
</div>
</div>
<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">*this</span></tt>.</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="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="o">&gt;</span>
<span class="n">basic_string</span><span class="o">&amp;</span> <span class="n">assign</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="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="id2">
<h2>Effects<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Determines the effective length rlen of the string to assign 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> and calls <tt class="docutils literal"><span class="pre">assign(str.data()</span> <span class="pre">+</span> <span class="pre">pos,</span> <span class="pre">rlen)</span></tt>.</div>
</div>
</div>
<div class="section" id="id3">
<h2>Returns<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">*this</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>
<hr class="docutils" />
<div class="section" id="id4">
<h2>Interface<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="n">basic_string</span><span class="o">&amp;</span> <span class="n">assign</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="id5">
<h2>Requires<a class="headerlink" href="#id5" 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>
</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">Replaces the string controlled by <a href="#id7"><span class="problematic" id="id8">*</span></a>this with a string of length n whose elements are a copy of those pointed to by s.</div>
</div>
</div>
<div class="section" id="id9">
<h2>Returns<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">*this</span></tt>.</div>
</div>
</div>
<div class="section" id="id10">
<h2>Throws<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">std::length_error if <tt class="docutils literal"><span class="pre">n</span> <span class="pre">&gt;</span> <span class="pre">max_size()</span></tt>.</div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="id11">
<h2>Interface<a class="headerlink" href="#id11" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="n">basic_string</span><span class="o">&amp;</span> <span class="n">assign</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="id12">
<h2>Requires<a class="headerlink" href="#id12" 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>
</div>
<div class="section" id="id13">
<h2>Effects<a class="headerlink" href="#id13" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Calls <tt class="docutils literal"><span class="pre">assign(s,</span> <span class="pre">traits_type::length(s))</span></tt>.</div>
</div>
</div>
<div class="section" id="id14">
<h2>Returns<a class="headerlink" href="#id14" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">*this</span></tt>.</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="n">basic_string</span><span class="o">&amp;</span> <span class="n">assign</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="id16">
<h2>Effects<a class="headerlink" href="#id16" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Equivalent to <tt class="docutils literal"><span class="pre">assign(basic_string(n,</span> <span class="pre">c))</span></tt>.</div>
</div>
</div>
<div class="section" id="id17">
<h2>Returns<a class="headerlink" href="#id17" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">*this</span></tt>.</div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="id18">
<h2>Interface<a class="headerlink" href="#id18" 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">basic_string</span><span class="o">&amp;</span> <span class="n">assign</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="id19">
<h2>Effects<a class="headerlink" href="#id19" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Equivalent to <tt class="docutils literal"><span class="pre">assign(basic_string(first,</span> <span class="pre">last))</span></tt>.</div>
</div>
</div>
<div class="section" id="id20">
<h2>Returns<a class="headerlink" href="#id20" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">*this</span></tt>.</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="cp">#include &lt;sprout/assert.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</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="s">&quot;madocchi&quot;</span><span class="p">);</span>
<span class="n">x</span><span class="p">.</span><span class="n">assign</span><span class="p">(</span><span class="n">y</span><span class="p">);</span>
<span class="n">SPROUT_ASSERT_MSG</span><span class="p">(</span><span class="n">x</span> <span class="o">==</span> <span class="n">y</span><span class="p">,</span> <span class="s">&quot;y is assigned to x.&quot;</span><span class="p">);</span>
</pre></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="swap.html" title="swap"
>next</a> |</li>
<li class="right" >
<a href="back.html" title="back"
>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>

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="basic_string" href="index.html" />
<link rel="next" title="swap" href="swap.html" />
<link rel="next" title="assign" href="assign.html" />
<link rel="prev" title="front" href="front.html" />
</head>
<body>
@ -49,7 +49,7 @@
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="swap.html" title="swap"
<a href="assign.html" title="assign"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="front.html" title="front"
@ -78,8 +78,8 @@
<p class="topless"><a href="front.html"
title="previous chapter">front</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="swap.html"
title="next chapter">swap</a></p>
<p class="topless"><a href="assign.html"
title="next chapter">assign</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/back.txt"
@ -160,7 +160,7 @@
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="swap.html" title="swap"
<a href="assign.html" title="assign"
>next</a> |</li>
<li class="right" >
<a href="front.html" title="front"

View file

@ -0,0 +1,172 @@
<!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>clear &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="empty" href="empty.html" />
<link rel="prev" title="resize" href="resize.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="empty.html" title="empty"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="resize.html" title="resize"
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="#">clear</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="#header">Header</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="resize.html"
title="previous chapter">resize</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="empty.html"
title="next chapter">empty</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/clear.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="clear">
<h1>clear<a class="headerlink" href="#clear" 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="kt">void</span> <span class="n">clear</span><span class="p">()</span> <span class="n">SPROUT_NOEXCEPT</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">Fill [begin,end) with value_type(), and set the 0 to length.</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="cp">#include &lt;sprout/assert.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</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">x</span><span class="p">.</span><span class="n">clear</span><span class="p">();</span>
<span class="n">SPROUT_ASSERT_MSG</span><span class="p">(</span><span class="n">x</span><span class="p">.</span><span class="n">size</span><span class="p">()</span> <span class="o">==</span> <span class="mi">0</span> <span class="o">&amp;&amp;</span> <span class="n">x</span> <span class="o">==</span> <span class="s">&quot;&quot;</span><span class="p">,</span> <span class="s">&quot;string is cleared.&quot;</span><span class="p">);</span>
</pre></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="empty.html" title="empty"
>next</a> |</li>
<li class="right" >
<a href="resize.html" title="resize"
>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>

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="operator[]" href="operator-subscript.html" />
<link rel="prev" title="max_size" href="max_size.html" />
<link rel="prev" title="clear" href="clear.html" />
</head>
<body>
<div class="related">
@ -52,7 +52,7 @@
<a href="operator-subscript.html" title="operator[]"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="max_size.html" title="max_size"
<a href="clear.html" title="clear"
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>
@ -75,8 +75,8 @@
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="max_size.html"
title="previous chapter">max_size</a></p>
<p class="topless"><a href="clear.html"
title="previous chapter">clear</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="operator-subscript.html"
title="next chapter">operator[]</a></p>
@ -161,7 +161,7 @@
<a href="operator-subscript.html" title="operator[]"
>next</a> |</li>
<li class="right" >
<a href="max_size.html" title="max_size"
<a href="clear.html" title="clear"
>previous</a> |</li>
<li><a href="../../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Libraries</a> &raquo;</li>

View file

@ -282,16 +282,16 @@ convertible to pointer</td>
<tr class="row-even"><td><a class="reference internal" href="size.html"><em>size</em></a></td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><tt class="xref doc docutils literal"><span class="pre">length</span></tt></td>
<tr class="row-odd"><td><a class="reference internal" href="length.html"><em>length</em></a></td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="max_size.html"><em>max_size</em></a></td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><tt class="xref doc docutils literal"><span class="pre">resize</span></tt></td>
<tr class="row-odd"><td><a class="reference internal" href="resize.html"><em>resize</em></a></td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><tt class="xref doc docutils literal"><span class="pre">clear</span></tt></td>
<tr class="row-even"><td><a class="reference internal" href="clear.html"><em>clear</em></a></td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="empty.html"><em>empty</em></a></td>
@ -341,7 +341,7 @@ convertible to pointer</td>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><tt class="xref doc docutils literal"><span class="pre">assign</span></tt></td>
<tr class="row-even"><td><a class="reference internal" href="assign.html"><em>assign</em></a></td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="swap.html"><em>swap</em></a></td>
@ -562,7 +562,7 @@ convertible to pointer</td>
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">size_type</span> <span class="n">max_size</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
<span class="kt">void</span> <span class="n">resize</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="kt">void</span> <span class="n">resize</span><span class="p">(</span><span class="n">size_type</span> <span class="n">n</span><span class="p">);</span>
<span class="kt">void</span> <span class="n">clear</span><span class="p">();</span>
<span class="kt">void</span> <span class="n">clear</span><span class="p">()</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
<span class="n">SPROUT_CONSTEXPR</span> <span class="kt">bool</span> <span class="n">empty</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
<span class="c1">// element access:</span>

View file

@ -0,0 +1,177 @@
<!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>length &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="max_size" href="max_size.html" />
<link rel="prev" title="size" href="size.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="max_size.html" title="max_size"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="size.html" title="size"
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="#">length</a><ul>
<li><a class="reference internal" href="#interface">Interface</a></li>
<li><a class="reference internal" href="#returns">Returns</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="#header">Header</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="size.html"
title="previous chapter">size</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="max_size.html"
title="next chapter">max_size</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/length.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="length">
<h1>length<a class="headerlink" href="#length" 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">size_type</span> <span class="n">length</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
</pre></div>
</div>
</div>
<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">The number of elements contained in the 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">input</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">static_assert</span><span class="p">(</span><span class="n">input</span><span class="p">.</span><span class="n">length</span><span class="p">()</span> <span class="o">==</span> <span class="mi">8</span><span class="p">,</span> <span class="s">&quot;input size is 8.&quot;</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>
<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="max_size.html" title="max_size"
>next</a> |</li>
<li class="right" >
<a href="size.html" title="size"
>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>

View file

@ -38,8 +38,8 @@
<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="empty" href="empty.html" />
<link rel="prev" title="size" href="size.html" />
<link rel="next" title="resize" href="resize.html" />
<link rel="prev" title="length" href="length.html" />
</head>
<body>
<div class="related">
@ -49,10 +49,10 @@
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="empty.html" title="empty"
<a href="resize.html" title="resize"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="size.html" title="size"
<a href="length.html" title="length"
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>
@ -75,11 +75,11 @@
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="size.html"
title="previous chapter">size</a></p>
<p class="topless"><a href="length.html"
title="previous chapter">length</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="empty.html"
title="next chapter">empty</a></p>
<p class="topless"><a href="resize.html"
title="next chapter">resize</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/max_size.txt"
@ -158,10 +158,10 @@
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="empty.html" title="empty"
<a href="resize.html" title="resize"
>next</a> |</li>
<li class="right" >
<a href="size.html" title="size"
<a href="length.html" title="length"
>previous</a> |</li>
<li><a href="../../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Libraries</a> &raquo;</li>

View file

@ -0,0 +1,193 @@
<!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>resize &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="clear" href="clear.html" />
<link rel="prev" title="max_size" href="max_size.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="clear.html" title="clear"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="max_size.html" title="max_size"
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="#">resize</a><ul>
<li><a class="reference internal" href="#interface">Interface</a></li>
<li><a class="reference internal" href="#requires">Requires</a></li>
<li><a class="reference internal" href="#effects">Effects</a></li>
<li><a class="reference internal" href="#throws">Throws</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#header">Header</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="max_size.html"
title="previous chapter">max_size</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="clear.html"
title="next chapter">clear</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/resize.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="resize">
<h1>resize<a class="headerlink" href="#resize" 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="kt">void</span> <span class="n">resize</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="kt">void</span> <span class="n">resize</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="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">n</span> <span class="pre">&lt;=</span> <span class="pre">max_size()</span></tt>.</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">Alters the length of the string designated by <a href="#id1"><span class="problematic" id="id2">*</span></a>this as follows:
* If <tt class="docutils literal"><span class="pre">n</span> <span class="pre">&lt;=</span> <span class="pre">size()</span></tt>, the function replaces the string designated by <tt class="docutils literal"><span class="pre">*this</span></tt> with a string of length n whose elements are a copy of the initial elements of the original string designated by <tt class="docutils literal"><span class="pre">*this</span></tt>.
* If <tt class="docutils literal"><span class="pre">n</span> <span class="pre">&gt;</span> <span class="pre">size()</span></tt>, the function replaces the string designated by <tt class="docutils literal"><span class="pre">*this</span></tt> with a string of length n whose first size() elements are a copy of the original string designated by <tt class="docutils literal"><span class="pre">*this</span></tt>, and whose remaining elements are all initialized to c.</div>
</div>
<div class="line-block">
<div class="line">Equivalent to <tt class="docutils literal"><span class="pre">resize(n,</span> <span class="pre">value_type())</span></tt> when there is no parameter c.</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::length_error if <tt class="docutils literal"><span class="pre">n</span> <span class="pre">&gt;</span> <span class="pre">max_size()</span></tt>.</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="cp">#include &lt;sprout/assert.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</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">x</span><span class="p">.</span><span class="n">resize</span><span class="p">(</span><span class="mi">4</span><span class="p">);</span>
<span class="n">SPROUT_ASSERT_MSG</span><span class="p">(</span><span class="n">x</span><span class="p">.</span><span class="n">size</span><span class="p">()</span> <span class="o">==</span> <span class="mi">4</span> <span class="o">&amp;&amp;</span> <span class="n">x</span> <span class="o">==</span> <span class="s">&quot;homu&quot;</span><span class="p">,</span> <span class="s">&quot;string is resized to 4.&quot;</span><span class="p">);</span>
</pre></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="clear.html" title="clear"
>next</a> |</li>
<li class="right" >
<a href="max_size.html" title="max_size"
>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>

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="basic_string" href="index.html" />
<link rel="next" title="max_size" href="max_size.html" />
<link rel="next" title="length" href="length.html" />
<link rel="prev" title="crend" href="crend.html" />
</head>
<body>
@ -49,7 +49,7 @@
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="max_size.html" title="max_size"
<a href="length.html" title="length"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="crend.html" title="crend"
@ -78,8 +78,8 @@
<p class="topless"><a href="crend.html"
title="previous chapter">crend</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="max_size.html"
title="next chapter">max_size</a></p>
<p class="topless"><a href="length.html"
title="next chapter">length</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/size.txt"
@ -158,7 +158,7 @@
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="max_size.html" title="max_size"
<a href="length.html" title="length"
>next</a> |</li>
<li class="right" >
<a href="crend.html" title="crend"

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="back" href="data.html" />
<link rel="prev" title="back" href="back.html" />
<link rel="prev" title="assign" href="assign.html" />
</head>
<body>
<div class="related">
@ -52,7 +52,7 @@
<a href="data.html" title="back"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="back.html" title="back"
<a href="assign.html" title="assign"
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>
@ -76,8 +76,8 @@
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="back.html"
title="previous chapter">back</a></p>
<p class="topless"><a href="assign.html"
title="previous chapter">assign</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="data.html"
title="next chapter">back</a></p>
@ -171,7 +171,7 @@
<a href="data.html" title="back"
>next</a> |</li>
<li class="right" >
<a href="back.html" title="back"
<a href="assign.html" title="assign"
>previous</a> |</li>
<li><a href="../../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Libraries</a> &raquo;</li>

File diff suppressed because one or more lines are too long

View file

@ -16,7 +16,9 @@ Interface
Effects
========================================
| ``std::copy(rhs.begin(), rhs.end(), begin())``, ``std::move(rhs.begin(), rhs.end(), begin())``.
| ``std::copy(rhs.begin(), rhs.end(), begin())``.
| or
| ``std::move(rhs.begin(), rhs.end(), begin())``.
Returns
========================================
@ -28,10 +30,13 @@ Examples
.. sourcecode:: c++
#include <sprout/array.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
auto x = array<int, 10>{{1, 2, 3, 4, 5, 6, 7, 8, 9, 10}};
x = array<int, 10>{{10, 9, 8, 7, 6, 5, 4, 3, 2, 1}};
SPROUT_STATIC_CONSTEXPR auto y = array<int, 10>{{10, 9, 8, 7, 6, 5, 4, 3, 2, 1}};
x = y;
SPROUT_ASSERT_MSG(x == y, "y is assigned to x.");
Header
========================================

View file

@ -0,0 +1,158 @@
.. _sprout-string-basic_string-assign:
###############################################################################
assign
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<std::size_t N2>
basic_string& assign(basic_string<T, N2, Traits> const& str);
Effects
========================================
| Equivalent to ``assign(str, 0, npos)``.
Returns
========================================
| ``*this``.
----
Interface
========================================
.. sourcecode:: c++
template<std::size_t N2>
basic_string& assign(basic_string<T, N2, Traits> const& str, size_type pos, size_type n);
Requires
========================================
| ``pos <= str.size()``.
Effects
========================================
| Determines the effective length rlen of the string to assign as the smaller of n and ``str.size() - pos`` and calls ``assign(str.data() + pos, rlen)``.
Returns
========================================
| ``*this``.
Throws
========================================
| std::out_of_range if ``pos > str.size()``.
----
Interface
========================================
.. sourcecode:: c++
basic_string& assign(value_type const* s, size_type n);
Requires
========================================
| s points to an array of at least n elements of value_type.
Effects
========================================
| Replaces the string controlled by *this with a string of length n whose elements are a copy of those pointed to by s.
Returns
========================================
| ``*this``.
Throws
========================================
| std::length_error if ``n > max_size()``.
----
Interface
========================================
.. sourcecode:: c++
basic_string& assign(value_type const* s);
Requires
========================================
| s points to an array of at least ``traits_type::length(s) + 1`` elements of value_type.
Effects
========================================
| Calls ``assign(s, traits_type::length(s))``.
Returns
========================================
| ``*this``.
----
Interface
========================================
.. sourcecode:: c++
basic_string& assign(size_type n, value_type c);
Effects
========================================
| Equivalent to ``assign(basic_string(n, c))``.
Returns
========================================
| ``*this``.
----
Interface
========================================
.. sourcecode:: c++
template<typename InputIterator>
basic_string& assign(InputIterator first, InputIterator last);
Effects
========================================
| Equivalent to ``assign(basic_string(first, last))``.
Returns
========================================
| ``*this``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
auto x = string<8>("homuhomu");
SPROUT_STATIC_CONSTEXPR auto y = string<8>("madocchi");
x.assign(y);
SPROUT_ASSERT_MSG(x == y, "y is assigned to x.");
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

View file

@ -0,0 +1,34 @@
.. _sprout-string-basic_string-clear:
###############################################################################
clear
###############################################################################
Interface
========================================
.. sourcecode:: c++
void clear() SPROUT_NOEXCEPT;
Effects
========================================
| Fill [begin,end) with value_type(), and set the 0 to length.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
auto x = string<8>("homuhomu");
x.clear();
SPROUT_ASSERT_MSG(x.size() == 0 && x == "", "string is cleared.");
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

View file

@ -282,7 +282,7 @@ Interface of all
SPROUT_CONSTEXPR size_type max_size() const SPROUT_NOEXCEPT;
void resize(size_type n, value_type c);
void resize(size_type n);
void clear();
void clear() SPROUT_NOEXCEPT;
SPROUT_CONSTEXPR bool empty() const SPROUT_NOEXCEPT;
// element access:

View file

@ -0,0 +1,37 @@
.. _sprout-string-basic_string-length:
###############################################################################
length
###############################################################################
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR size_type length() const SPROUT_NOEXCEPT;
Returns
========================================
| The number of elements contained in the string.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto input = string<8>("homuhomu");
static_assert(input.length() == 8, "input size is 8.");
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

View file

@ -0,0 +1,50 @@
.. _sprout-string-basic_string-resize:
###############################################################################
resize
###############################################################################
Interface
========================================
.. sourcecode:: c++
void resize(size_type n, value_type c);
void resize(size_type n);
Requires
========================================
| ``n <= max_size()``.
Effects
========================================
| Alters the length of the string designated by *this as follows:
* If ``n <= size()``, the function replaces the string designated by ``*this`` with a string of length n whose elements are a copy of the initial elements of the original string designated by ``*this``.
* If ``n > size()``, the function replaces the string designated by ``*this`` with a string of length n whose first size() elements are a copy of the original string designated by ``*this``, and whose remaining elements are all initialized to c.
| Equivalent to ``resize(n, value_type())`` when there is no parameter c.
Throws
========================================
| std::length_error if ``n > max_size()``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
auto x = string<8>("homuhomu");
x.resize(4);
SPROUT_ASSERT_MSG(x.size() == 4 && x == "homu", "string is resized to 4.");
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``