Documentation for 8b1eab204b

This commit is contained in:
realstealthninja
2024-11-04 12:43:05 +00:00
parent 4fb6e622e9
commit a7bccf7d01
6732 changed files with 153919 additions and 365711 deletions

View File

@@ -1,3 +1,4 @@
<!-- 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>
@@ -5,10 +6,15 @@
<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++: geometry/jarvis_algorithm.cpp File Reference</title>
<title>TheAlgorithms/C++: geometry/jarvis_algorithm.cpp File 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>
@@ -18,14 +24,24 @@
<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 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" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></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! -->
@@ -33,10 +49,11 @@ MathJax.Hub.Config({
<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">Algorithms_in_C++<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">TheAlgorithms/C++<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">Set of algorithms implemented in C++.</div>
<div id="projectbrief">All the algorithms implemented in C++</div>
</td>
</tr>
</tbody>
@@ -122,7 +139,9 @@ Include dependency graph for jarvis_algorithm.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d1/d73/jarvis__algorithm_8cpp__incl.svg" width="252" height="111"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div><table class="memberdecls">
</div>
<p><a href="../../d4/d8d/jarvis__algorithm_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d5a/structgeometry_1_1jarvis_1_1_point.html">geometry::jarvis::Point</a></td></tr>
@@ -133,7 +152,7 @@ Classes</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d5f/namespacegeometry.html">geometry</a></td></tr>
<tr class="memdesc:d5/d5f/namespacegeometry"><td class="mdescLeft">&#160;</td><td class="mdescRight">for <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/algorithm/swap.html">std::swap</a> <br /></td></tr>
<tr class="memdesc:d5/d5f/namespacegeometry"><td class="mdescLeft">&#160;</td><td class="mdescRight">for std::swap <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/da7/namespacejarvis.html">jarvis</a></td></tr>
<tr class="memdesc:d5/da7/namespacejarvis"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions for <a href="https://en.wikipedia.org/wiki/Gift_wrapping_algorithm" target="_blank">Jarviss</a> algorithm. <br /></td></tr>
@@ -156,6 +175,8 @@ Algorithm</h3>
<p>For Example, If points = {{0, 3}, {2, 2}, {1, 1}, {2, 1}, {3, 0}, {0, 0}, {3, 3}};</p>
<p>then the convex hull is (0, 3), (0, 0), (3, 0), (3, 3)</p>
<dl class="section author"><dt>Author</dt><dd><a href="https://github.com/rishabh-997" target="_blank">Rishabh Agarwal</a> </dd></dl>
<p class="definition">Definition in file <a class="el" href="../../d4/d8d/jarvis__algorithm_8cpp_source.html">jarvis_algorithm.cpp</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4" name="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">&#9670;&#160;</a></span>main()</h2>
@@ -172,17 +193,14 @@ Algorithm</h3>
</table>
</div><div class="memdoc">
<p>Driver Code </p>
<p class="definition">Definition at line <a class="el" href="../../d4/d8d/jarvis__algorithm_8cpp_source.html#l00176">176</a> of file <a class="el" href="../../d4/d8d/jarvis__algorithm_8cpp_source.html">jarvis_algorithm.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 176</span> {</div>
<div class="line"><span class="lineno"> 177</span> <a class="code hl_function" href="#aa8dca7b867074164d5f45b0f3851269d">test</a>();</div>
<div class="line"><span class="lineno"> 178</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 179</span>}</div>
<div class="ttc" id="ajarvis__algorithm_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdef"><b>Definition</b> jarvis_algorithm.cpp:151</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d4/d8d/jarvis__algorithm_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="623" height="130"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<div class="ttc" id="ajarvis__algorithm_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdef"><b>Definition</b> <a href="../../d4/d8d/jarvis__algorithm_8cpp_source.html#l00151">jarvis_algorithm.cpp:151</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="aa8dca7b867074164d5f45b0f3851269d" name="aa8dca7b867074164d5f45b0f3851269d"></a>
@@ -208,8 +226,10 @@ Here is the call graph for this function:</div>
</table>
</div><div class="memdoc">
<p>Test function </p><dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/d8d/jarvis__algorithm_8cpp_source.html#l00151">151</a> of file <a class="el" href="../../d4/d8d/jarvis__algorithm_8cpp_source.html">jarvis_algorithm.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 151</span> {</div>
<div class="line"><span class="lineno"> 152</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;geometry::jarvis::Point&gt;</a> points = {{0, 3},</div>
<div class="line"><span class="lineno"> 152</span> std::vector&lt;geometry::jarvis::Point&gt; points = {{0, 3},</div>
<div class="line"><span class="lineno"> 153</span> {2, 2},</div>
<div class="line"><span class="lineno"> 154</span> {1, 1},</div>
<div class="line"><span class="lineno"> 155</span> {2, 1},</div>
@@ -218,29 +238,21 @@ Here is the call graph for this function:</div>
<div class="line"><span class="lineno"> 158</span> {3, 3}</div>
<div class="line"><span class="lineno"> 159</span> };</div>
<div class="line"><span class="lineno"> 160</span> <a class="code hl_class" href="../../d4/dde/classgeometry_1_1jarvis_1_1_convexhull.html">geometry::jarvis::Convexhull</a> hull(points);</div>
<div class="line"><span class="lineno"> 161</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;geometry::jarvis::Point&gt;</a> actualPoint;</div>
<div class="line"><span class="lineno"> 161</span> std::vector&lt;geometry::jarvis::Point&gt; actualPoint;</div>
<div class="line"><span class="lineno"> 162</span> actualPoint = hull.getConvexHull();</div>
<div class="line"><span class="lineno"> 163</span> </div>
<div class="line"><span class="lineno"> 164</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;geometry::jarvis::Point&gt;</a> expectedPoint = {{0, 3},</div>
<div class="line"><span class="lineno"> 164</span> std::vector&lt;geometry::jarvis::Point&gt; expectedPoint = {{0, 3},</div>
<div class="line"><span class="lineno"> 165</span> {0, 0},</div>
<div class="line"><span class="lineno"> 166</span> {3, 0},</div>
<div class="line"><span class="lineno"> 167</span> {3, 3}};</div>
<div class="line"><span class="lineno"> 168</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; expectedPoint.<a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector/size.html">size</a>(); i++) {</div>
<div class="line"><span class="lineno"> 168</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; expectedPoint.size(); i++) {</div>
<div class="line"><span class="lineno"> 169</span> assert(actualPoint[i].x == expectedPoint[i].x);</div>
<div class="line"><span class="lineno"> 170</span> assert(actualPoint[i].y == expectedPoint[i].y);</div>
<div class="line"><span class="lineno"> 171</span> }</div>
<div class="line"><span class="lineno"> 172</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Test implementations passed!\n&quot;</span>;</div>
<div class="line"><span class="lineno"> 172</span> std::cout &lt;&lt; <span class="stringliteral">&quot;Test implementations passed!\n&quot;</span>;</div>
<div class="line"><span class="lineno"> 173</span>}</div>
<div class="ttc" id="abasic_ostream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a></div></div>
<div class="ttc" id="aclassgeometry_1_1jarvis_1_1_convexhull_html"><div class="ttname"><a href="../../d4/dde/classgeometry_1_1jarvis_1_1_convexhull.html">geometry::jarvis::Convexhull</a></div><div class="ttdef"><b>Definition</b> jarvis_algorithm.cpp:55</div></div>
<div class="ttc" id="asize_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector/size.html">std::vector::size</a></div><div class="ttdeci">T size(T... args)</div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a></div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d4/d8d/jarvis__algorithm_8cpp_aa8dca7b867074164d5f45b0f3851269d_cgraph.svg" width="526" height="130"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<div class="ttc" id="aclassgeometry_1_1jarvis_1_1_convexhull_html"><div class="ttname"><a href="../../d4/dde/classgeometry_1_1jarvis_1_1_convexhull.html">geometry::jarvis::Convexhull</a></div><div class="ttdef"><b>Definition</b> <a href="../../d4/d8d/jarvis__algorithm_8cpp_source.html#l00055">jarvis_algorithm.cpp:55</a></div></div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->