backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-03-24 13:53:35 +08:00
Code Issues Projects Releases Wiki Activity

Documentation for 8b1eab204b

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

67
da/d7b/primality__test_8cpp.html
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++: others/primality_test.cpp File Reference</title>
<title>TheAlgorithms/C++: others/primality_test.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>
@@ -118,7 +135,9 @@ Include dependency graph for primality_test.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d9/d7d/primality__test_8cpp__incl.svg" width="175" 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="../../da/d7b/primality__test_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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a2bfa6adead2bdcbf1dac94cbe08d7eaf" id="r_a2bfa6adead2bdcbf1dac94cbe08d7eaf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2bfa6adead2bdcbf1dac94cbe08d7eaf">IsPrime</a> (int number)</td></tr>
@@ -131,6 +150,8 @@ Functions</h2></td></tr>
<p>A simple and efficient implementation of a function to test if a number is prime, based on the fact that </p><blockquote class="doxtable">
<p>&zwj;Every Prime number, except 2 and 3, are of the form \(6k\pm1\) for integer values of k. This gives a 3x speed improvement. </p>
</blockquote>
<p class="definition">Definition in file <a class="el" href="../../da/d7b/primality__test_8cpp_source.html">primality_test.cpp</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a2bfa6adead2bdcbf1dac94cbe08d7eaf" name="a2bfa6adead2bdcbf1dac94cbe08d7eaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bfa6adead2bdcbf1dac94cbe08d7eaf">&#9670;&#160;</a></span>IsPrime()</h2>
@@ -153,6 +174,8 @@ Functions</h2></td></tr>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if prime else false </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../da/d7b/primality__test_8cpp_source.html#l00018">18</a> of file <a class="el" href="../../da/d7b/primality__test_8cpp_source.html">primality_test.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 18</span> {</div>
<div class="line"><span class="lineno"> 19</span> <span class="keywordflow">if</span> (((!(number &amp; 1)) &amp;&amp; number != 2) || (number &lt; 2) ||</div>
<div class="line"><span class="lineno"> 20</span> (number % 3 == 0 &amp;&amp; number != 3))</div>
@@ -164,7 +187,7 @@ Functions</h2></td></tr>
<div class="line"><span class="lineno"> 26</span> }</div>
<div class="line"><span class="lineno"> 27</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 28</span>}</div>
<div class="ttc" id="acomposite__simpson__rule_8cpp_html_a1b74d828b33760094906797042b89442"><div class="ttname"><a href="../../d4/d18/composite__simpson__rule_8cpp.html#a1b74d828b33760094906797042b89442">numerical_methods::simpson_method::k</a></div><div class="ttdeci">double k(double x)</div><div class="ttdoc">Another test function.</div><div class="ttdef"><b>Definition</b> composite_simpson_rule.cpp:117</div></div>
<div class="ttc" id="acomposite__simpson__rule_8cpp_html_a1b74d828b33760094906797042b89442"><div class="ttname"><a href="../../d4/d18/composite__simpson__rule_8cpp.html#a1b74d828b33760094906797042b89442">numerical_methods::simpson_method::k</a></div><div class="ttdeci">double k(double x)</div><div class="ttdoc">Another test function.</div><div class="ttdef"><b>Definition</b> <a href="../../d4/d18/composite__simpson__rule_8cpp_source.html#l00117">composite_simpson_rule.cpp:117</a></div></div>
</div><!-- fragment -->
</div>
</div>
@@ -183,28 +206,22 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>main function </p>
<p class="definition">Definition at line <a class="el" href="../../da/d7b/primality__test_8cpp_source.html#l00031">31</a> of file <a class="el" href="../../da/d7b/primality__test_8cpp_source.html">primality_test.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 31</span> {</div>
<div class="line"><span class="lineno"> 32</span> <span class="comment">// Main Function</span></div>
<div class="line"><span class="lineno"> 33</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;Enter the value of n to check if Prime\n&quot;</span>;</div>
<div class="line"><span class="lineno"> 33</span> std::cout &lt;&lt; <span class="stringliteral">&quot;Enter the value of n to check if Prime\n&quot;</span>;</div>
<div class="line"><span class="lineno"> 34</span> <span class="keywordtype">int</span> n;</div>
<div class="line"><span class="lineno"> 35</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_istream.html">std::cin</a> &gt;&gt; n;</div>
<div class="line"><span class="lineno"> 35</span> std::cin &gt;&gt; n;</div>
<div class="line"><span class="lineno"> 36</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="#a2bfa6adead2bdcbf1dac94cbe08d7eaf">IsPrime</a>(n))</div>
<div class="line"><span class="lineno"> 37</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; n &lt;&lt; <span class="stringliteral">&quot; is Prime&quot;</span> &lt;&lt; <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><span class="lineno"> 37</span> std::cout &lt;&lt; n &lt;&lt; <span class="stringliteral">&quot; is Prime&quot;</span> &lt;&lt; std::endl;</div>
<div class="line"><span class="lineno"> 38</span> <span class="keywordflow">else</span></div>
<div class="line"><span class="lineno"> 39</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; n &lt;&lt; <span class="stringliteral">&quot; is not Prime&quot;</span> &lt;&lt; <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><span class="lineno"> 39</span> std::cout &lt;&lt; n &lt;&lt; <span class="stringliteral">&quot; is not Prime&quot;</span> &lt;&lt; std::endl;</div>
<div class="line"><span class="lineno"> 40</span> </div>
<div class="line"><span class="lineno"> 41</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 42</span>}</div>
<div class="ttc" id="abasic_istream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_istream.html">std::cin</a></div></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="aendl_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a></div><div class="ttdeci">T endl(T... args)</div></div>
<div class="ttc" id="aprimality__test_8cpp_html_a2bfa6adead2bdcbf1dac94cbe08d7eaf"><div class="ttname"><a href="#a2bfa6adead2bdcbf1dac94cbe08d7eaf">IsPrime</a></div><div class="ttdeci">bool IsPrime(int number)</div><div class="ttdef"><b>Definition</b> primality_test.cpp:18</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="../../da/d7b/primality__test_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="180" height="86"><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="aprimality__test_8cpp_html_a2bfa6adead2bdcbf1dac94cbe08d7eaf"><div class="ttname"><a href="#a2bfa6adead2bdcbf1dac94cbe08d7eaf">IsPrime</a></div><div class="ttdeci">bool IsPrime(int number)</div><div class="ttdef"><b>Definition</b> <a href="../../da/d7b/primality__test_8cpp_source.html#l00018">primality_test.cpp:18</a></div></div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->