deploy: a53fe91

group__complex.html

@@ -131,7 +131,7 @@
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
 Variables</h2></td></tr>
 <tr class="memitem:gad70670d8278d34dc0f0faf883a48eab8"><td class="memItemLeft" align="right" valign="top">constexpr tags::callable_from_polar&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__complex_gad70670d8278d34dc0f0faf883a48eab8.html#gad70670d8278d34dc0f0faf883a48eab8">kyosu::from_polar</a> = {}</td></tr>
-<tr class="memdesc:gad70670d8278d34dc0f0faf883a48eab8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callable object computing a complex from its polar coordinates.  <br /></td></tr>
+<tr class="memdesc:gad70670d8278d34dc0f0faf883a48eab8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callable object computing a complex or a general Cayley-Dickson from a polar representation.  <br /></td></tr>
 <tr class="separator:gad70670d8278d34dc0f0faf883a48eab8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gac49e8cf76fe002ef3d3e480fb80217ff"><td class="memItemLeft" align="right" valign="top">constexpr tags::callable_to_polar&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__complex_gac49e8cf76fe002ef3d3e480fb80217ff.html#gac49e8cf76fe002ef3d3e480fb80217ff">kyosu::to_polar</a> = {}</td></tr>
 <tr class="memdesc:gac49e8cf76fe002ef3d3e480fb80217ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callable object computing the polar coordinates from a complex.  <br /></td></tr>

group__complex_gac49e8cf76fe002ef3d3e480fb80217ff.html

@@ -149,12 +149,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac49e8cf76fe002ef3d3e480
 </div><!-- fragment --><h2 class="groupheader">Callable Signatures </h2>
 <div class="fragment"><div class="line"><span class="keyword">namespace </span>eve</div>
 <div class="line">{</div>
-<div class="line">   <span class="keyword">template</span>&lt;eve::ordered_value T&gt;              <span class="keyword">constexpr</span> <span class="keyword">auto</span> <a class="code hl_variable" href="group__functions_gabe0cc0a4ddad9387b7e6bc13e6b3bcfd.html#gabe0cc0a4ddad9387b7e6bc13e6b3bcfd">arg</a>(T z) <span class="keyword">noexcept</span>;  <span class="comment">//1</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> <span class="keyword">auto</span> <a class="code hl_variable" href="group__functions_gabe0cc0a4ddad9387b7e6bc13e6b3bcfd.html#gabe0cc0a4ddad9387b7e6bc13e6b3bcfd">arg</a>(T z) <span class="keyword">noexcept</span>;  <span class="comment">//1</span></div>
 <div class="line">   <span class="keyword">template</span>&lt;kyosu::concepts::complex T&gt;        <span class="keyword">constexpr</span> <span class="keyword">auto</span> <a class="code hl_variable" href="group__functions_ga7859bd9f30d2ef73a22fc8d114faea47.html#ga7859bd9f30d2ef73a22fc8d114faea47">atan</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> <span class="keyword">auto</span> argy(T z) <span class="keyword">noexcept</span>;  <span class="comment">//3</span></div>
 <div class="line">}</div>
-<div class="ttc" id="agroup__functions_ga7859bd9f30d2ef73a22fc8d114faea47_html_ga7859bd9f30d2ef73a22fc8d114faea47"><div class="ttname"><a href="group__functions_ga7859bd9f30d2ef73a22fc8d114faea47.html#ga7859bd9f30d2ef73a22fc8d114faea47">kyosu::atan</a></div><div class="ttdeci">constexpr tags::callable_atan atan</div><div class="ttdoc">Computes the inverse hyperbolic tangent of the argument.</div><div class="ttdef"><b>Definition:</b> atan.hpp:86</div></div>
-<div class="ttc" id="agroup__functions_gabe0cc0a4ddad9387b7e6bc13e6b3bcfd_html_gabe0cc0a4ddad9387b7e6bc13e6b3bcfd"><div class="ttname"><a href="group__functions_gabe0cc0a4ddad9387b7e6bc13e6b3bcfd.html#gabe0cc0a4ddad9387b7e6bc13e6b3bcfd">kyosu::arg</a></div><div class="ttdeci">constexpr tags::callable_arg arg</div><div class="ttdoc">complex number argument.</div><div class="ttdef"><b>Definition:</b> arg.hpp:79</div></div>
+<div class="ttc" id="agroup__functions_ga7859bd9f30d2ef73a22fc8d114faea47_html_ga7859bd9f30d2ef73a22fc8d114faea47"><div class="ttname"><a href="group__functions_ga7859bd9f30d2ef73a22fc8d114faea47.html#ga7859bd9f30d2ef73a22fc8d114faea47">kyosu::atan</a></div><div class="ttdeci">constexpr tags::callable_atan atan</div><div class="ttdoc">Computes the arctangent of the argument.</div><div class="ttdef"><b>Definition:</b> atan.hpp:86</div></div>
+<div class="ttc" id="agroup__functions_gabe0cc0a4ddad9387b7e6bc13e6b3bcfd_html_gabe0cc0a4ddad9387b7e6bc13e6b3bcfd"><div class="ttname"><a href="group__functions_gabe0cc0a4ddad9387b7e6bc13e6b3bcfd.html#gabe0cc0a4ddad9387b7e6bc13e6b3bcfd">kyosu::arg</a></div><div class="ttdeci">constexpr tags::callable_arg arg</div><div class="ttdoc">argument.</div><div class="ttdef"><b>Definition:</b> arg.hpp:78</div></div>
 </div><!-- fragment --><p><b>Parameters</b></p>
 <p><code>q</code> : cayley dickson value</p>
 <p><b>Return value</b></p>
@@ -164,7 +164,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac49e8cf76fe002ef3d3e480
 <li>a tuple containing <code>rho</code>, 'theta' the modulus and the argument in radian of the cayley input and a square root of -1 iz such that <code>z = rho*exp(iz*theta). The leading coefficient of ìz</code> is chosen non-negative.`</li>
 </ol>
 <hr  />
-<h4><a class="anchor" id="autotoc_md22"></a>
+<h4><a class="anchor" id="autotoc_md24"></a>
 Example</h4>
 <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>

group__complex_gad70670d8278d34dc0f0faf883a48eab8.html

@@ -142,26 +142,29 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad70670d8278d34dc0f0faf8
 </table>
 </div><div class="memdoc">
 
-<p>Callable object computing a complex from its polar coordinates. </p>
+<p>Callable object computing a complex or a general Cayley-Dickson from a polar representation. </p>
 <p>This function is the reciprocal of from_polar</p>
 <p><b>Defined in header</b></p>
 <div class="fragment"><div class="line"><span class="preprocessor">#include eve/module/quaternion.hpp&gt;`</span></div>
 </div><!-- fragment --><h2 class="groupheader">Callable Signatures </h2>
 <div class="fragment"><div class="line"><span class="keyword">namespace </span>eve</div>
 <div class="line">{</div>
-<div class="line"> <span class="keyword">template</span>&lt;eve::ordered_value T0, eve::ordered_value T1&gt;,</div>
+<div class="line"> <span class="keyword">template</span>&lt;eve::<span class="keywordtype">float</span>ing_ordered_value T0, eve::<span class="keywordtype">float</span>ing_ordered_value T1&gt;,</div>
 <div class="line">  <span class="keyword">auto</span> <a class="code hl_variable" href="group__complex_gad70670d8278d34dc0f0faf883a48eab8.html#gad70670d8278d34dc0f0faf883a48eab8">from_polar</a>( T0 rho, T1 theta) <span class="keyword">const</span> <span class="keyword">noexcept</span>;                   <span class="comment">// 1</span></div>
-<div class="line"> <span class="keyword">template</span>&lt;eve::ordered_value T0, eve::ordered_value T1, kyosu::concepts::cayley_dickson C&gt;,</div>
+<div class="line"> <span class="keyword">template</span>&lt;eve::<span class="keywordtype">float</span>ing_ordered_value T0, eve::<span class="keywordtype">float</span>ing_ordered_value T1, kyosu::concepts::cayley_dickson C&gt;,</div>
 <div class="line">  <span class="keyword">auto</span> <a class="code hl_variable" href="group__complex_gad70670d8278d34dc0f0faf883a48eab8.html#gad70670d8278d34dc0f0faf883a48eab8">from_polar</a>( T0 rho, T1 theta, C iz) <span class="keyword">const</span> <span class="keyword">noexcept</span>;             <span class="comment">// 2</span></div>
 <div class="line">}</div>
-<div class="ttc" id="agroup__complex_gad70670d8278d34dc0f0faf883a48eab8_html_gad70670d8278d34dc0f0faf883a48eab8"><div class="ttname"><a href="group__complex_gad70670d8278d34dc0f0faf883a48eab8.html#gad70670d8278d34dc0f0faf883a48eab8">kyosu::from_polar</a></div><div class="ttdeci">constexpr tags::callable_from_polar from_polar</div><div class="ttdoc">Callable object computing a complex from its polar coordinates.</div><div class="ttdef"><b>Definition:</b> from_polar.hpp:102</div></div>
+<div class="ttc" id="agroup__complex_gad70670d8278d34dc0f0faf883a48eab8_html_gad70670d8278d34dc0f0faf883a48eab8"><div class="ttname"><a href="group__complex_gad70670d8278d34dc0f0faf883a48eab8.html#gad70670d8278d34dc0f0faf883a48eab8">kyosu::from_polar</a></div><div class="ttdeci">constexpr tags::callable_from_polar from_polar</div><div class="ttdoc">Callable object computing a complex or a general Cayley-Dickson from a polar representation.</div><div class="ttdef"><b>Definition:</b> from_polar.hpp:106</div></div>
 </div><!-- fragment --><p><b>Parameters</b></p>
-<p><code>rho</code> : modulus. <code>theta</code> : argument. &lsquo;iz&rsquo; : unitary cayley dickson value.</p>
+<p><code>rho</code> : modulus.</p>
+<p><code>theta</code> : argument.</p>
+<p>&lsquo;iz&rsquo; : unitary cayley dickson value.</p>
 <p><b>Return value</b></p>
 <ol type="1">
 <li>the complex number <code>rho*exp(i*theta)</code>.</li>
 <li>the cayley_dickson value <code>rho*exp(iz*theta)</code>.</li>
 </ol>
+<dl class="section note"><dt>Note</dt><dd>the entries constitue a proper polar representation if rho is non-negative and if iz present it must be pure unitary with non-negative jpart. However the formula is taken anyway.</dd></dl>
 <h4><a class="anchor" id="autotoc_md6"></a>
 Example</h4>
 <div class="fragment"><div class="line"><span class="preprocessor">#include &lt;kyosu/kyosu.hpp&gt;</span></div>