Add changes for 9760b9b

Author: actions-user

_sources/api.rst.txt

@@ -8,6 +8,8 @@ API Reference
    api/binary_operators.rst
    api/reductions.rst
    api/mathematical.rst
+   api/fast_math.rst
    api/conditional.rst
    api/memory_read_write.rst
+   api/utilities.rst
 

_sources/api/fast_math.rst.txt

@@ -0,0 +1,31 @@
+..
+  ============================================================
+  This file has been auto-generated. DO NOT MODIFY ITS CONTENT
+  ============================================================
+
+Fast math
+=========
+fast_exp
+--------
+.. doxygenfunction:: kernel_float::fast_exp
+
+fast_log
+--------
+.. doxygenfunction:: kernel_float::fast_log
+
+fast_cos
+--------
+.. doxygenfunction:: kernel_float::fast_cos
+
+fast_sin
+--------
+.. doxygenfunction:: kernel_float::fast_sin
+
+fast_tan
+--------
+.. doxygenfunction:: kernel_float::fast_tan
+
+fast_div
+--------
+.. doxygenfunction:: kernel_float::fast_div
+

_sources/api/generation.rst.txt

@@ -7,7 +7,11 @@ Generation
 ==========
 range
 -----
-.. doxygenfunction:: kernel_float::range
+.. doxygenfunction:: kernel_float::range()
+
+range
+-----
+.. doxygenfunction:: kernel_float::range(F fun)
 
 range_like
 ----------

_sources/api/memory_read_write.rst.txt

@@ -19,11 +19,11 @@ load
 
 loadn
 -----
-.. doxygenfunction:: kernel_float::loadn(const T*, ptrdiff_t)
+.. doxygenfunction:: kernel_float::loadn(const T*, size_t)
 
 loadn
 -----
-.. doxygenfunction:: kernel_float::loadn(const T*, ptrdiff_t, ptrdiff_t)
+.. doxygenfunction:: kernel_float::loadn(const T*, size_t, size_t)
 
 store
 -----
@@ -35,11 +35,11 @@ store
 
 storen
 ------
-.. doxygenfunction:: kernel_float::storen(const V&, T*, ptrdiff_t)
+.. doxygenfunction:: kernel_float::storen(const V&, T*, size_t)
 
 storen
 ------
-.. doxygenfunction:: kernel_float::storen(const V&, T*, ptrdiff_t, ptrdiff_t)
+.. doxygenfunction:: kernel_float::storen(const V&, T*, size_t, size_t)
 
 aligned_ptr
 -----------

_sources/api/utilities.rst.txt

@@ -0,0 +1,19 @@
+..
+  ============================================================
+  This file has been auto-generated. DO NOT MODIFY ITS CONTENT
+  ============================================================
+
+Utilities
+=========
+constant
+--------
+.. doxygenstruct:: kernel_float::constant
+
+tiling
+------
+.. doxygenstruct:: kernel_float::tiling
+
+KERNEL_FLOAT_TILING_FOR
+-----------------------
+.. doxygendefine:: KERNEL_FLOAT_TILING_FOR
+

_sources/guides.rst.txt

@@ -6,3 +6,4 @@ Guides
    guides/introduction.rst
    guides/promotion.rst
    guides/prelude.rst
+   guides/constant.rst

_sources/guides/constant.md.txt

@@ -0,0 +1,37 @@
+Using `kernel_float::constant`
+===
+
+When working with mixed precision types, you will find that working with constants presents a bit of a challenge.
+
+For example, a simple expression such as `3.14 * x` where `x` is of type `vec<float, 2>` will NOT be performed
+in `float` precision as you might expect, but instead in `double` precision.
+This happens since the left-hand side of this expression
+(a constant) is a `double` and thus `kernel_float` will also cast the right-hand side to `double`.
+
+To solve this problem, `kernel_float` offers a type called `constant<T>` that can be used to represent
+constants. Any binary operations between a value of type `U` and a `constant<T>` will result in both
+operands being cast to type `U` and the operation is performed in the precision of type `U`. This makes
+`constant<T>` useful for representing constants in your code.
+
+For example, consider the following code:
+
+```
+#include "kernel_float.h"
+namespace kf = kernel_float;
+
+int main() {
+  using Type = float;
+  const int N = 8;
+  static constexpr auto PI = kf::make_constant(3.14);
+
+  kf::vec<int, N> i = kf::range<int, N>();
+  kf::vec<Type, N> x = kf::cast<Type>(i) * PI;
+  kf::vec<Type, N> y = x * kf::sin(x);
+  Type result = kf::sum(y);
+  printf("result=%f", double(result));
+
+  return EXIT_SUCCESS;
+}
+```
+
+This code example uses the ``make_constant`` utility function to create `constant<T>`.

api.html

@@ -20,7 +20,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Types" href="api/types.html" />
-    <link rel="prev" title="Using kernel_float::prelude" href="guides/prelude.html" /> 
+    <link rel="prev" title="Using kernel_float::constant" href="guides/constant.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -54,8 +54,10 @@
 <li class="toctree-l2"><a class="reference internal" href="api/binary_operators.html">Binary Operators</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/reductions.html">Reductions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/mathematical.html">Mathematical</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/fast_math.html">Fast math</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/conditional.html">Conditional</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/memory_read_write.html">Memory read/write</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/utilities.html">Utilities</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
@@ -112,6 +114,7 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 </li>
 <li class="toctree-l1"><a class="reference internal" href="api/generation.html">Generation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="api/generation.html#range">range</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/generation.html#id1">range</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/generation.html#range-like">range_like</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/generation.html#each-index">each_index</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/generation.html#fill">fill</a></li>
@@ -208,6 +211,15 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <li class="toctree-l2"><a class="reference internal" href="api/mathematical.html#isnan">isnan</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="api/fast_math.html">Fast math</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/fast_math.html#fast-exp">fast_exp</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/fast_math.html#fast-log">fast_log</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/fast_math.html#fast-cos">fast_cos</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/fast_math.html#fast-sin">fast_sin</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/fast_math.html#fast-tan">fast_tan</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/fast_math.html#fast-div">fast_div</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="api/conditional.html">Conditional</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="api/conditional.html#where">where</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/conditional.html#id1">where</a></li>
@@ -227,6 +239,12 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 <li class="toctree-l2"><a class="reference internal" href="api/memory_read_write.html#aligned-ptr">aligned_ptr</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="api/utilities.html">Utilities</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/utilities.html#constant">constant</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/utilities.html#tiling">tiling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/utilities.html#kernel-float-tiling-for">KERNEL_FLOAT_TILING_FOR</a></li>
+</ul>
+</li>
 </ul>
 </div>
 </section>
@@ -235,7 +253,7 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="guides/prelude.html" class="btn btn-neutral float-left" title="Using kernel_float::prelude" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="guides/constant.html" class="btn btn-neutral float-left" title="Using kernel_float::constant" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="api/types.html" class="btn btn-neutral float-right" title="Types" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

api/binary_operators.html

@@ -77,8 +77,10 @@
 </li>
 <li class="toctree-l2"><a class="reference internal" href="reductions.html">Reductions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mathematical.html">Mathematical</a></li>
+<li class="toctree-l2"><a class="reference internal" href="fast_math.html">Fast math</a></li>
 <li class="toctree-l2"><a class="reference internal" href="conditional.html">Conditional</a></li>
 <li class="toctree-l2"><a class="reference internal" href="memory_read_write.html">Memory read/write</a></li>
+<li class="toctree-l2"><a class="reference internal" href="utilities.html">Utilities</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>

api/conditional.html

@@ -20,7 +20,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Memory read/write" href="memory_read_write.html" />
-    <link rel="prev" title="Mathematical" href="mathematical.html" /> 
+    <link rel="prev" title="Fast math" href="fast_math.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -54,13 +54,15 @@
 <li class="toctree-l2"><a class="reference internal" href="binary_operators.html">Binary Operators</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reductions.html">Reductions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mathematical.html">Mathematical</a></li>
+<li class="toctree-l2"><a class="reference internal" href="fast_math.html">Fast math</a></li>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">Conditional</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#where">where</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#id1">where</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#id2">where</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="memory_read_write.html">Memory read/write</a></li>
+<li class="toctree-l2"><a class="reference internal" href="utilities.html">Utilities</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
@@ -160,7 +162,7 @@ <h2>where<a class="headerlink" href="#id2" title="Permalink to this heading">
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="mathematical.html" class="btn btn-neutral float-left" title="Mathematical" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="fast_math.html" class="btn btn-neutral float-left" title="Fast math" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="memory_read_write.html" class="btn btn-neutral float-right" title="Memory read/write" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>