Files
C-Plus-Plus/dc/d1f/classcatalan__numbers.html
2025-07-09 10:53:16 +00:00

321 lines
16 KiB
HTML

<!-- HTML header for doxygen 1.12.0-->
<!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.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TheAlgorithms/C++: catalan_numbers Class Reference</title>
<link rel="icon" href="../../favicon.svg" type="image/x-icon" />
<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="https://cdn.jsdelivr.net/npm/@xpack-3rd-party/doxygen-awesome-css@2.2.0-1/doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</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="../../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/javascript">
window.MathJax = {
options: {
ignoreHtmlClass: 'tex2jax_ignore',
processHtmlClass: 'tex2jax_process'
},
loader: {
load: ['[tex]/ams']
},
tex: {
macros: {},
packages: ['base','configmacros','ams']
}
};
</script>
<script type="text/javascript" id="MathJax-script" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
<link href="../../doxygen-awesome.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="projectlogo"><img alt="Logo" src="../../project_logo.png"/></td>
<td id="projectalign">
<div id="projectname">TheAlgorithms/C++<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">All the algorithms implemented in C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</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">
$(function(){initNavTree('dc/d1f/classcatalan__numbers.html','../../','d6/dc9/classcatalan__numbers-members'); });
</script>
<div id="container">
<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="headertitle"><div class="title">catalan_numbers Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>computes and caches Catalan numbers
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for catalan_numbers:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="../../d5/d6e/classcatalan__numbers__coll__graph.svg" width="138" height="148"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="../../graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a54655c66cf89186d3d1fa90829b28ab8" id="r_a54655c66cf89186d3d1fa90829b28ab8"><td class="memItemLeft" align="right" valign="top">value_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a54655c66cf89186d3d1fa90829b28ab8">get</a> (std::size_t n)</td></tr>
<tr class="memdesc:a54655c66cf89186d3d1fa90829b28ab8"><td class="mdescLeft">&#160;</td><td class="mdescRight">computes the n-th Catalan number and updates the cache. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pri-types" class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a0bfc8c78494c93dbb4c7d67b7300cf1a" id="r_a0bfc8c78494c93dbb4c7d67b7300cf1a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0bfc8c78494c93dbb4c7d67b7300cf1a">value_type</a> = std::uint64_t</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pri-methods" class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a141beca0f50fbb4cd5ca8d53819bc43d" id="r_a141beca0f50fbb4cd5ca8d53819bc43d"><td class="memItemLeft" align="right" valign="top">value_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a141beca0f50fbb4cd5ca8d53819bc43d">compute_next</a> ()</td></tr>
<tr class="memitem:abf882dee674593be3df61a36443b5632" id="r_abf882dee674593be3df61a36443b5632"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abf882dee674593be3df61a36443b5632">add</a> ()</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pri-attribs" class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ad37c6891d102bb758d3d3d85fb7f1798" id="r_ad37c6891d102bb758d3d3d85fb7f1798"><td class="memItemLeft" align="right" valign="top">std::vector&lt; value_type &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad37c6891d102bb758d3d3d85fb7f1798">known</a> {1, 1}</td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>computes and caches Catalan numbers </p>
<p>for assert for std::uint64_t for std::size_t for std::plus &amp; std::multiplies for std::transform_reduce for std::vector </p>
<p class="definition">Definition at line <a class="el" href="../../de/dd9/catalan__numbers_8cpp_source.html#l00022">22</a> of file <a class="el" href="../../de/dd9/catalan__numbers_8cpp_source.html">catalan_numbers.cpp</a>.</p>
</div><a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Member Typedef Documentation</h2>
<a id="a0bfc8c78494c93dbb4c7d67b7300cf1a" name="a0bfc8c78494c93dbb4c7d67b7300cf1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bfc8c78494c93dbb4c7d67b7300cf1a">&#9670;&#160;</a></span>value_type</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using catalan_numbers::value_type = std::uint64_t</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../de/dd9/catalan__numbers_8cpp_source.html#l00023">23</a> of file <a class="el" href="../../de/dd9/catalan__numbers_8cpp_source.html">catalan_numbers.cpp</a>.</p>
</div>
</div>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="abf882dee674593be3df61a36443b5632" name="abf882dee674593be3df61a36443b5632"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf882dee674593be3df61a36443b5632">&#9670;&#160;</a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void catalan_numbers::add </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../de/dd9/catalan__numbers_8cpp_source.html#l00032">32</a> of file <a class="el" href="../../de/dd9/catalan__numbers_8cpp_source.html">catalan_numbers.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 32</span>{ known.push_back(this-&gt;compute_next()); }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a141beca0f50fbb4cd5ca8d53819bc43d" name="a141beca0f50fbb4cd5ca8d53819bc43d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a141beca0f50fbb4cd5ca8d53819bc43d">&#9670;&#160;</a></span>compute_next()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">value_type catalan_numbers::compute_next </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../de/dd9/catalan__numbers_8cpp_source.html#l00026">26</a> of file <a class="el" href="../../de/dd9/catalan__numbers_8cpp_source.html">catalan_numbers.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 26</span> {</div>
<div class="line"><span class="lineno"> 27</span> <span class="keywordflow">return</span> std::transform_reduce(known.begin(), known.end(), known.rbegin(),</div>
<div class="line"><span class="lineno"> 28</span> <span class="keyword">static_cast&lt;</span>value_type<span class="keyword">&gt;</span>(0), std::plus&lt;&gt;(),</div>
<div class="line"><span class="lineno"> 29</span> std::multiplies&lt;&gt;());</div>
<div class="line"><span class="lineno"> 30</span> }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a54655c66cf89186d3d1fa90829b28ab8" name="a54655c66cf89186d3d1fa90829b28ab8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54655c66cf89186d3d1fa90829b28ab8">&#9670;&#160;</a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">value_type catalan_numbers::get </td>
<td>(</td>
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>n</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>computes the n-th Catalan number and updates the cache. </p>
<dl class="section return"><dt>Returns</dt><dd>the n-th Catalan number </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../de/dd9/catalan__numbers_8cpp_source.html#l00039">39</a> of file <a class="el" href="../../de/dd9/catalan__numbers_8cpp_source.html">catalan_numbers.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 39</span> {</div>
<div class="line"><span class="lineno"> 40</span> <span class="keywordflow">while</span> (known.size() &lt;= n) {</div>
<div class="line"><span class="lineno"> 41</span> this-&gt;add();</div>
<div class="line"><span class="lineno"> 42</span> }</div>
<div class="line"><span class="lineno"> 43</span> <span class="keywordflow">return</span> known[n];</div>
<div class="line"><span class="lineno"> 44</span> }</div>
</div><!-- fragment -->
</div>
</div>
<a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Member Data Documentation</h2>
<a id="ad37c6891d102bb758d3d3d85fb7f1798" name="ad37c6891d102bb758d3d3d85fb7f1798"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad37c6891d102bb758d3d3d85fb7f1798">&#9670;&#160;</a></span>known</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;value_type&gt; catalan_numbers::known {1, 1}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../de/dd9/catalan__numbers_8cpp_source.html#l00024">24</a> of file <a class="el" href="../../de/dd9/catalan__numbers_8cpp_source.html">catalan_numbers.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 24</span>{1, 1};</div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>dynamic_programming/<a class="el" href="../../de/dd9/catalan__numbers_8cpp_source.html">catalan_numbers.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="../../dc/d1f/classcatalan__numbers.html">catalan_numbers</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.14.0 </li>
</ul>
</div>
</body>
</html>