stdex/structstdex_1_1mapping.html

321 lines
16 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::mapping&lt; T &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">stdex
</div>
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>stdex</b></li><li class="navelem"><a class="el" href="structstdex_1_1mapping.html">mapping</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structstdex_1_1mapping-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::mapping&lt; T &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Maps index in source string to index in destination string.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="mapping_8hpp_source.html">stdex/mapping.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9634b5ef182398e24b61c2ca78cc8e46" id="r_a9634b5ef182398e24b61c2ca78cc8e46"><td class="memItemLeft" align="right" valign="top"><a id="a9634b5ef182398e24b61c2ca78cc8e46" name="a9634b5ef182398e24b61c2ca78cc8e46"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>mapping</b> ()</td></tr>
<tr class="memdesc:a9634b5ef182398e24b61c2ca78cc8e46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a zero to zero mapping. <br /></td></tr>
<tr class="separator:a9634b5ef182398e24b61c2ca78cc8e46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48069d4eb38c276e856d650075f6c3bd" id="r_a48069d4eb38c276e856d650075f6c3bd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a48069d4eb38c276e856d650075f6c3bd">mapping</a> (T x)</td></tr>
<tr class="memdesc:a48069d4eb38c276e856d650075f6c3bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an id mapping. <br /></td></tr>
<tr class="separator:a48069d4eb38c276e856d650075f6c3bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae72436dbc2b54e2062822cd7772de830" id="r_ae72436dbc2b54e2062822cd7772de830"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae72436dbc2b54e2062822cd7772de830">mapping</a> (T _from, T _to)</td></tr>
<tr class="memdesc:ae72436dbc2b54e2062822cd7772de830"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a mapping. <br /></td></tr>
<tr class="separator:ae72436dbc2b54e2062822cd7772de830"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d9fa746849e2ea27f53e40b8b44fb46" id="r_a6d9fa746849e2ea27f53e40b8b44fb46"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6d9fa746849e2ea27f53e40b8b44fb46">operator==</a> (const <a class="el" href="structstdex_1_1mapping.html">mapping</a> &amp;other) const</td></tr>
<tr class="memdesc:a6d9fa746849e2ea27f53e40b8b44fb46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Are mappings identical? <br /></td></tr>
<tr class="separator:a6d9fa746849e2ea27f53e40b8b44fb46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99e44b5840a155e5ce366d440cbe234b" id="r_a99e44b5840a155e5ce366d440cbe234b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a99e44b5840a155e5ce366d440cbe234b">operator!=</a> (const <a class="el" href="structstdex_1_1mapping.html">mapping</a> &amp;other) const</td></tr>
<tr class="memdesc:a99e44b5840a155e5ce366d440cbe234b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Are mappings different? <br /></td></tr>
<tr class="separator:a99e44b5840a155e5ce366d440cbe234b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae8f3e1dfb76f608f4be0e12999ed37e" id="r_aae8f3e1dfb76f608f4be0e12999ed37e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structstdex_1_1mapping.html">mapping</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aae8f3e1dfb76f608f4be0e12999ed37e">operator+</a> (const <a class="el" href="structstdex_1_1mapping.html">mapping</a> &amp;other) const</td></tr>
<tr class="memdesc:aae8f3e1dfb76f608f4be0e12999ed37e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds two mappings by components. <br /></td></tr>
<tr class="separator:aae8f3e1dfb76f608f4be0e12999ed37e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a81c9969ed6798ad6cd9658302418bc2e" id="r_a81c9969ed6798ad6cd9658302418bc2e"><td class="memItemLeft" align="right" valign="top"><a id="a81c9969ed6798ad6cd9658302418bc2e" name="a81c9969ed6798ad6cd9658302418bc2e"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>from</b></td></tr>
<tr class="separator:a81c9969ed6798ad6cd9658302418bc2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad983c0053596c16c9c4fd6e50f04aedd" id="r_ad983c0053596c16c9c4fd6e50f04aedd"><td class="memItemLeft" align="right" valign="top"><a id="ad983c0053596c16c9c4fd6e50f04aedd" name="ad983c0053596c16c9c4fd6e50f04aedd"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>to</b></td></tr>
<tr class="separator:ad983c0053596c16c9c4fd6e50f04aedd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class T&gt;<br />
struct stdex::mapping&lt; T &gt;</div><p>Maps index in source string to index in destination string. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a48069d4eb38c276e856d650075f6c3bd" name="a48069d4eb38c276e856d650075f6c3bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48069d4eb38c276e856d650075f6c3bd">&#9670;&#160;</a></span>mapping() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structstdex_1_1mapping.html">stdex::mapping</a>&lt; T &gt;::mapping </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an id mapping. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>Mapping from and to value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae72436dbc2b54e2062822cd7772de830" name="ae72436dbc2b54e2062822cd7772de830"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae72436dbc2b54e2062822cd7772de830">&#9670;&#160;</a></span>mapping() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structstdex_1_1mapping.html">stdex::mapping</a>&lt; T &gt;::mapping </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>_from</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>_to</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a mapping. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_from</td><td>Mapping from value </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_to</td><td>Mapping to value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a99e44b5840a155e5ce366d440cbe234b" name="a99e44b5840a155e5ce366d440cbe234b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99e44b5840a155e5ce366d440cbe234b">&#9670;&#160;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structstdex_1_1mapping.html">stdex::mapping</a>&lt; T &gt;::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structstdex_1_1mapping.html">mapping</a>&lt; T &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Are mappings different? </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>Other mapping to compare against</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if mappings are different or false otherwise </dd></dl>
</div>
</div>
<a id="aae8f3e1dfb76f608f4be0e12999ed37e" name="aae8f3e1dfb76f608f4be0e12999ed37e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae8f3e1dfb76f608f4be0e12999ed37e">&#9670;&#160;</a></span>operator+()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structstdex_1_1mapping.html">mapping</a> <a class="el" href="structstdex_1_1mapping.html">stdex::mapping</a>&lt; T &gt;::operator+ </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structstdex_1_1mapping.html">mapping</a>&lt; T &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds two mappings by components. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>Second mapping</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Resulting mapping </dd></dl>
</div>
</div>
<a id="a6d9fa746849e2ea27f53e40b8b44fb46" name="a6d9fa746849e2ea27f53e40b8b44fb46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d9fa746849e2ea27f53e40b8b44fb46">&#9670;&#160;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structstdex_1_1mapping.html">stdex::mapping</a>&lt; T &gt;::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structstdex_1_1mapping.html">mapping</a>&lt; T &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Are mappings identical? </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>Other mapping to compare against</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if mappings are identical or false otherwise </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/stdex/<a class="el" href="mapping_8hpp_source.html">mapping.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 15 2024 17:46:18 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>