Skip to content

Commit

Permalink
deploy: b7eaa87
Browse files Browse the repository at this point in the history
  • Loading branch information
jfalcou committed Nov 29, 2024
1 parent 583f1fc commit 5a91ba0
Show file tree
Hide file tree
Showing 11 changed files with 61 additions and 14 deletions.
8 changes: 6 additions & 2 deletions group__constants_gaef5f976969c3f4758bc57db6bfa54120.html
Original file line number Diff line number Diff line change
Expand Up @@ -150,15 +150,19 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaef5f976969c3f4758bc57db
<div class="line"> <span class="keyword">template</span>&lt;kyosu::concepts::cayley_dickson T&gt; <span class="keyword">constexpr</span> as_complex_t&lt;eve::as_floating_point_t&lt;T&gt;&gt; <a class="code hl_variable" href="group__constants_gaef5f976969c3f4758bc57db6bfa54120.html#gaef5f976969c3f4758bc57db6bfa54120">cinf</a>(as&lt;T&gt; z) <span class="keyword">noexcept</span>;</div>
<div class="line"> <span class="keyword">template</span>&lt;kyosu::real T&gt; <span class="keyword">constexpr</span> as_complex_t&lt;eve::as_floating_point_t&lt;T&gt;&gt; <a class="code hl_variable" href="group__constants_gaef5f976969c3f4758bc57db6bfa54120.html#gaef5f976969c3f4758bc57db6bfa54120">cinf</a>(as&lt;T&gt; z) <span class="keyword">noexcept</span>;</div>
<div class="line">}</div>
<div class="ttc" id="agroup__constants_gaef5f976969c3f4758bc57db6bfa54120_html_gaef5f976969c3f4758bc57db6bfa54120"><div class="ttname"><a href="group__constants_gaef5f976969c3f4758bc57db6bfa54120.html#gaef5f976969c3f4758bc57db6bfa54120">kyosu::cinf</a></div><div class="ttdeci">constexpr auto cinf</div><div class="ttdoc">Computes the complex-infinite defined as in the chosen type.</div><div class="ttdef"><b>Definition:</b> cinf.hpp:73</div></div>
<div class="ttc" id="agroup__constants_gaef5f976969c3f4758bc57db6bfa54120_html_gaef5f976969c3f4758bc57db6bfa54120"><div class="ttname"><a href="group__constants_gaef5f976969c3f4758bc57db6bfa54120.html#gaef5f976969c3f4758bc57db6bfa54120">kyosu::cinf</a></div><div class="ttdeci">constexpr auto cinf</div><div class="ttdoc">Computes the complex-infinite defined as in the chosen type.</div><div class="ttdef"><b>Definition:</b> cinf.hpp:77</div></div>
<div class="ttc" id="anamespacekyosu_html"><div class="ttname"><a href="namespacekyosu.html">kyosu</a></div><div class="ttdoc">Main KYOSU namespace.</div><div class="ttdef"><b>Definition:</b> cinf.hpp:13</div></div>
</div><!-- fragment --><p><b>Parameters</b></p>
<ul>
<li><code>z</code>: Value to process.</li>
</ul>
<p><b>Return value</b></p>
<ul>
<li>always returns a <a class="el" href="structkyosu_1_1cayley__dickson.html" title="Cayley-Dickson algebra main abstraction It is built so that all operation over C, Q and other such al...">cayley_dickson</a> value such that <a class="el" href="group__functions_gaa9d12dd4e1420039046c737ddd3240be.html#gaa9d12dd4e1420039046c737ddd3240be" title="Extracts the real part of a value.">real(i)</a> is a NaN and <a class="el" href="group__functions.html#gaff94a2685c6d030458b388a4a4079efe" title="Alias for kyosu::ipart.">imag(i)</a> is \(+\infty\) (the remaining parts being 0).</li>
<li>always returns a <a class="el" href="structkyosu_1_1cayley__dickson.html" title="Cayley-Dickson algebra main abstraction It is built so that all operation over C, Q and other such al...">cayley_dickson</a> value such that <a class="el" href="group__functions_gaa9d12dd4e1420039046c737ddd3240be.html#gaa9d12dd4e1420039046c737ddd3240be" title="Extracts the real part of a value.">real(i)</a> is a NaN and <a class="el" href="group__functions.html#gaff94a2685c6d030458b388a4a4079efe" title="Alias for kyosu::ipart.">imag(i)</a> is \(+\infty\) (the remaining parts being 0). This is meant to represent a quantity with infinite magnitude, but undetermined complex phase.</li>
</ul>
<h2 class="groupheader">External references </h2>
<ul>
<li><a href="https://reference.wolfram.com/language/ref/ComplexInfinity.html">Wolfram MathWorld: complex infinity</a></li>
</ul>
<h2 class="groupheader">Example </h2>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;kyosu/kyosu.hpp&gt;</span></div>
Expand Down
6 changes: 5 additions & 1 deletion group__functions_ga6061b321a4cb255fbbcae1992d42aafa.html
Original file line number Diff line number Diff line change
Expand Up @@ -150,14 +150,18 @@ <h2 class="groupheader">Header file </h2>
<div class="line"> <span class="keyword">template</span>&lt;kyosu::concepts::cayley_dickson T&gt; <span class="keyword">constexpr</span> T <a class="code hl_variable" href="group__functions_ga6061b321a4cb255fbbcae1992d42aafa.html#ga6061b321a4cb255fbbcae1992d42aafa">csch</a>(T z) <span class="keyword">noexcept</span>;</div>
<div class="line"> <span class="keyword">template</span>&lt;eve::<span class="keywordtype">float</span>ing_ordered_value T&gt; <span class="keyword">constexpr</span> T <a class="code hl_variable" href="group__functions_ga6061b321a4cb255fbbcae1992d42aafa.html#ga6061b321a4cb255fbbcae1992d42aafa">csch</a>(T z) <span class="keyword">noexcept</span>;</div>
<div class="line">}</div>
<div class="ttc" id="agroup__functions_ga6061b321a4cb255fbbcae1992d42aafa_html_ga6061b321a4cb255fbbcae1992d42aafa"><div class="ttname"><a href="group__functions_ga6061b321a4cb255fbbcae1992d42aafa.html#ga6061b321a4cb255fbbcae1992d42aafa">kyosu::csch</a></div><div class="ttdeci">constexpr auto csch</div><div class="ttdoc">Computes the hyperbolic cosecant of the argument.</div><div class="ttdef"><b>Definition:</b> csch.hpp:64</div></div>
<div class="ttc" id="agroup__functions_ga6061b321a4cb255fbbcae1992d42aafa_html_ga6061b321a4cb255fbbcae1992d42aafa"><div class="ttname"><a href="group__functions_ga6061b321a4cb255fbbcae1992d42aafa.html#ga6061b321a4cb255fbbcae1992d42aafa">kyosu::csch</a></div><div class="ttdeci">constexpr auto csch</div><div class="ttdoc">Computes the hyperbolic cosecant of the argument.</div><div class="ttdef"><b>Definition:</b> csch.hpp:67</div></div>
<div class="ttc" id="anamespacekyosu_html"><div class="ttname"><a href="namespacekyosu.html">kyosu</a></div><div class="ttdoc">Main KYOSU namespace.</div><div class="ttdef"><b>Definition:</b> cinf.hpp:13</div></div>
</div><!-- fragment --><p><b>Parameters</b></p>
<ul>
<li><code>z</code>: Value to process.</li>
</ul>
<p><b>Return value</b></p>
<p>Returns the hyperbolic cosecant of the argument.</p>
<h2 class="groupheader">External references </h2>
<ul>
<li><a href="https://mathworld.wolfram.com/HyperbolicCosecant.html">Wolfram MathWorld: Hyperbolic Cosecant</a></li>
</ul>
<h2 class="groupheader">Example </h2>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;kyosu/kyosu.hpp&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;eve/wide.hpp&gt;</span></div>
Expand Down
8 changes: 6 additions & 2 deletions group__functions_ga64a0550a46270d01b31593e38a364f72.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,14 +149,18 @@ <h2 class="groupheader">Header file </h2>
<div class="line">{</div>
<div class="line"> <span class="keyword">auto</span> <a class="code hl_variable" href="group__functions_ga64a0550a46270d01b31593e38a364f72.html#ga64a0550a46270d01b31593e38a364f72">beta</a>(<span class="keyword">auto</span> x, <span class="keyword">auto</span> y) <span class="keyword">noexcept</span>;</div>
<div class="line">}</div>
<div class="ttc" id="agroup__functions_ga64a0550a46270d01b31593e38a364f72_html_ga64a0550a46270d01b31593e38a364f72"><div class="ttname"><a href="group__functions_ga64a0550a46270d01b31593e38a364f72.html#ga64a0550a46270d01b31593e38a364f72">kyosu::beta</a></div><div class="ttdeci">constexpr auto beta</div><div class="ttdoc">Computes the beta function: for real or complex entries.</div><div class="ttdef"><b>Definition:</b> beta.hpp:69</div></div>
<div class="ttc" id="agroup__functions_ga64a0550a46270d01b31593e38a364f72_html_ga64a0550a46270d01b31593e38a364f72"><div class="ttname"><a href="group__functions_ga64a0550a46270d01b31593e38a364f72.html#ga64a0550a46270d01b31593e38a364f72">kyosu::beta</a></div><div class="ttdeci">constexpr auto beta</div><div class="ttdoc">Computes the beta function: for real or complex entries.</div><div class="ttdef"><b>Definition:</b> beta.hpp:72</div></div>
<div class="ttc" id="anamespacekyosu_html"><div class="ttname"><a href="namespacekyosu.html">kyosu</a></div><div class="ttdoc">Main KYOSU namespace.</div><div class="ttdef"><b>Definition:</b> cinf.hpp:13</div></div>
</div><!-- fragment --><p><b>Parameters</b></p>
<ul>
<li><code>x</code>,<code>y</code> : Values to process. Can be a mix of <a class="el" href="structkyosu_1_1cayley__dickson.html" title="Cayley-Dickson algebra main abstraction It is built so that all operation over C, Q and other such al...">cayley_dickson</a> and real floating values.</li>
<li><code>x</code>,<code>y</code> : Values to process. Can be a mix of Cayley_dickson and real floating values.</li>
</ul>
<p><b>Return value</b></p>
<p>\(\displaystyle \mathbf{B}(x,y) = \frac{\Gamma(x)\Gamma(y)}{\Gamma(x+y)}\) is returned. If <code>x</code> and <code>y</code> are real typed values they are treated as complex inputs.</p>
<h2 class="groupheader">External references </h2>
<ul>
<li><a href="https://mathworld.wolfram.com/BetaFunction.html">Wolfram MathWorld: Beta Function</a></li>
</ul>
<h2 class="groupheader">Example </h2>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;kyosu/kyosu.hpp&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;eve/wide.hpp&gt;</span></div>
Expand Down
6 changes: 5 additions & 1 deletion group__functions_ga783725b137881f9e6e60e1f9b3bae9fc.html
Original file line number Diff line number Diff line change
Expand Up @@ -150,14 +150,18 @@ <h2 class="groupheader">Header file </h2>
<div class="line"> <span class="keyword">template</span>&lt;kyosu::concepts::cayley_dickson T&gt; <span class="keyword">constexpr</span> T <a class="code hl_variable" href="group__functions_ga783725b137881f9e6e60e1f9b3bae9fc.html#ga783725b137881f9e6e60e1f9b3bae9fc">cot</a>(T z) <span class="keyword">noexcept</span>;</div>
<div class="line"> <span class="keyword">template</span>&lt;eve::<span class="keywordtype">float</span>ing_ordered_value T&gt; <span class="keyword">constexpr</span> T <a class="code hl_variable" href="group__functions_ga783725b137881f9e6e60e1f9b3bae9fc.html#ga783725b137881f9e6e60e1f9b3bae9fc">cot</a>(T z) <span class="keyword">noexcept</span>;</div>
<div class="line">}</div>
<div class="ttc" id="agroup__functions_ga783725b137881f9e6e60e1f9b3bae9fc_html_ga783725b137881f9e6e60e1f9b3bae9fc"><div class="ttname"><a href="group__functions_ga783725b137881f9e6e60e1f9b3bae9fc.html#ga783725b137881f9e6e60e1f9b3bae9fc">kyosu::cot</a></div><div class="ttdeci">constexpr auto cot</div><div class="ttdoc">Computes the cotangent of the argument.</div><div class="ttdef"><b>Definition:</b> cot.hpp:73</div></div>
<div class="ttc" id="agroup__functions_ga783725b137881f9e6e60e1f9b3bae9fc_html_ga783725b137881f9e6e60e1f9b3bae9fc"><div class="ttname"><a href="group__functions_ga783725b137881f9e6e60e1f9b3bae9fc.html#ga783725b137881f9e6e60e1f9b3bae9fc">kyosu::cot</a></div><div class="ttdeci">constexpr auto cot</div><div class="ttdoc">Computes the cotangent of the argument.</div><div class="ttdef"><b>Definition:</b> cot.hpp:75</div></div>
<div class="ttc" id="anamespacekyosu_html"><div class="ttname"><a href="namespacekyosu.html">kyosu</a></div><div class="ttdoc">Main KYOSU namespace.</div><div class="ttdef"><b>Definition:</b> cinf.hpp:13</div></div>
</div><!-- fragment --><p><b>Parameters</b></p>
<ul>
<li><code>z</code>: Value to process.</li>
</ul>
<p><b>Return value</b></p>
<p>Returns the cotangent of the argument.</p>
<h2 class="groupheader">External references </h2>
<ul>
<li><a href="https://mathworld.wolfram.com/Cotangent.html">Wolfram MathWorld: Cotangent</a></li>
</ul>
<h2 class="groupheader">Example </h2>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;kyosu/kyosu.hpp&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;eve/wide.hpp&gt;</span></div>
Expand Down
8 changes: 7 additions & 1 deletion group__functions_ga788b51ca9d3366567828c74d46f12168.html
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ <h2 class="groupheader">Header file </h2>
<div class="line"> <span class="keyword">template</span>&lt;kyosu::concepts::complex T&gt; <span class="keyword">constexpr</span> T <a class="code hl_variable" href="group__functions_ga788b51ca9d3366567828c74d46f12168.html#ga788b51ca9d3366567828c74d46f12168">cos</a>(T z) <span class="keyword">noexcept</span>; <span class="comment">//2</span></div>
<div class="line"> <span class="keyword">template</span>&lt;kyosu::concepts::cayley_dickson T&gt; <span class="keyword">constexpr</span> T <a class="code hl_variable" href="group__functions_ga788b51ca9d3366567828c74d46f12168.html#ga788b51ca9d3366567828c74d46f12168">cos</a>(T z) <span class="keyword">noexcept</span>; <span class="comment">//3</span></div>
<div class="line">}</div>
<div class="ttc" id="agroup__functions_ga788b51ca9d3366567828c74d46f12168_html_ga788b51ca9d3366567828c74d46f12168"><div class="ttname"><a href="group__functions_ga788b51ca9d3366567828c74d46f12168.html#ga788b51ca9d3366567828c74d46f12168">kyosu::cos</a></div><div class="ttdeci">constexpr auto cos</div><div class="ttdoc">Computes the cosine of the argument.</div><div class="ttdef"><b>Definition:</b> cos.hpp:74</div></div>
<div class="ttc" id="agroup__functions_ga788b51ca9d3366567828c74d46f12168_html_ga788b51ca9d3366567828c74d46f12168"><div class="ttname"><a href="group__functions_ga788b51ca9d3366567828c74d46f12168.html#ga788b51ca9d3366567828c74d46f12168">kyosu::cos</a></div><div class="ttdeci">constexpr auto cos</div><div class="ttdoc">Computes the cosine of the argument.</div><div class="ttdef"><b>Definition:</b> cos.hpp:78</div></div>
<div class="ttc" id="anamespacekyosu_html"><div class="ttname"><a href="namespacekyosu.html">kyosu</a></div><div class="ttdoc">Main KYOSU namespace.</div><div class="ttdef"><b>Definition:</b> cinf.hpp:13</div></div>
</div><!-- fragment --><p><b>Parameters</b></p>
<ul>
Expand All @@ -163,6 +163,12 @@ <h2 class="groupheader">Header file </h2>
<li>The behavior of this function is equivalent to <code>eve::cosh(i*z)</code>.</li>
<li>Returns \(\cosh(I_z\; z)\) if \(z\) is not zero else \(\cos(z_0)\), where \(I_z = \frac{\underline{z}}{|\underline{z}|}\) and \(\underline{z}\) is the <a class="el" href="group__functions.html#gaff94a2685c6d030458b388a4a4079efe">pure</a> part of \(z\).</li>
</ol>
<h2 class="groupheader">External references </h2>
<ul>
<li><a href="https://en.cppreference.com/w/cpp/numeric/complex/cos">C++ standard reference: complex cos</a></li>
<li><a href="https://mathworld.wolfram.com/Cosine.html">Wolfram MathWorld: Cosine</a></li>
<li><a href="https://fr.wikipedia.org/wiki/cosinus">Wikipedia: cosinus</a></li>
</ul>
<h2 class="groupheader">Example </h2>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;kyosu/kyosu.hpp&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;eve/wide.hpp&gt;</span></div>
Expand Down
2 changes: 1 addition & 1 deletion group__functions_ga8d6f64b6ed68055ef05917557d2e60b6.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ <h2 class="groupheader">Example </h2>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">} </div>
<div class="ttc" id="agroup__functions_gad4e960a6cb254cdd741323efc8efa3a0_html_gad4e960a6cb254cdd741323efc8efa3a0"><div class="ttname"><a href="group__functions_gad4e960a6cb254cdd741323efc8efa3a0.html#gad4e960a6cb254cdd741323efc8efa3a0">kyosu::conj</a></div><div class="ttdeci">constexpr auto conj</div><div class="ttdoc">Computes the conjugate value.</div><div class="ttdef"><b>Definition:</b> conj.hpp:66</div></div>
<div class="ttc" id="agroup__functions_gad4e960a6cb254cdd741323efc8efa3a0_html_gad4e960a6cb254cdd741323efc8efa3a0"><div class="ttname"><a href="group__functions_gad4e960a6cb254cdd741323efc8efa3a0.html#gad4e960a6cb254cdd741323efc8efa3a0">kyosu::conj</a></div><div class="ttdeci">constexpr auto conj</div><div class="ttdoc">Computes the conjugate value.</div><div class="ttdef"><b>Definition:</b> conj.hpp:70</div></div>
<div class="ttc" id="agroup__types_ga0fb102adb92b2be024f398e2ac5dd5cd_html_ga0fb102adb92b2be024f398e2ac5dd5cd"><div class="ttname"><a href="group__types_ga0fb102adb92b2be024f398e2ac5dd5cd.html#ga0fb102adb92b2be024f398e2ac5dd5cd">kyosu::quaternion_t</a></div><div class="ttdeci">as_cayley_dickson_n_t&lt; 4, T &gt; quaternion_t</div><div class="ttdoc">Type alias for quaternion numbers.</div><div class="ttdef"><b>Definition:</b> quaternion.hpp:24</div></div>
<div class="ttc" id="agroup__types_ga642e4c9da3267bde80011f41e698ba76_html_ga642e4c9da3267bde80011f41e698ba76"><div class="ttname"><a href="group__types_ga642e4c9da3267bde80011f41e698ba76.html#ga642e4c9da3267bde80011f41e698ba76">kyosu::complex_t</a></div><div class="ttdeci">as_cayley_dickson_n_t&lt; 2, T &gt; complex_t</div><div class="ttdoc">Type alias for complex numbers.</div><div class="ttdef"><b>Definition:</b> complex.hpp:27</div></div>
</div><!-- fragment -->
Expand Down
7 changes: 6 additions & 1 deletion group__functions_gaa1c85fe49012f1d7bdabbfe0fe1abaf4.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,14 +149,19 @@ <h2 class="groupheader">Header file </h2>
<div class="line">{</div>
<div class="line"> <span class="keyword">constexpr</span> <span class="keyword">auto</span> <a class="code hl_variable" href="group__functions_gaa1c85fe49012f1d7bdabbfe0fe1abaf4.html#gaa1c85fe49012f1d7bdabbfe0fe1abaf4">commutator</a>(<span class="keyword">auto</span> z0, <span class="keyword">auto</span> z1) <span class="keyword">noexcept</span>;</div>
<div class="line">}</div>
<div class="ttc" id="agroup__functions_gaa1c85fe49012f1d7bdabbfe0fe1abaf4_html_gaa1c85fe49012f1d7bdabbfe0fe1abaf4"><div class="ttname"><a href="group__functions_gaa1c85fe49012f1d7bdabbfe0fe1abaf4.html#gaa1c85fe49012f1d7bdabbfe0fe1abaf4">kyosu::commutator</a></div><div class="ttdeci">constexpr auto commutator</div><div class="ttdoc">Computes the commutator of the two parameters.</div><div class="ttdef"><b>Definition:</b> commutator.hpp:63</div></div>
<div class="ttc" id="agroup__functions_gaa1c85fe49012f1d7bdabbfe0fe1abaf4_html_gaa1c85fe49012f1d7bdabbfe0fe1abaf4"><div class="ttname"><a href="group__functions_gaa1c85fe49012f1d7bdabbfe0fe1abaf4.html#gaa1c85fe49012f1d7bdabbfe0fe1abaf4">kyosu::commutator</a></div><div class="ttdeci">constexpr auto commutator</div><div class="ttdoc">Computes the commutator of the two parameters.</div><div class="ttdef"><b>Definition:</b> commutator.hpp:67</div></div>
<div class="ttc" id="anamespacekyosu_html"><div class="ttname"><a href="namespacekyosu.html">kyosu</a></div><div class="ttdoc">Main KYOSU namespace.</div><div class="ttdef"><b>Definition:</b> cinf.hpp:13</div></div>
</div><!-- fragment --><p><b>Parameters</b></p>
<ul>
<li><code>z0</code>, <code>z1</code>: Values to process. Can be a mix of complex and real floating values and complex values.</li>
</ul>
<p><b>Return value</b></p>
<p>Returns the difference z0*z1-z1*z0.</p>
<h2 class="groupheader">External references </h2>
<ul>
<li><a href="https://mathworld.wolfram.com/Commutator.html">Wolfram MathWorld: Commutator</a></li>
<li><a href="https://en.wikipedia.org/wiki/Commutator">Wikipedia: Commutator</a></li>
</ul>
<h2 class="groupheader">Example </h2>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;kyosu/kyosu.hpp&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;eve/wide.hpp&gt;</span></div>
Expand Down
Loading

0 comments on commit 5a91ba0

Please sign in to comment.