mirror of
https://github.com/TheAlgorithms/C-Plus-Plus.git
synced 2026-03-31 09:13:16 +08:00
Documentation for b9c118fb5d
This commit is contained in:
realstealthninja
@@ -119,14 +119,13 @@ $(function(){initNavTree('df/d66/vector__cross__product_8cpp.html','../../','');
|
||||
|
||||
<p>Calculates the <a href="https://en.wikipedia.org/wiki/Cross_product" target="_blank">Cross Product</a> and the magnitude of two mathematical 3D vectors.
|
||||
<a href="#details">More...</a></p>
|
||||
<div class="textblock"><code>#include <iostream></code><br />
|
||||
<code>#include <array></code><br />
|
||||
<code>#include <cmath></code><br />
|
||||
<div class="textblock"><code>#include <array></code><br />
|
||||
<code>#include <cassert></code><br />
|
||||
<code>#include <cmath></code><br />
|
||||
</div><div class="textblock"><div class="dynheader">
|
||||
Include dependency graph for vector_cross_product.cpp:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="../../db/dc3/vector__cross__product_8cpp__incl.svg" width="327" height="111"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
||||
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="../../db/dc3/vector__cross__product_8cpp__incl.svg" width="231" 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>
|
||||
<p><a href="../../df/d66/vector__cross__product_8cpp_source.html">Go to the source code of this file.</a></p>
|
||||
@@ -145,7 +144,7 @@ Functions</h2></td></tr>
|
||||
<tr class="memitem:a4b2a9757a87c18e1642d72410ecfaba8" id="r_a4b2a9757a87c18e1642d72410ecfaba8"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b2a9757a87c18e1642d72410ecfaba8">math::vector_cross::mag</a> (const std::array< double, 3 > &vec)</td></tr>
|
||||
<tr class="memdesc:a4b2a9757a87c18e1642d72410ecfaba8"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the magnitude of the mathematical vector from it's direction ratios. <br /></td></tr>
|
||||
<tr class="memitem:aa8dca7b867074164d5f45b0f3851269d" id="r_aa8dca7b867074164d5f45b0f3851269d"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa8dca7b867074164d5f45b0f3851269d">test</a> ()</td></tr>
|
||||
<tr class="memdesc:aa8dca7b867074164d5f45b0f3851269d"><td class="mdescLeft"> </td><td class="mdescRight">namespace math <br /></td></tr>
|
||||
<tr class="memdesc:aa8dca7b867074164d5f45b0f3851269d"><td class="mdescLeft"> </td><td class="mdescRight">test function. <br /></td></tr>
|
||||
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4" id="r_ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
|
||||
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft"> </td><td class="mdescRight">Main Function. <br /></td></tr>
|
||||
</table>
|
||||
@@ -197,14 +196,14 @@ Example:</h3>
|
||||
<dl class="section return"><dt>Returns</dt><dd>the direction ratios of the cross product. </dd></dl>
|
||||
<p>Performs the cross product as shown in @algorithm.</p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html#l00069">69</a> of file <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html">vector_cross_product.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><span class="lineno"> 69</span> {</div>
|
||||
<div class="line"><span class="lineno"> 70</span> std::array<double, 3> product;</div>
|
||||
<div class="line"><span class="lineno"> 72</span> product[0] = (A[1] * B[2]) - (A[2] * B[1]);</div>
|
||||
<div class="line"><span class="lineno"> 73</span> product[1] = -((A[0] * B[2]) - (A[2] * B[0]));</div>
|
||||
<div class="line"><span class="lineno"> 74</span> product[2] = (A[0] * B[1]) - (A[1] * B[0]);</div>
|
||||
<div class="line"><span class="lineno"> 75</span> <span class="keywordflow">return</span> product;</div>
|
||||
<div class="line"><span class="lineno"> 76</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html#l00074">74</a> of file <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html">vector_cross_product.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><span class="lineno"> 75</span> {</div>
|
||||
<div class="line"><span class="lineno"> 76</span> std::array<double, 3> product;</div>
|
||||
<div class="line"><span class="lineno"> 78</span> product[0] = (A[1] * B[2]) - (A[2] * B[1]);</div>
|
||||
<div class="line"><span class="lineno"> 79</span> product[1] = -((A[0] * B[2]) - (A[2] * B[0]));</div>
|
||||
<div class="line"><span class="lineno"> 80</span> product[2] = (A[0] * B[1]) - (A[1] * B[0]);</div>
|
||||
<div class="line"><span class="lineno"> 81</span> <span class="keywordflow">return</span> product;</div>
|
||||
<div class="line"><span class="lineno"> 82</span>}</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -232,11 +231,12 @@ Example:</h3>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>type: double description: the magnitude of the mathematical vector from the given direction ratios. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html#l00083">83</a> of file <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html">vector_cross_product.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><span class="lineno"> 83</span> {</div>
|
||||
<div class="line"><span class="lineno"> 84</span> <span class="keywordtype">double</span> magnitude = sqrt((vec[0] * vec[0]) + (vec[1] * vec[1]) + (vec[2] * vec[2]));</div>
|
||||
<div class="line"><span class="lineno"> 85</span> <span class="keywordflow">return</span> magnitude;</div>
|
||||
<div class="line"><span class="lineno"> 86</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html#l00091">91</a> of file <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html">vector_cross_product.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><span class="lineno"> 91</span> {</div>
|
||||
<div class="line"><span class="lineno"> 92</span> <span class="keywordtype">double</span> magnitude =</div>
|
||||
<div class="line"><span class="lineno"> 93</span> sqrt((vec[0] * vec[0]) + (vec[1] * vec[1]) + (vec[2] * vec[2]));</div>
|
||||
<div class="line"><span class="lineno"> 94</span> <span class="keywordflow">return</span> magnitude;</div>
|
||||
<div class="line"><span class="lineno"> 95</span>}</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -258,35 +258,13 @@ Example:</h3>
|
||||
<p>Main Function. </p>
|
||||
<p>Asks the user to enter the direction ratios for each of the two mathematical vectors using std::cin </p><dl class="section return"><dt>Returns</dt><dd>0 on exit </dd></dl>
|
||||
<p>Tests the functions with sample input before asking for user input.</p>
|
||||
<p>Gets the values for the first vector.</p>
|
||||
<p>Gets the values for the second vector.</p>
|
||||
<p>Displays the output out.</p>
|
||||
<p>Displays the magnitude of the cross product.</p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html#l00109">109</a> of file <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html">vector_cross_product.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><span class="lineno"> 109</span> {</div>
|
||||
<div class="line"><span class="lineno"> 110</span></div>
|
||||
<div class="line"><span class="lineno"> 112</span> <a class="code hl_function" href="#aa8dca7b867074164d5f45b0f3851269d">test</a>();</div>
|
||||
<div class="line"><span class="lineno"> 113</span> </div>
|
||||
<div class="line"><span class="lineno"> 114</span> std::array<double, 3> vec1;</div>
|
||||
<div class="line"><span class="lineno"> 115</span> std::array<double, 3> vec2;</div>
|
||||
<div class="line"><span class="lineno"> 116</span></div>
|
||||
<div class="line"><span class="lineno"> 118</span> std::cout << <span class="stringliteral">"\nPass the first Vector: "</span>;</div>
|
||||
<div class="line"><span class="lineno"> 119</span> std::cin >> vec1[0] >> vec1[1] >> vec1[2];</div>
|
||||
<div class="line"><span class="lineno"> 120</span></div>
|
||||
<div class="line"><span class="lineno"> 122</span> std::cout << <span class="stringliteral">"\nPass the second Vector: "</span>;</div>
|
||||
<div class="line"><span class="lineno"> 123</span> std::cin >> vec2[0] >> vec2[1] >> vec2[2];</div>
|
||||
<div class="line"><span class="lineno"> 124</span></div>
|
||||
<div class="line"><span class="lineno"> 126</span> std::array<double, 3> product = <a class="code hl_function" href="#a225732399c5c076976eae5b180a9f8c9">math::vector_cross::cross</a>(vec1, vec2);</div>
|
||||
<div class="line"><span class="lineno"> 127</span> std::cout << <span class="stringliteral">"\nThe cross product is: "</span> << product[0] << <span class="stringliteral">" "</span> << product[1] << <span class="stringliteral">" "</span> << product[2] << std::endl;</div>
|
||||
<div class="line"><span class="lineno"> 128</span></div>
|
||||
<div class="line"><span class="lineno"> 130</span> std::cout << <span class="stringliteral">"Magnitude: "</span> << <a class="code hl_function" href="#a4b2a9757a87c18e1642d72410ecfaba8">math::vector_cross::mag</a>(product) << <span class="stringliteral">"\n"</span> << std::endl;</div>
|
||||
<div class="line"><span class="lineno"> 131</span> </div>
|
||||
<div class="line"><span class="lineno"> 132</span> <span class="keywordflow">return</span> 0;</div>
|
||||
<div class="line"><span class="lineno"> 133</span>}</div>
|
||||
<div class="ttc" id="avector__cross__product_8cpp_html_a225732399c5c076976eae5b180a9f8c9"><div class="ttname"><a href="#a225732399c5c076976eae5b180a9f8c9">math::vector_cross::cross</a></div><div class="ttdeci">std::array< double, 3 > cross(const std::array< double, 3 > &A, const std::array< double, 3 > &B)</div><div class="ttdoc">Function to calculate the cross product of the passed arrays containing the direction ratios of the t...</div><div class="ttdef"><b>Definition</b> <a href="../../df/d66/vector__cross__product_8cpp_source.html#l00069">vector_cross_product.cpp:69</a></div></div>
|
||||
<div class="ttc" id="avector__cross__product_8cpp_html_a4b2a9757a87c18e1642d72410ecfaba8"><div class="ttname"><a href="#a4b2a9757a87c18e1642d72410ecfaba8">math::vector_cross::mag</a></div><div class="ttdeci">double mag(const std::array< double, 3 > &vec)</div><div class="ttdoc">Calculates the magnitude of the mathematical vector from it's direction ratios.</div><div class="ttdef"><b>Definition</b> <a href="../../df/d66/vector__cross__product_8cpp_source.html#l00083">vector_cross_product.cpp:83</a></div></div>
|
||||
<div class="ttc" id="avector__cross__product_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">namespace math</div><div class="ttdef"><b>Definition</b> <a href="../../df/d66/vector__cross__product_8cpp_source.html#l00094">vector_cross_product.cpp:94</a></div></div>
|
||||
<p class="definition">Definition at line <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html#l00128">128</a> of file <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html">vector_cross_product.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><span class="lineno"> 128</span> {</div>
|
||||
<div class="line"><span class="lineno"> 130</span> <a class="code hl_function" href="#aa8dca7b867074164d5f45b0f3851269d">test</a>();</div>
|
||||
<div class="line"><span class="lineno"> 131</span> <span class="keywordflow">return</span> 0;</div>
|
||||
<div class="line"><span class="lineno"> 132</span>}</div>
|
||||
<div class="ttc" id="avector__cross__product_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">test function.</div><div class="ttdef"><b>Definition</b> <a href="../../df/d66/vector__cross__product_8cpp_source.html#l00103">vector_cross_product.cpp:103</a></div></div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -313,20 +291,30 @@ Example:</h3>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>namespace math </p>
|
||||
<p>test function.</p>
|
||||
<p>test function. </p>
|
||||
<p>test the cross() and the mag() functions. </p>
|
||||
<p>Tests the cross() function.</p>
|
||||
<p>Tests the mag() function.</p>
|
||||
<p>Tests A ⨯ A = 0</p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html#l00094">94</a> of file <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html">vector_cross_product.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><span class="lineno"> 94</span> {</div>
|
||||
<div class="line"><span class="lineno"> 96</span> std::array<double, 3> t_vec = <a class="code hl_function" href="#a225732399c5c076976eae5b180a9f8c9">math::vector_cross::cross</a>({1, 2, 3}, {4, 5, 6});</div>
|
||||
<div class="line"><span class="lineno"> 97</span> assert(t_vec[0] == -3 && t_vec[1] == 6 && t_vec[2] == -3);</div>
|
||||
<div class="line"><span class="lineno"> 98</span></div>
|
||||
<div class="line"><span class="lineno"> 100</span> <span class="keywordtype">double</span> t_mag = <a class="code hl_function" href="#a4b2a9757a87c18e1642d72410ecfaba8">math::vector_cross::mag</a>({6, 8, 0});</div>
|
||||
<div class="line"><span class="lineno"> 101</span> assert(t_mag == 10);</div>
|
||||
<div class="line"><span class="lineno"> 102</span>}</div>
|
||||
<p class="definition">Definition at line <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html#l00103">103</a> of file <a class="el" href="../../df/d66/vector__cross__product_8cpp_source.html">vector_cross_product.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><span class="lineno"> 103</span> {</div>
|
||||
<div class="line"><span class="lineno"> 105</span> std::array<double, 3> t_vec =</div>
|
||||
<div class="line"><span class="lineno"> 106</span> <a class="code hl_function" href="#a225732399c5c076976eae5b180a9f8c9">math::vector_cross::cross</a>({1, 2, 3}, {4, 5, 6});</div>
|
||||
<div class="line"><span class="lineno"> 107</span> assert(t_vec[0] == -3 && t_vec[1] == 6 && t_vec[2] == -3);</div>
|
||||
<div class="line"><span class="lineno"> 108</span></div>
|
||||
<div class="line"><span class="lineno"> 110</span> <span class="keywordtype">double</span> t_mag = <a class="code hl_function" href="#a4b2a9757a87c18e1642d72410ecfaba8">math::vector_cross::mag</a>({6, 8, 0});</div>
|
||||
<div class="line"><span class="lineno"> 111</span> assert(t_mag == 10);</div>
|
||||
<div class="line"><span class="lineno"> 112</span></div>
|
||||
<div class="line"><span class="lineno"> 114</span> std::array<double, 3> t_vec2 =</div>
|
||||
<div class="line"><span class="lineno"> 115</span> <a class="code hl_function" href="#a225732399c5c076976eae5b180a9f8c9">math::vector_cross::cross</a>({1, 2, 3}, {1, 2, 3});</div>
|
||||
<div class="line"><span class="lineno"> 116</span> assert(t_vec2[0] == 0 && t_vec2[1] == 0 &&</div>
|
||||
<div class="line"><span class="lineno"> 117</span> t_vec2[2] == 0); <span class="comment">// checking each element</span></div>
|
||||
<div class="line"><span class="lineno"> 118</span> assert(<a class="code hl_function" href="#a4b2a9757a87c18e1642d72410ecfaba8">math::vector_cross::mag</a>(t_vec2) ==</div>
|
||||
<div class="line"><span class="lineno"> 119</span> 0); <span class="comment">// checking the magnitude is also zero</span></div>
|
||||
<div class="line"><span class="lineno"> 120</span>}</div>
|
||||
<div class="ttc" id="avector__cross__product_8cpp_html_a225732399c5c076976eae5b180a9f8c9"><div class="ttname"><a href="#a225732399c5c076976eae5b180a9f8c9">math::vector_cross::cross</a></div><div class="ttdeci">std::array< double, 3 > cross(const std::array< double, 3 > &A, const std::array< double, 3 > &B)</div><div class="ttdoc">Function to calculate the cross product of the passed arrays containing the direction ratios of the t...</div><div class="ttdef"><b>Definition</b> <a href="../../df/d66/vector__cross__product_8cpp_source.html#l00074">vector_cross_product.cpp:74</a></div></div>
|
||||
<div class="ttc" id="avector__cross__product_8cpp_html_a4b2a9757a87c18e1642d72410ecfaba8"><div class="ttname"><a href="#a4b2a9757a87c18e1642d72410ecfaba8">math::vector_cross::mag</a></div><div class="ttdeci">double mag(const std::array< double, 3 > &vec)</div><div class="ttdoc">Calculates the magnitude of the mathematical vector from it's direction ratios.</div><div class="ttdef"><b>Definition</b> <a href="../../df/d66/vector__cross__product_8cpp_source.html#l00091">vector_cross_product.cpp:91</a></div></div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user