mirror/Sprout
1
0
Fork 0
mirror of https://github.com/bolero-MURAKAMI/Sprout.git synced 2025-05-10 09:23:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add doc: substr

Browse source
This commit is contained in:
Bolero-MURAKAMI 2013-09-08 22:18:51 +09:00
parent 5f453b10f6
commit 8abdca1749
16 changed files with 1187 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
docs/_sources/libs/string/basic_string/assign-iterator.txt Normal file
View file

@ -0,0 +1,75 @@
.. _sprout-string-basic_string-assign-iterator:
###############################################################################
assign
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<typename StringConstIterator>
basic_string& assign(StringConstIterator 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()``.
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.begin(), 8);
SPROUT_ASSERT_MSG(x == y, "y is assigned to x.");
----
Interface
========================================
.. sourcecode:: c++
template<typename StringConstIterator>
basic_string& assign(StringConstIterator 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``.
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

46
docs/_sources/libs/string/basic_string/operator-assign-iterator.txt Normal file
View file

@ -0,0 +1,46 @@
.. _sprout-string-basic_string-operator-assign-iterator:
###############################################################################
operator=
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<typename StringConstIterator>
basic_string& operator=(StringConstIterator rhs);
Requires
========================================
| ``std::is_same<StringConstIterator, const_iterator>::value || std::is_same<StringConstIterator, iterator>::value``.
Effects
========================================
| Equivalent to ``assign(rhs)``.
Returns
========================================
| ``*this``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/array.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
auto x = string<8>("homuhomu");
SPROUT_STATIC_CONSTEXPR auto y = string<8>("madocchi");
x = y.begin();
SPROUT_ASSERT_MSG(x == y, "y is assigned to x.");
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

35
docs/_sources/libs/string/basic_string/operator-std-basic_string.txt Normal file
View file

@ -0,0 +1,35 @@
.. _sprout-string-basic_string-operator-std-basic_string:
###############################################################################
operator std::basic_string
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<typename Allocator>
SPROUT_EXPLICIT_CONVERSION operator std::basic_string<T, Traits, Allocator>() const;
Returns
========================================
| conversion to std::basic_string.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>("homuhomu");
auto y = static_cast<std::string>(x);
SPROUT_ASSERT_MASG(x == y.c_str(), "y is converted from x.");
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

44
docs/_sources/libs/string/basic_string/substr.txt Normal file
View file

@ -0,0 +1,44 @@
.. _sprout-string-basic_string-substr:
###############################################################################
substr
###############################################################################
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR basic_string substr(size_type pos = 0, size_type n = npos) const;
Requires
========================================
| ``pos <= size()``.
Returns
========================================
| ``basic_string(data() + pos, rlen)`` when rlen is the smaller of n and ``size() - pos``.
Throws
========================================
| std::out_of_range if ``pos > size()``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>("homuhomu");
SPROUT_STATIC_CONSTEXPR auto y = x.substr(4, 4);
SPROUT_ASSERT_MASG(y == "homu", "y is substring of x.");
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

225
docs/libs/string/basic_string/assign-iterator.html Normal file
View file

@ -0,0 +1,225 @@
<!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="string" href="../string.html" />
<link rel="prev" title="operator=" href="operator-assign-iterator.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="../string.html" title="string"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="operator-assign-iterator.html" title="operator="
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="#requires">Requires</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="#throws">Throws</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#id3">Interface</a></li>
<li><a class="reference internal" href="#id4">Requires</a></li>
<li><a class="reference internal" href="#id5">Effects</a></li>
<li><a class="reference internal" href="#id6">Returns</a></li>
<li><a class="reference internal" href="#header">Header</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="operator-assign-iterator.html"
title="previous chapter">operator=</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../string.html"
title="next chapter">string</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/assign-iterator.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="k">typename</span> <span class="n">StringConstIterator</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">StringConstIterator</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="requires">
<h2>Requires<a class="headerlink" href="#requires" 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="effects">
<h2>Effects<a class="headerlink" href="#effects" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Replaces the string controlled by <a href="#id1"><span class="problematic" id="id2">*</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="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>
<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">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">begin</span><span class="p">(),</span> <span class="mi">8</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>
<hr class="docutils" />
<div class="section" id="id3">
<h2>Interface<a class="headerlink" href="#id3" 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">StringConstIterator</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">StringConstIterator</span> <span class="n">s</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id4">
<h2>Requires<a class="headerlink" href="#id4" 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="id5">
<h2>Effects<a class="headerlink" href="#id5" 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="id6">
<h2>Returns<a class="headerlink" href="#id6" 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="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="../string.html" title="string"
>next</a> |</li>
<li class="right" >
<a href="operator-assign-iterator.html" title="operator="
>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>

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

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

@ -387,7 +387,7 @@ convertible to pointer</td>
<tr class="row-odd"><td><tt class="xref doc docutils literal"><span class="pre">find_last_not_of</span></tt></td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><tt class="xref doc docutils literal"><span class="pre">substr</span></tt></td>
<tr class="row-even"><td><a class="reference internal" href="substr.html"><em>substr</em></a></td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><tt class="xref doc docutils literal"><span class="pre">compare</span></tt></td>
@ -409,7 +409,7 @@ convertible to pointer</td>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><tt class="xref doc docutils literal"><span class="pre">operator</span> <span class="pre">std::basic_string</span></tt></td>
<tr class="row-even"><td><a class="reference internal" href="operator-std-basic_string.html"><em>operator std::basic_string</em></a></td>
<td>&nbsp;</td>
</tr>
</tbody>
@ -428,7 +428,7 @@ convertible to pointer</td>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><tt class="xref doc docutils literal"><span class="pre">operator=</span></tt></td>
<tr class="row-even"><td><a class="reference internal" href="operator-assign-iterator.html"><em>operator=</em></a></td>
<td>&nbsp;</td>
</tr>
</tbody>
@ -447,7 +447,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-iterator.html"><em>assign</em></a></td>
<td>&nbsp;</td>
</tr>
</tbody>

188
docs/libs/string/basic_string/operator-assign-iterator.html Normal file
View file

@ -0,0 +1,188 @@
<!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>operator= &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="assign" href="assign-iterator.html" />
<link rel="prev" title="operator std::basic_string" href="operator-std-basic_string.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="assign-iterator.html" title="assign"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="operator-std-basic_string.html" title="operator std::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="#">operator=</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="#returns">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="operator-std-basic_string.html"
title="previous chapter">operator std::basic_string</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="assign-iterator.html"
title="next chapter">assign</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/operator-assign-iterator.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="operator">
<h1>operator=<a class="headerlink" href="#operator" 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="k">typename</span> <span class="n">StringConstIterator</span><span class="o">&gt;</span>
<span class="n">basic_string</span><span class="o">&amp;</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span><span class="n">StringConstIterator</span> <span class="n">rhs</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">std::is_same&lt;StringConstIterator,</span> <span class="pre">const_iterator&gt;::value</span> <span class="pre">||</span> <span class="pre">std::is_same&lt;StringConstIterator,</span> <span class="pre">iterator&gt;::value</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">Equivalent to <tt class="docutils literal"><span class="pre">assign(rhs)</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>
<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">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="o">=</span> <span class="n">y</span><span class="p">.</span><span class="n">begin</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="assign-iterator.html" title="assign"
>next</a> |</li>
<li class="right" >
<a href="operator-std-basic_string.html" title="operator std::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>

173
docs/libs/string/basic_string/operator-std-basic_string.html Normal file
View file

@ -0,0 +1,173 @@
<!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>operator std::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-iterator.html" />
<link rel="prev" title="substr" href="substr.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-iterator.html" title="operator="
accesskey="N">next</a> |</li>
<li class="right" >
<a href="substr.html" title="substr"
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="#">operator std::basic_string</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="#header">Header</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="substr.html"
title="previous chapter">substr</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="operator-assign-iterator.html"
title="next chapter">operator=</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/operator-std-basic_string.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="operator-std-basic-string">
<h1>operator std::basic_string<a class="headerlink" href="#operator-std-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="k">template</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">Allocator</span><span class="o">&gt;</span>
<span class="n">SPROUT_EXPLICIT_CONVERSION</span> <span class="k">operator</span> <span class="n">std</span><span class="o">::</span><span class="n">basic_string</span><span class="o">&lt;</span><span class="n">T</span><span class="p">,</span> <span class="n">Traits</span><span class="p">,</span> <span class="n">Allocator</span><span class="o">&gt;</span><span class="p">()</span> <span class="k">const</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">conversion to std::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="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="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="k">auto</span> <span class="n">y</span> <span class="o">=</span> <span class="k">static_cast</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="o">&gt;</span><span class="p">(</span><span class="n">x</span><span class="p">);</span>
<span class="n">SPROUT_ASSERT_MASG</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">c_str</span><span class="p">(),</span> <span class="s">&quot;y is converted from 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="operator-assign-iterator.html" title="operator="
>next</a> |</li>
<li class="right" >
<a href="substr.html" title="substr"
>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>

186
docs/libs/string/basic_string/substr.html Normal file
View file

@ -0,0 +1,186 @@
<!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>substr &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 std::basic_string" href="operator-std-basic_string.html" />
<link rel="prev" title="back" href="data.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-std-basic_string.html" title="operator std::basic_string"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="data.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="#">substr</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="#returns">Returns</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="data.html"
title="previous chapter">back</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="operator-std-basic_string.html"
title="next chapter">operator std::basic_string</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/substr.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="substr">
<h1>substr<a class="headerlink" href="#substr" 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="n">substr</span><span class="p">(</span><span class="n">size_type</span> <span class="n">pos</span> <span class="o">=</span> <span class="mi">0</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">const</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">size()</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">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>
</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">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="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">x</span><span class="p">.</span><span class="n">substr</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span> <span class="mi">4</span><span class="p">);</span>
<span class="n">SPROUT_ASSERT_MASG</span><span class="p">(</span><span class="n">y</span> <span class="o">==</span> <span class="s">&quot;homu&quot;</span><span class="p">,</span> <span class="s">&quot;y is substring of 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="operator-std-basic_string.html" title="operator std::basic_string"
>next</a> |</li>
<li class="right" >
<a href="data.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>

10
docs/libs/string/string.html
View file

@ -39,7 +39,7 @@
<link rel="top" title="Sprout 1.0 documentation" href="../../index.html" />
<link rel="up" title="Sprout.String" href="index.html" />
<link rel="next" title="wstring" href="wstring.html" />
<link rel="prev" title="back" href="basic_string/data.html" />
<link rel="prev" title="assign" href="basic_string/assign-iterator.html" />
</head>
<body>
<div class="related">
@ -52,7 +52,7 @@
<a href="wstring.html" title="wstring"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="basic_string/data.html" title="back"
<a href="basic_string/assign-iterator.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>
@ -72,8 +72,8 @@
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="basic_string/data.html"
title="previous chapter">back</a></p>
<p class="topless"><a href="basic_string/assign-iterator.html"
title="previous chapter">assign</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="wstring.html"
title="next chapter">wstring</a></p>
@ -148,7 +148,7 @@
<a href="wstring.html" title="wstring"
>next</a> |</li>
<li class="right" >
<a href="basic_string/data.html" title="back"
<a href="basic_string/assign-iterator.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>

2
docs/searchindex.js
View file

File diff suppressed because one or more lines are too long

75
source/libs/string/basic_string/assign-iterator.rst Normal file
View file

@ -0,0 +1,75 @@
.. _sprout-string-basic_string-assign-iterator:
###############################################################################
assign
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<typename StringConstIterator>
basic_string& assign(StringConstIterator 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()``.
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.begin(), 8);
SPROUT_ASSERT_MSG(x == y, "y is assigned to x.");
----
Interface
========================================
.. sourcecode:: c++
template<typename StringConstIterator>
basic_string& assign(StringConstIterator 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``.
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

46
source/libs/string/basic_string/operator-assign-iterator.rst Normal file
View file

@ -0,0 +1,46 @@
.. _sprout-string-basic_string-operator-assign-iterator:
###############################################################################
operator=
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<typename StringConstIterator>
basic_string& operator=(StringConstIterator rhs);
Requires
========================================
| ``std::is_same<StringConstIterator, const_iterator>::value || std::is_same<StringConstIterator, iterator>::value``.
Effects
========================================
| Equivalent to ``assign(rhs)``.
Returns
========================================
| ``*this``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/array.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
auto x = string<8>("homuhomu");
SPROUT_STATIC_CONSTEXPR auto y = string<8>("madocchi");
x = y.begin();
SPROUT_ASSERT_MSG(x == y, "y is assigned to x.");
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

35
source/libs/string/basic_string/operator-std-basic_string.rst Normal file
View file

@ -0,0 +1,35 @@
.. _sprout-string-basic_string-operator-std-basic_string:
###############################################################################
operator std::basic_string
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<typename Allocator>
SPROUT_EXPLICIT_CONVERSION operator std::basic_string<T, Traits, Allocator>() const;
Returns
========================================
| conversion to std::basic_string.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>("homuhomu");
auto y = static_cast<std::string>(x);
SPROUT_ASSERT_MASG(x == y.c_str(), "y is converted from x.");
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

44
source/libs/string/basic_string/substr.rst Normal file
View file

@ -0,0 +1,44 @@
.. _sprout-string-basic_string-substr:
###############################################################################
substr
###############################################################################
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR basic_string substr(size_type pos = 0, size_type n = npos) const;
Requires
========================================
| ``pos <= size()``.
Returns
========================================
| ``basic_string(data() + pos, rlen)`` when rlen is the smaller of n and ``size() - pos``.
Throws
========================================
| std::out_of_range if ``pos > size()``.
Examples
========================================
.. sourcecode:: c++
#include <sprout/string.hpp>
#include <sprout/assert.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto x = string<8>("homuhomu");
SPROUT_STATIC_CONSTEXPR auto y = x.substr(4, 4);
SPROUT_ASSERT_MASG(y == "homu", "y is substring of x.");
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``