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

add doc: basic_astring operator=

Browse source
This commit is contained in:
Bolero-MURAKAMI 2013-09-08 19:28:17 +09:00
parent 5af5e8c300
commit 5f453b10f6
9 changed files with 385 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/_sources/libs/string/basic_string/assign.txt
View file

@ -20,6 +20,19 @@ 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.");
----
Interface
@ -137,19 +150,6 @@ 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
========================================

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

@ -0,0 +1,63 @@
.. _sprout-string-basic_string-operator-assign:
###############################################################################
operator=
###############################################################################
Interface
========================================
.. sourcecode:: c++
basic_string& operator=(basic_string const& rhs);
template<std::size_t N2, typename Enable = typename std::enable_if<(N2 != N)>::type>
basic_string& operator=(basic_string<T, N2, Traits> const& rhs);
basic_string& operator=(value_type const* rhs);
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;
SPROUT_ASSERT_MSG(x == y, "y is assigned to x.");
----
Interface
========================================
.. sourcecode:: c++
basic_string& operator=(value_type rhs);
Effects
========================================
| Equivalent to ``assign(1, rhs)``.
Returns
========================================
| ``*this``.
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``

28
docs/libs/string/basic_string/assign.html
View file

@ -68,6 +68,7 @@
<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="#examples">Examples</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>
@ -88,7 +89,6 @@
<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>
@ -147,6 +147,19 @@
<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>
<hr class="docutils" />
<div class="section" id="id1">
<h2>Interface<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
@ -274,19 +287,6 @@
<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">

10
docs/libs/string/basic_string/begin.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="end" href="end.html" />
<link rel="prev" title="basic_string" href="index.html" />
<link rel="prev" title="operator=" href="operator-assign.html" />
</head>
<body>
<div class="related">
@ -52,7 +52,7 @@
<a href="end.html" title="end"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="basic_string"
<a href="operator-assign.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>
@ -75,8 +75,8 @@
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">basic_string</a></p>
<p class="topless"><a href="operator-assign.html"
title="previous chapter">operator=</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="end.html"
title="next chapter">end</a></p>
@ -163,7 +163,7 @@
<a href="end.html" title="end"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="basic_string"
<a href="operator-assign.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>

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

@ -38,7 +38,7 @@
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="top" title="Sprout 1.0 documentation" href="../../../index.html" />
<link rel="up" title="Sprout.String" href="../index.html" />
<link rel="next" title="begin" href="begin.html" />
<link rel="next" title="operator=" href="operator-assign.html" />
<link rel="prev" title="assign" href="../char_traits/assign-iterator.html" />
</head>
<body>
@ -49,7 +49,7 @@
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="begin.html" title="begin"
<a href="operator-assign.html" title="operator="
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../char_traits/assign-iterator.html" title="assign"
@ -92,8 +92,8 @@
<p class="topless"><a href="../char_traits/assign-iterator.html"
title="previous chapter">assign</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="begin.html"
title="next chapter">begin</a></p>
<p class="topless"><a href="operator-assign.html"
title="next chapter">operator=</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/index.txt"
@ -220,7 +220,7 @@ convertible to pointer</td>
<tr class="row-even"><td><tt class="xref doc docutils literal"><span class="pre">(constructor)</span></tt></td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><tt class="xref doc docutils literal"><span class="pre">operator=</span></tt></td>
<tr class="row-odd"><td><a class="reference internal" href="operator-assign.html"><em>operator=</em></a></td>
<td>&nbsp;</td>
</tr>
</tbody>
@ -698,7 +698,7 @@ convertible to pointer</td>
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="begin.html" title="begin"
<a href="operator-assign.html" title="operator="
>next</a> |</li>
<li class="right" >
<a href="../char_traits/assign-iterator.html" title="assign"

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

@ -0,0 +1,207 @@
<!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="begin" href="begin.html" />
<link rel="prev" title="basic_string" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="begin.html" title="begin"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="basic_string"
accesskey="P">previous</a> |</li>
<li><a href="../../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Libraries</a> &raquo;</li>
<li><a href="../index.html" >Sprout.String</a> &raquo;</li>
<li><a href="index.html" accesskey="U">basic_string</a> &raquo;</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">operator=</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="#examples">Examples</a></li>
<li><a class="reference internal" href="#id1">Interface</a></li>
<li><a class="reference internal" href="#id2">Effects</a></li>
<li><a class="reference internal" href="#id3">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="index.html"
title="previous chapter">basic_string</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="begin.html"
title="next chapter">begin</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/operator-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="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="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">basic_string</span> <span class="k">const</span><span class="o">&amp;</span> <span class="n">rhs</span><span class="p">);</span>
<span class="k">template</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">N2</span><span class="p">,</span> <span class="k">typename</span> <span class="n">Enable</span> <span class="o">=</span> <span class="k">typename</span> <span class="n">std</span><span class="o">::</span><span class="n">enable_if</span><span class="o">&lt;</span><span class="p">(</span><span class="n">N2</span> <span class="o">!=</span> <span class="n">N</span><span class="p">)</span><span class="o">&gt;::</span><span class="n">type</span><span class="o">&gt;</span>
<span class="n">basic_string</span><span class="o">&amp;</span> <span class="k">operator</span><span class="o">=</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">rhs</span><span class="p">);</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">value_type</span> <span class="k">const</span><span class="o">*</span> <span class="n">rhs</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(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">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="id1">
<h2>Interface<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="n">basic_string</span><span class="o">&amp;</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span><span class="n">value_type</span> <span class="n">rhs</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id2">
<h2>Effects<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Equivalent to <tt class="docutils literal"><span class="pre">assign(1,</span> <span class="pre">rhs)</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="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="begin.html" title="begin"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="basic_string"
>previous</a> |</li>
<li><a href="../../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Libraries</a> &raquo;</li>
<li><a href="../index.html" >Sprout.String</a> &raquo;</li>
<li><a href="index.html" >basic_string</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013, Bolero MURAKAMI.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>

2
docs/searchindex.js
View file

File diff suppressed because one or more lines are too long

26
source/libs/string/basic_string/assign.rst
View file

@ -20,6 +20,19 @@ 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.");
----
Interface
@ -137,19 +150,6 @@ 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
========================================

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

@ -0,0 +1,63 @@
.. _sprout-string-basic_string-operator-assign:
###############################################################################
operator=
###############################################################################
Interface
========================================
.. sourcecode:: c++
basic_string& operator=(basic_string const& rhs);
template<std::size_t N2, typename Enable = typename std::enable_if<(N2 != N)>::type>
basic_string& operator=(basic_string<T, N2, Traits> const& rhs);
basic_string& operator=(value_type const* rhs);
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;
SPROUT_ASSERT_MSG(x == y, "y is assigned to x.");
----
Interface
========================================
.. sourcecode:: c++
basic_string& operator=(value_type rhs);
Effects
========================================
| Equivalent to ``assign(1, rhs)``.
Returns
========================================
| ``*this``.
Header
========================================
| ``sprout/string/string.hpp``
| Convenience header: ``sprout/string.hpp``