backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-03-21 20:31:43 +08:00
Code Issues Projects Releases Wiki Activity
Files
14583a2f33720eba2e2786d75e8e2312b85fa667
C-Plus-Plus/da/dd3/namespacespirograph.html
realstealthninja 14583a2f33 Documentation for c26eea874d
2025-05-19 11:38:33 +00:00

283 lines
16 KiB
HTML
Raw Blame History

<!-- 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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TheAlgorithms/C++: spirograph Namespace 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="../../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/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.13.2 -->
<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('da/dd3/namespacespirograph.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">spirograph Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<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:aeca22dbe4563358960e907a40cd3e1ac" id="r_aeca22dbe4563358960e907a40cd3e1ac"><td class="memTemplParams" colspan="2">template&lt;std::size_t N&gt; </td></tr>
<tr class="memitem:aeca22dbe4563358960e907a40cd3e1ac"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aeca22dbe4563358960e907a40cd3e1ac">spirograph</a> (std::array&lt; std::pair&lt; double, double &gt;, N &gt; *points, double l, double k, double rot)</td></tr>
<tr class="separator:aeca22dbe4563358960e907a40cd3e1ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e83a64e8443fff1e5ffdc1c299c1e99" id="r_a8e83a64e8443fff1e5ffdc1c299c1e99"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8e83a64e8443fff1e5ffdc1c299c1e99">test</a> ()</td></tr>
<tr class="memdesc:a8e83a64e8443fff1e5ffdc1c299c1e99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test function to save resulting points to a CSV file. <br /></td></tr>
<tr class="separator:a8e83a64e8443fff1e5ffdc1c299c1e99"><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>Functions related to <a class="el" href="../../da/d77/spirograph_8cpp.html" title="Implementation of Spirograph">spirograph.cpp</a> </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aeca22dbe4563358960e907a40cd3e1ac" name="aeca22dbe4563358960e907a40cd3e1ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeca22dbe4563358960e907a40cd3e1ac">&#9670;&#160;</a></span>spirograph()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;std::size_t N&gt; </div>
<table class="memname">
<tr>
<td class="memname">void spirograph::spirograph </td>
<td>(</td>
<td class="paramtype">std::array&lt; std::pair&lt; double, double &gt;, N &gt; *</td> <td class="paramname"><span class="paramname"><em>points</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>l</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>k</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>rot</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate spirograph curve into arrays <code>x</code> and <code>y</code> such that the i^th point in 2D is represented by <code>(x[i],y[i])</code>. The generating function is given by: </p><p class="formulaDsp">
\begin{eqnarray*}x &amp;=&amp; R\left[ (1-k) \cos (t) + l\cdot k\cdot\cos \left(\frac{1-k}{k}t\right)
\right]\\
y &amp;=&amp; R\left[ (1-k) \sin (t) - l\cdot k\cdot\sin \left(\frac{1-k}{k}t\right)
\right] \end{eqnarray*}
</p>
<p> where</p><ul>
<li>\(R\) is the scaling parameter that we will consider \(=1\)</li>
<li>\(l=\frac{\rho}{r}\) is the relative distance of marker from the centre of inner circle and \(0\le l\le1\)</li>
<li>\(\rho\) is physical distance of marker from centre of inner circle</li>
<li>\(r\) is the radius of inner circle</li>
<li>\(k=\frac{r}{R}\) is the ratio of radius of inner circle to outer circle and \(0&lt;k&lt;1\)</li>
<li>\(R\) is the radius of outer circle</li>
<li>\(t\) is the angle of rotation of the point i.e., represents the time parameter</li>
</ul>
<p>Since we are considering ratios, the actual values of \(r\) and \(R\) are immaterial.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">N</td><td>number of points = size of array </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">points</td><td>Array of 2D points represented as std::pair </td></tr>
<tr><td class="paramdir"></td><td class="paramname">l</td><td>the relative distance of marker from the centre of inner circle and \(0\le l\le1\) </td></tr>
<tr><td class="paramdir"></td><td class="paramname">k</td><td>the ratio of radius of inner circle to outer circle and \(0&lt;k&lt;1\) </td></tr>
<tr><td class="paramdir"></td><td class="paramname">rot</td><td>the number of rotations to perform (can be fractional value) </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../da/d77/spirograph_8cpp_source.html#l00070">70</a> of file <a class="el" href="../../da/d77/spirograph_8cpp_source.html">spirograph.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 71</span> {</div>
<div class="line"><span class="lineno"> 72</span> <span class="keywordtype">double</span> dt = rot * 2.f * M_PI / N;</div>
<div class="line"><span class="lineno"> 73</span> <span class="keywordtype">double</span> R = 1.f;</div>
<div class="line"><span class="lineno"> 74</span> <span class="keyword">const</span> <span class="keywordtype">double</span> k1 = 1.f - k;</div>
<div class="line"><span class="lineno"> 75</span> int32_t step = 0;</div>
<div class="line"><span class="lineno"> 76</span> </div>
<div class="line"><span class="lineno"> 77</span><span class="preprocessor">#ifdef _OPENMP</span></div>
<div class="line"><span class="lineno"> 78</span><span class="preprocessor">#pragma omp for</span></div>
<div class="line"><span class="lineno"> 79</span><span class="preprocessor">#endif</span></div>
<div class="line"><span class="lineno"> 80</span> <span class="keywordflow">for</span> (step = 0; step &lt; N; step++) {</div>
<div class="line"><span class="lineno"> 81</span> <span class="keywordtype">double</span> t = dt * step;</div>
<div class="line"><span class="lineno"> 82</span> <span class="keywordtype">double</span> first = R * (k1 * std::cos(t) + l * k * std::cos(k1 * t / k));</div>
<div class="line"><span class="lineno"> 83</span> <span class="keywordtype">double</span> second = R * (k1 * std::sin(t) - l * k * std::sin(k1 * t / k));</div>
<div class="line"><span class="lineno"> 84</span> points[0][step].first = first;</div>
<div class="line"><span class="lineno"> 85</span> points[0][step].second = second;</div>
<div class="line"><span class="lineno"> 86</span> }</div>
<div class="line"><span class="lineno"> 87</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a8e83a64e8443fff1e5ffdc1c299c1e99" name="a8e83a64e8443fff1e5ffdc1c299c1e99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e83a64e8443fff1e5ffdc1c299c1e99">&#9670;&#160;</a></span>test()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void spirograph::test </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Test function to save resulting points to a CSV file. </p>
<p class="definition">Definition at line <a class="el" href="../../da/d77/spirograph_8cpp_source.html#l00093">93</a> of file <a class="el" href="../../da/d77/spirograph_8cpp_source.html">spirograph.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 93</span> {</div>
<div class="line"><span class="lineno"> 94</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> N = 500;</div>
<div class="line"><span class="lineno"> 95</span> <span class="keywordtype">double</span> l = 0.3, k = 0.75, rot = 10.;</div>
<div class="line"><span class="lineno"> 96</span> std::stringstream fname;</div>
<div class="line"><span class="lineno"> 97</span> fname &lt;&lt; std::setw(3) &lt;&lt; <span class="stringliteral">&quot;spirograph_&quot;</span> &lt;&lt; l &lt;&lt; <span class="stringliteral">&quot;_&quot;</span> &lt;&lt; k &lt;&lt; <span class="stringliteral">&quot;_&quot;</span> &lt;&lt; rot</div>
<div class="line"><span class="lineno"> 98</span> &lt;&lt; <span class="stringliteral">&quot;.csv&quot;</span>;</div>
<div class="line"><span class="lineno"> 99</span> std::ofstream fp(fname.str());</div>
<div class="line"><span class="lineno"> 100</span> <span class="keywordflow">if</span> (!fp.is_open()) {</div>
<div class="line"><span class="lineno"> 101</span> perror(fname.str().c_str());</div>
<div class="line"><span class="lineno"> 102</span> exit(EXIT_FAILURE);</div>
<div class="line"><span class="lineno"> 103</span> }</div>
<div class="line"><span class="lineno"> 104</span> </div>
<div class="line"><span class="lineno"> 105</span> std::array&lt;std::pair&lt;double, double&gt;, N&gt; points;</div>
<div class="line"><span class="lineno"> 106</span> </div>
<div class="line"><span class="lineno"> 107</span> <a class="code hl_namespace" href="../../da/dd3/namespacespirograph.html">spirograph</a>(&amp;points, l, k, rot);</div>
<div class="line"><span class="lineno"> 108</span> </div>
<div class="line"><span class="lineno"> 109</span> <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; N; i++) {</div>
<div class="line"><span class="lineno"> 110</span> fp &lt;&lt; points[i].first &lt;&lt; <span class="stringliteral">&quot;,&quot;</span> &lt;&lt; points[i].first;</div>
<div class="line"><span class="lineno"> 111</span> <span class="keywordflow">if</span> (i &lt; N - 1) {</div>
<div class="line"><span class="lineno"> 112</span> fp &lt;&lt; <span class="charliteral">&#39;\n&#39;</span>;</div>
<div class="line"><span class="lineno"> 113</span> }</div>
<div class="line"><span class="lineno"> 114</span> }</div>
<div class="line"><span class="lineno"> 115</span> </div>
<div class="line"><span class="lineno"> 116</span> fp.close();</div>
<div class="line"><span class="lineno"> 117</span>}</div>
<div class="ttc" id="anamespacespirograph_html"><div class="ttname"><a href="../../da/dd3/namespacespirograph.html">spirograph</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="../../da/dd3/namespacespirograph.html">spirograph</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.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink