Documentation for 53a6c16730

This commit is contained in:
github-actions
2022-01-16 16:05:19 +00:00
parent 778f1be9e5
commit 2cab28c905
3620 changed files with 52045 additions and 41188 deletions

View File

@@ -3,7 +3,7 @@
<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.9.2"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C++: geometry::jarvis::Convexhull Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -30,8 +30,8 @@ MathJax.Hub.Config({
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<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>
@@ -41,7 +41,7 @@ MathJax.Hub.Config({
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search",'Search','.html');
@@ -98,6 +98,12 @@ $(document).ready(function(){initNavTree('d4/dde/classgeometry_1_1jarvis_1_1_con
<div class="headertitle"><div class="title">geometry::jarvis::Convexhull Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for geometry::jarvis::Convexhull:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../db/d29/classgeometry_1_1jarvis_1_1_convexhull__coll__graph.svg" width="199" height="231"><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 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
@@ -154,10 +160,10 @@ int&#160;</td><td class="memItemRight" valign="bottom"><b>size</b></td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> {</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> points = pointList;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> size = points.size();</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> }</div>
<div class="fragment"><div class="line"><span class="lineno"> 66</span> {</div>
<div class="line"><span class="lineno"> 67</span> points = pointList;</div>
<div class="line"><span class="lineno"> 68</span> size = points.size();</div>
<div class="line"><span class="lineno"> 69</span> }</div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -192,48 +198,48 @@ Here is the call graph for this function:</div>
</div><div class="memdoc">
<p >Creates convex hull of a set of n points. There must be 3 points at least for the convex hull to exist</p>
<dl class="section return"><dt>Returns</dt><dd>an vector array containing points in space which enclose all given points thus forming a hull </dd></dl>
<div class="fragment"><div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> {</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="comment">// Initialize Result</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;Point&gt;</a> hull;</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// Find the leftmost point</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">int</span> leftmost_point = 0;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 1; i &lt; size; i++) {</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keywordflow">if</span> (points[i].x &lt; points[leftmost_point].x) {</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> leftmost_point = i;</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> }</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> }</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// Start from leftmost point, keep moving counterclockwise</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="comment">// until reach the start point again. This loop runs O(h)</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="comment">// times where h is number of points in result or output.</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keywordtype">int</span> p = leftmost_point, q = 0;</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keywordflow">do</span> {</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="comment">// Add current point to result</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> hull.<a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector/push_back.html">push_back</a>(points[p]);</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="comment">// Search for a point &#39;q&#39; such that orientation(p, x, q)</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="comment">// is counterclockwise for all points &#39;x&#39;. The idea</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="comment">// is to keep track of last visited most counter clock-</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="comment">// wise point in q. If any point &#39;i&#39; is more counter clock-</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="comment">// wise than q, then update q.</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> q = (p + 1) % size;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; size; i++) {</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="comment">// If i is more counterclockwise than current q, then</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="comment">// update q</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="../../d4/dde/classgeometry_1_1jarvis_1_1_convexhull.html#a54df5f9a8f37170bd97c91127664655c">orientation</a>(points[p], points[i], points[q]) == 2) {</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> q = i;</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> }</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> }</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="comment">// Now q is the most counterclockwise with respect to p</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="comment">// Set p as q for next iteration, so that q is added to</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="comment">// result &#39;hull&#39;</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> p = q;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> } <span class="keywordflow">while</span> (p != leftmost_point); <span class="comment">// While we don&#39;t come to first point</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keywordflow">return</span> hull;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> }</div>
<div class="fragment"><div class="line"><span class="lineno"> 78</span> {</div>
<div class="line"><span class="lineno"> 79</span> <span class="comment">// Initialize Result</span></div>
<div class="line"><span class="lineno"> 80</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;Point&gt;</a> hull;</div>
<div class="line"><span class="lineno"> 81</span> </div>
<div class="line"><span class="lineno"> 82</span> <span class="comment">// Find the leftmost point</span></div>
<div class="line"><span class="lineno"> 83</span> <span class="keywordtype">int</span> leftmost_point = 0;</div>
<div class="line"><span class="lineno"> 84</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 1; i &lt; size; i++) {</div>
<div class="line"><span class="lineno"> 85</span> <span class="keywordflow">if</span> (points[i].x &lt; points[leftmost_point].x) {</div>
<div class="line"><span class="lineno"> 86</span> leftmost_point = i;</div>
<div class="line"><span class="lineno"> 87</span> }</div>
<div class="line"><span class="lineno"> 88</span> }</div>
<div class="line"><span class="lineno"> 89</span> <span class="comment">// Start from leftmost point, keep moving counterclockwise</span></div>
<div class="line"><span class="lineno"> 90</span> <span class="comment">// until reach the start point again. This loop runs O(h)</span></div>
<div class="line"><span class="lineno"> 91</span> <span class="comment">// times where h is number of points in result or output.</span></div>
<div class="line"><span class="lineno"> 92</span> <span class="keywordtype">int</span> p = leftmost_point, q = 0;</div>
<div class="line"><span class="lineno"> 93</span> <span class="keywordflow">do</span> {</div>
<div class="line"><span class="lineno"> 94</span> <span class="comment">// Add current point to result</span></div>
<div class="line"><span class="lineno"> 95</span> hull.<a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector/push_back.html">push_back</a>(points[p]);</div>
<div class="line"><span class="lineno"> 96</span> </div>
<div class="line"><span class="lineno"> 97</span> <span class="comment">// Search for a point &#39;q&#39; such that orientation(p, x, q)</span></div>
<div class="line"><span class="lineno"> 98</span> <span class="comment">// is counterclockwise for all points &#39;x&#39;. The idea</span></div>
<div class="line"><span class="lineno"> 99</span> <span class="comment">// is to keep track of last visited most counter clock-</span></div>
<div class="line"><span class="lineno"> 100</span> <span class="comment">// wise point in q. If any point &#39;i&#39; is more counter clock-</span></div>
<div class="line"><span class="lineno"> 101</span> <span class="comment">// wise than q, then update q.</span></div>
<div class="line"><span class="lineno"> 102</span> q = (p + 1) % size;</div>
<div class="line"><span class="lineno"> 103</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; size; i++) {</div>
<div class="line"><span class="lineno"> 104</span> <span class="comment">// If i is more counterclockwise than current q, then</span></div>
<div class="line"><span class="lineno"> 105</span> <span class="comment">// update q</span></div>
<div class="line"><span class="lineno"> 106</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="../../d4/dde/classgeometry_1_1jarvis_1_1_convexhull.html#a54df5f9a8f37170bd97c91127664655c">orientation</a>(points[p], points[i], points[q]) == 2) {</div>
<div class="line"><span class="lineno"> 107</span> q = i;</div>
<div class="line"><span class="lineno"> 108</span> }</div>
<div class="line"><span class="lineno"> 109</span> }</div>
<div class="line"><span class="lineno"> 110</span> </div>
<div class="line"><span class="lineno"> 111</span> <span class="comment">// Now q is the most counterclockwise with respect to p</span></div>
<div class="line"><span class="lineno"> 112</span> <span class="comment">// Set p as q for next iteration, so that q is added to</span></div>
<div class="line"><span class="lineno"> 113</span> <span class="comment">// result &#39;hull&#39;</span></div>
<div class="line"><span class="lineno"> 114</span> p = q;</div>
<div class="line"><span class="lineno"> 115</span> </div>
<div class="line"><span class="lineno"> 116</span> } <span class="keywordflow">while</span> (p != leftmost_point); <span class="comment">// While we don&#39;t come to first point</span></div>
<div class="line"><span class="lineno"> 117</span> </div>
<div class="line"><span class="lineno"> 118</span> <span class="keywordflow">return</span> hull;</div>
<div class="line"><span class="lineno"> 119</span> }</div>
<div class="ttc" id="aclassgeometry_1_1jarvis_1_1_convexhull_html_a54df5f9a8f37170bd97c91127664655c"><div class="ttname"><a href="../../d4/dde/classgeometry_1_1jarvis_1_1_convexhull.html#a54df5f9a8f37170bd97c91127664655c">geometry::jarvis::Convexhull::orientation</a></div><div class="ttdeci">static int orientation(const Point &amp;p, const Point &amp;q, const Point &amp;r)</div><div class="ttdef"><b>Definition:</b> jarvis_algorithm.cpp:133</div></div>
<div class="ttc" id="apush_back_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector/push_back.html">std::vector::push_back</a></div><div class="ttdeci">T push_back(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>
@@ -298,14 +304,14 @@ Here is the call graph for this function:</div>
1 -&gt; Clock Wise </dd>
<dd>
2 -&gt; Anti Clock Wise </dd></dl>
<div class="fragment"><div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> {</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keywordtype">int</span> val = (q.y - p.<a class="code hl_variable" href="../../d8/dc8/struct_point.html#a2e1b5fb2b2a83571f5c0bc0f66a73cf7">y</a>) * (r.x - q.x) - (q.x - p.x) * (r.<a class="code hl_variable" href="../../d8/dc8/struct_point.html#a2e1b5fb2b2a83571f5c0bc0f66a73cf7">y</a> - q.y);</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <span class="keywordflow">if</span> (val == 0) {</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> }</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="keywordflow">return</span> (val &gt; 0) ? 1 : 2;</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> }</div>
<div class="fragment"><div class="line"><span class="lineno"> 133</span> {</div>
<div class="line"><span class="lineno"> 134</span> <span class="keywordtype">int</span> val = (q.y - p.<a class="code hl_variable" href="../../d8/dc8/struct_point.html#a2e1b5fb2b2a83571f5c0bc0f66a73cf7">y</a>) * (r.x - q.x) - (q.x - p.x) * (r.<a class="code hl_variable" href="../../d8/dc8/struct_point.html#a2e1b5fb2b2a83571f5c0bc0f66a73cf7">y</a> - q.y);</div>
<div class="line"><span class="lineno"> 135</span> </div>
<div class="line"><span class="lineno"> 136</span> <span class="keywordflow">if</span> (val == 0) {</div>
<div class="line"><span class="lineno"> 137</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 138</span> }</div>
<div class="line"><span class="lineno"> 139</span> <span class="keywordflow">return</span> (val &gt; 0) ? 1 : 2;</div>
<div class="line"><span class="lineno"> 140</span> }</div>
<div class="ttc" id="astruct_point_html_a2e1b5fb2b2a83571f5c0bc0f66a73cf7"><div class="ttname"><a href="../../d8/dc8/struct_point.html#a2e1b5fb2b2a83571f5c0bc0f66a73cf7">Point::y</a></div><div class="ttdeci">int y</div><div class="ttdoc">Point respect to x coordinate.</div><div class="ttdef"><b>Definition:</b> line_segment_intersection.cpp:14</div></div>
</div><!-- fragment -->
</div>
@@ -319,7 +325,7 @@ Here is the call graph for this function:</div>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../d5/d5f/namespacegeometry.html">geometry</a></li><li class="navelem"><b>jarvis</b></li><li class="navelem"><a class="el" href="../../d4/dde/classgeometry_1_1jarvis_1_1_convexhull.html">Convexhull</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.9.2 </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.9.3 </li>
</ul>
</div>
</body>

View File

@@ -1,4 +1,4 @@
<map id="geometry::jarvis::Convexhull::Convexhull" name="geometry::jarvis::Convexhull::Convexhull">
<area shape="rect" id="node1" title=" " alt="" coords="5,5,193,47"/>
<area shape="rect" id="node2" href="/Users/runner/work/C-Plus-Plus/C-Plus-Plus/doc/cppreference-doxygen-web.tag.xml$cpp/container/vector/size.html#" title=" " alt="" coords="241,13,357,39"/>
<area shape="rect" id="node2" href="/Users/runner/work/C-Plus-Plus/C-Plus-Plus/doc/cppreference-doxygen-web.tag.xml$cpp/container/vector/size#" title=" " alt="" coords="241,13,357,39"/>
</map>

View File

@@ -1 +1 @@
04155bf1dcae306382b112c6b93afe05
1b4dcf3adb268bdb6e9b8c74957673e6

View File

@@ -22,7 +22,7 @@
<!-- Node2 -->
<g id="node2" class="node">
<title>Node2</title>
<g id="a_node2"><a target="_blank" xlink:href="http://en.cppreference.com/w/cpp/container/vector/size.html#" xlink:title=" ">
<g id="a_node2"><a target="_blank" xlink:href="http://en.cppreference.com/w/cpp/container/vector/size#" xlink:title=" ">
<polygon fill="white" stroke="black" points="177,-6 177,-25 264,-25 264,-6 177,-6"/>
<text text-anchor="middle" x="220.5" y="-13" font-family="Helvetica,sans-Serif" font-size="10.00">std::vector::size</text>
</a>

Before

Width:  |  Height:  |  Size: 1.8 KiB

After

Width:  |  Height:  |  Size: 1.8 KiB

View File

@@ -1,5 +1,5 @@
<map id="geometry::jarvis::Convexhull::getConvexHull" name="geometry::jarvis::Convexhull::getConvexHull">
<area shape="rect" id="node1" title=" " alt="" coords="5,35,193,76"/>
<area shape="rect" id="node2" href="$d4/dde/classgeometry_1_1jarvis_1_1_convexhull.html#a54df5f9a8f37170bd97c91127664655c" title=" " alt="" coords="241,5,429,47"/>
<area shape="rect" id="node3" href="/Users/runner/work/C-Plus-Plus/C-Plus-Plus/doc/cppreference-doxygen-web.tag.xml$cpp/container/vector/push_back.html#" title=" " alt="" coords="258,71,413,98"/>
<area shape="rect" id="node3" href="/Users/runner/work/C-Plus-Plus/C-Plus-Plus/doc/cppreference-doxygen-web.tag.xml$cpp/container/vector/push_back#" title=" " alt="" coords="258,71,413,98"/>
</map>

View File

@@ -1 +1 @@
9d91bb1c4ff2967093f7768c4f95c422
87e88f06bf5ba88e78d8c796ed47ad08

View File

@@ -38,7 +38,7 @@
<!-- Node3 -->
<g id="node3" class="node">
<title>Node3</title>
<g id="a_node3"><a target="_blank" xlink:href="http://en.cppreference.com/w/cpp/container/vector/push_back.html#" xlink:title=" ">
<g id="a_node3"><a target="_blank" xlink:href="http://en.cppreference.com/w/cpp/container/vector/push_back#" xlink:title=" ">
<polygon fill="white" stroke="black" points="189.5,-0.5 189.5,-19.5 305.5,-19.5 305.5,-0.5 189.5,-0.5"/>
<text text-anchor="middle" x="247.5" y="-7.5" font-family="Helvetica,sans-Serif" font-size="10.00">std::vector::push_back</text>
</a>

Before

Width:  |  Height:  |  Size: 2.7 KiB

After

Width:  |  Height:  |  Size: 2.7 KiB