backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-03-22 12:52:48 +08:00
Code Issues Projects Releases Wiki Activity
Files
20cd9a9c6da47f8e11712df61ba0dc9cbec7604f
C-Plus-Plus/d0/d6f/namespaceothers.html
github-actions 27c0a2f2f9 Documentation for 8a368240e2
2024-08-30 17:22:07 +00:00

227 lines
12 KiB
HTML
Raw Blame History

<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C++: others Namespace 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>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.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">Algorithms_in_C++<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">Set of algorithms implemented in C++.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @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',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('d0/d6f/namespaceothers.html','../../'); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">others Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<p>for <code>vector</code>
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa17dc6d061dff34f6b9a610bc5e26703" id="r_aa17dc6d061dff34f6b9a610bc5e26703"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa17dc6d061dff34f6b9a610bc5e26703">are_almost_equal</a> (double a, double b, double absolute_tolerance=0.0001)</td></tr>
<tr class="memdesc:aa17dc6d061dff34f6b9a610bc5e26703"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../de/d4a/class_compare.html" title="Comparator class for priority queue.">Compare</a> two floating point numbers with a certain tolerance. This is needed as with some values, the result (e.g.: -196.15) might be a bit lower (in this case, -196.499999...). <br /></td></tr>
<tr class="separator:aa17dc6d061dff34f6b9a610bc5e26703"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48677fae5d683070432b1a905722d9ec" id="r_a48677fae5d683070432b1a905722d9ec"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a48677fae5d683070432b1a905722d9ec">kelvin_to_celsius</a> (double temperature_in_k)</td></tr>
<tr class="memdesc:a48677fae5d683070432b1a905722d9ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conversion from Kelvin to Celsius algorithm. <br /></td></tr>
<tr class="separator:a48677fae5d683070432b1a905722d9ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>for <code>vector</code> </p>
<p>for vector</p>
<p>Other algorithms.</p>
<p>for <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/unordered_map.html">std::unordered_map</a></p>
<p>for IO operations</p>
<p>for <code>reverse</code> for <code>assert</code> for I/O operations for <code>stack</code></p>
<p>Other algorithms</p>
<p>for assert for std::abs</p>
<p>Other algorithms</p>
<p>for assert for IO Operations for <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/list.html">std::list</a></p>
<p>Other algorithms</p>
<p>for assert for I/O operations</p>
<p>Other algorithms </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aa17dc6d061dff34f6b9a610bc5e26703" name="aa17dc6d061dff34f6b9a610bc5e26703"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa17dc6d061dff34f6b9a610bc5e26703">&#9670;&#160;</a></span>are_almost_equal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool others::are_almost_equal </td>
<td>(</td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>b</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>absolute_tolerance</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0.0001</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="../../de/d4a/class_compare.html" title="Comparator class for priority queue.">Compare</a> two floating point numbers with a certain tolerance. This is needed as with some values, the result (e.g.: -196.15) might be a bit lower (in this case, -196.499999...). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>the first number to compare </td></tr>
<tr><td class="paramname">b</td><td>the second number to compare </td></tr>
<tr><td class="paramname">tolerance</td><td>the tolerance to use when comparing the numbers </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the numbers ARE equal within the given tolerance </dd>
<dd>
false if the numbers are NOT equal within the given tolerance otherwise </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 40</span> {</div>
<div class="line"><span class="lineno"> 41</span> <span class="keywordflow">return</span> std::abs(a - b) &lt; absolute_tolerance;</div>
<div class="line"><span class="lineno"> 42</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a48677fae5d683070432b1a905722d9ec" name="a48677fae5d683070432b1a905722d9ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48677fae5d683070432b1a905722d9ec">&#9670;&#160;</a></span>kelvin_to_celsius()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double others::kelvin_to_celsius </td>
<td>(</td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>temperature_in_k</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Conversion from Kelvin to Celsius algorithm. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">number</td><td>the Celsius number that will be used to convert </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the Kelvin number converted to Celsius </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 49</span> {</div>
<div class="line"><span class="lineno"> 50</span> <span class="keyword">const</span> <span class="keywordtype">double</span> absolute_zero_in_c = -273.15;</div>
<div class="line"><span class="lineno"> 51</span> <span class="keywordflow">if</span> (temperature_in_k &lt; absolute_zero_in_c) {</div>
<div class="line"><span class="lineno"> 52</span> <span class="keywordflow">throw</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/error/invalid_argument.html">std::invalid_argument</a>(<span class="stringliteral">&quot;input temperature below absolute zero&quot;</span>);</div>
<div class="line"><span class="lineno"> 53</span> }</div>
<div class="line"><span class="lineno"> 54</span> <span class="keywordflow">return</span> temperature_in_k + absolute_zero_in_c;</div>
<div class="line"><span class="lineno"> 55</span>}</div>
<div class="ttc" id="ainvalid_argument_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/error/invalid_argument.html">std::invalid_argument</a></div></div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../d0/d6f/namespaceothers.html">others</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink