Google Git
Sign in
nest-open-source / nest-cam / 4320010 / boost / 62d1066a6d52d5ac4e10c106f0eab14c820be0ce / . / boost / libs / icl / doc / html / boost_icl / function_reference / construct__copy__destruct.html
blob: 8e3be031c0bfeb0ca10c0819ad010dca00253a84 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Construct, copy, destruct</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Icl">
<link rel="up" href="../function_reference.html" title="Function Reference">
<link rel="prev" href="key_types.html" title="Key Types">
<link rel="next" href="containedness.html" title="Containedness">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="key_types.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="containedness.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section boost_icl_function_reference_construct__copy__destruct" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_icl.function_reference.construct__copy__destruct"></a><a class="link" href="construct__copy__destruct.html" title="Construct, copy, destruct">Construct,
copy, destruct</a>
</h3></div></div></div>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
<span class="emphasis"><em><span class="bold"><strong>Construct, copy, destruct</strong></span></em></span>
</p>
</th>
<th>
<p>
intervals
</p>
</th>
<th>
<p>
interval<br> sets
</p>
</th>
<th>
<p>
interval<br> maps
</p>
</th>
<th>
<p>
element<br> sets
</p>
</th>
<th>
<p>
element<br> maps
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">()</span></code>
</p>
</td>
<td>
<p>
1
</p>
</td>
<td>
<p>
1
</p>
</td>
<td>
<p>
1
</p>
</td>
<td>
<p>
1
</p>
</td>
<td>
<p>
1
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">P</span><span class="special">&amp;)</span></code>
</p>
</td>
<td>
<p>
A
</p>
</td>
<td>
<p>
<a class="link" href="../interface/function_synopsis.html#element_type"><span class="bold"><strong>e</strong></span></a>
<a class="link" href="../interface/function_synopsis.html#interval_type"><span class="bold"><strong>i</strong></span></a>
<a class="link" href="../interface/function_synopsis.html#interval_set_types"><span class="bold"><strong>S</strong></span></a>
</p>
</td>
<td>
<p>
<a class="link" href="../interface/function_synopsis.html#element_mapping_type"><span class="bold"><strong>b</strong></span></a>
<a class="link" href="../interface/function_synopsis.html#interval_mapping_type"><span class="bold"><strong>p</strong></span></a>
<a class="link" href="../interface/function_synopsis.html#interval_map_types"><span class="bold"><strong>M</strong></span></a>
</p>
</td>
<td>
<p>
1
</p>
</td>
<td>
<p>
1
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span><span class="special">&amp;</span>
<span class="identifier">T</span><span class="special">::</span><span class="keyword">operator</span><span class="special">=(</span><span class="keyword">const</span> <span class="identifier">P</span><span class="special">&amp;)</span></code>
</p>
</td>
<td>
<p>
A
</p>
</td>
<td>
<p>
<a class="link" href="../interface/function_synopsis.html#interval_set_types"><span class="bold"><strong>S</strong></span></a>
</p>
</td>
<td>
<p>
<a class="link" href="../interface/function_synopsis.html#interval_map_types"><span class="bold"><strong>M</strong></span></a>
</p>
</td>
<td>
<p>
1
</p>
</td>
<td>
<p>
1
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">T</span><span class="special">::</span><span class="identifier">swap</span><span class="special">(</span><span class="identifier">T</span><span class="special">&amp;)</span></code>
</p>
</td>
<td>
<p>
</p>
</td>
<td>
<p>
1
</p>
</td>
<td>
<p>
1
</p>
</td>
<td>
<p>
1
</p>
</td>
<td>
<p>
1
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
All <span class="bold"><strong>icl</strong></span> types are <span class="emphasis"><em><span class="bold"><strong>regular
types</strong></span></em></span>. They are <span class="emphasis"><em><span class="bold"><strong>default
constructible</strong></span></em></span>, <span class="emphasis"><em><span class="bold"><strong>copy
constructible</strong></span></em></span> and <span class="emphasis"><em><span class="bold"><strong>assignable</strong></span></em></span>.
On icl Sets and Maps a <code class="computeroutput"><span class="identifier">swap</span></code>
function is available, that allows for <span class="bold"><strong>constant time</strong></span>
swapping of container contents. The <span class="emphasis"><em>regular and swappable part</em></span>
of the basic functions and their complexities are described in the tables
below.
</p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
<span class="emphasis"><em><span class="bold"><strong>Regular and swap</strong></span></em></span>
</p>
</th>
<th>
<p>
intervals
</p>
</th>
<th>
<p>
interval<br> sets
</p>
</th>
<th>
<p>
interval<br> maps
</p>
</th>
<th>
<p>
element<br> sets
</p>
</th>
<th>
<p>
element<br> maps
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">()</span></code>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span></code>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(n)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(n)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(n)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(n)</em></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span><span class="special">&amp;</span>
<span class="identifier">T</span><span class="special">::</span><span class="keyword">operator</span><span class="special">=(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span></code>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(n)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(n)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(n)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(n)</em></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">T</span><span class="special">::</span><span class="identifier">swap</span><span class="special">(</span><span class="identifier">T</span><span class="special">&amp;)</span></code>
</p>
</td>
<td>
<p>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
where <span class="emphasis"><em>n</em></span> <code class="computeroutput"><span class="special">=</span> <span class="identifier">iterative_size</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span></code>.
</p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
<span class="emphasis"><em><span class="bold"><strong>Construct, copy, destruct</strong></span></em></span>
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">()</span></code>
</p>
</td>
<td>
<p>
Object of type T is default constructed.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">src</span><span class="special">)</span></code>
</p>
</td>
<td>
<p>
Object of type T is copy constructed from object <code class="computeroutput"><span class="identifier">src</span></code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span><span class="special">&amp;</span>
<span class="identifier">T</span><span class="special">::</span><span class="keyword">operator</span><span class="special">=(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">src</span><span class="special">)</span></code>
</p>
</td>
<td>
<p>
Assigns the contents of src to <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> object. Returns a reference to
the assigned object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">T</span><span class="special">::</span><span class="identifier">swap</span><span class="special">(</span><span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">src</span><span class="special">)</span></code>
</p>
</td>
<td>
<p>
Swaps the content containers <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> and <code class="computeroutput"><span class="identifier">src</span></code>
in constant time.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
In addition we have overloads of constructors and assignment operators for
icl container types.
</p>
<pre class="programlisting"><span class="comment">// overload tables for constructors
</span><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">P</span><span class="special">&amp;</span> <span class="identifier">src</span><span class="special">)</span>
<span class="identifier">element</span> <span class="identifier">containers</span><span class="special">:</span> <span class="identifier">interval</span> <span class="identifier">containers</span><span class="special">:</span>
<span class="identifier">T</span> <span class="special">\</span> <span class="identifier">P</span> <span class="special">|</span> <span class="identifier">e</span> <span class="identifier">b</span> <span class="identifier">s</span> <span class="identifier">m</span> <span class="identifier">T</span> <span class="special">\</span> <span class="identifier">P</span> <span class="special">|</span> <span class="identifier">e</span> <span class="identifier">i</span> <span class="identifier">b</span> <span class="identifier">p</span> <span class="identifier">S</span> <span class="identifier">M</span>
<span class="special">------+--------</span> <span class="special">------+------------</span>
<span class="identifier">s</span> <span class="special">|</span> <span class="identifier">s</span> <span class="identifier">s</span> <span class="identifier">S</span> <span class="special">|</span> <span class="identifier">S</span> <span class="identifier">S</span> <span class="identifier">S</span>
<span class="identifier">m</span> <span class="special">|</span> <span class="identifier">m</span> <span class="identifier">m</span> <span class="identifier">M</span> <span class="special">|</span> <span class="identifier">M</span> <span class="identifier">M</span> <span class="identifier">M</span>
</pre>
<p>
</p>
<p>
For an object <code class="computeroutput"><span class="identifier">dst</span></code> of type
<code class="computeroutput"><span class="identifier">T</span></code> and an argument <code class="computeroutput"><span class="identifier">src</span></code> of type <code class="computeroutput"><span class="identifier">P</span></code>
let
</p>
<pre class="programlisting"><span class="identifier">n</span> <span class="special">=</span> <span class="identifier">iterative_size</span><span class="special">(</span><span class="identifier">dst</span><span class="special">);</span>
<span class="identifier">m</span> <span class="special">=</span> <span class="identifier">iterative_size</span><span class="special">(</span><span class="identifier">src</span><span class="special">);</span>
</pre>
<p>
in the following tables.
</p>
<div class="table">
<a name="id1138128"></a><p class="title"><b>Table&#160;1.17.&#160;Time Complexity for overloaded constructors on element
containers</b></p>
<div class="table-contents"><table class="table" summary="Time Complexity for overloaded constructors on element
containers">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
<code class="computeroutput"><span class="identifier">T</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">P</span><span class="special">&amp;</span> <span class="identifier">src</span><span class="special">)</span></code>
</p>
</th>
<th>
<p>
domain<br> type
</p>
</th>
<th>
<p>
domain<br> mapping<br> type
</p>
</th>
<th>
<p>
interval<br> sets
</p>
</th>
<th>
<p>
interval<br> maps
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a href="http://www.cplusplus.com/reference/stl/set/" target="_top"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code> </a>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(log n)</em></span>
</p>
</td>
<td>
<p>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(m)</em></span>
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><a class="link" href="../../boost/icl/map.html" title="Class template map">icl::map</a></code>
</p>
</td>
<td>
<p>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(log n)</em></span>
</p>
</td>
<td>
<p>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(m)</em></span>
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><p>
Time complexity characteristics of inplace insertion for interval containers
is given by this table.
</p>
<div class="table">
<a name="id1138340"></a><p class="title"><b>Table&#160;1.18.&#160;Time Complexity for overloaded constructors on interval
containers</b></p>
<div class="table-contents"><table class="table" summary="Time Complexity for overloaded constructors on interval
containers">
<colgroup>
<col>
<col>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
<code class="computeroutput"><span class="identifier">T</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">P</span><span class="special">&amp;</span> <span class="identifier">src</span><span class="special">)</span></code>
</p>
</th>
<th>
<p>
domain<br> type
</p>
</th>
<th>
<p>
interval<br> type
</p>
</th>
<th>
<p>
domain<br> mapping<br> type
</p>
</th>
<th>
<p>
interval<br> mapping<br> type
</p>
</th>
<th>
<p>
interval<br> sets
</p>
</th>
<th>
<p>
interval<br> maps
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
interval_sets
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
<td>
<p>
</p>
</td>
<td>
<p>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(m)</em></span>
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
<tr>
<td>
<p>
interval_maps
</p>
</td>
<td>
<p>
</p>
</td>
<td>
<p>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(1)</em></span>
</p>
</td>
<td>
<p>
</p>
</td>
<td>
<p>
<span class="emphasis"><em>O(m)</em></span>
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><p>
</p>
<pre class="programlisting"><span class="comment">// overload tables for assignment
</span><span class="identifier">T</span><span class="special">&amp;</span> <span class="keyword">operator</span> <span class="special">=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">P</span><span class="special">&amp;</span> <span class="identifier">src</span><span class="special">)</span>
<span class="identifier">interval</span> <span class="identifier">containers</span><span class="special">:</span>
<span class="identifier">T</span> <span class="special">\</span> <span class="identifier">P</span> <span class="special">|</span> <span class="identifier">S</span> <span class="identifier">M</span>
<span class="special">------+----</span>
<span class="identifier">S</span> <span class="special">|</span> <span class="identifier">S</span>
<span class="identifier">M</span> <span class="special">|</span> <span class="identifier">M</span>
</pre>
<p>
</p>
<p>
The assignment <code class="computeroutput"><span class="identifier">T</span><span class="special">&amp;</span>
<span class="keyword">operator</span> <span class="special">=</span>
<span class="special">(</span><span class="keyword">const</span> <span class="identifier">P</span><span class="special">&amp;</span> <span class="identifier">src</span><span class="special">)</span></code> is
overloaded within interval containers. For all type combinations we have
<span class="emphasis"><em><span class="bold"><strong>linear time complexity</strong></span></em></span>
in the maximum of the <code class="computeroutput"><span class="identifier">iterative_size</span></code>
of <code class="computeroutput"><span class="identifier">dst</span></code> and <code class="computeroutput"><span class="identifier">src</span></code>.
</p>
<p>
<span class="emphasis"><em><span class="bold"><strong>Back to section . . .</strong></span></em></span>
</p>
<div class="informaltable"><table class="table">
<colgroup><col></colgroup>
<thead><tr></tr></thead>
<tbody>
<tr><td>
<p>
<a class="link" href="../interface/function_synopsis.html#function_synopsis_table"><span class="emphasis"><em><span class="bold"><strong>Function
Synopsis</strong></span></em></span></a>
</p>
</td></tr>
<tr><td>
<p>
<a class="link" href="../interface.html" title="Interface"><span class="emphasis"><em><span class="bold"><strong>Interface</strong></span></em></span></a>
</p>
</td></tr>
</tbody>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2007 -2010 Joachim Faulhaber<br>Copyright &#169; 1999 -2006 Cortex Software GmbH<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="key_types.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="containedness.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>