King_DuckZ/Sprout
1
0
Fork 0
mirror of https://github.com/bolero-MURAKAMI/Sprout synced 2024-11-12 21:09:01 +00:00
Code Issues Releases Wiki Activity
Sprout/docs/libs/string/basic_string/assign.html
Bolero-MURAKAMI 5af5e8c300 add doc: basic_string assign
2013-09-08 18:59:50 +09:00

328 lines
No EOL
18 KiB
HTML
Raw Blame History

<!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>
Reference in a new issue View git blame Copy permalink