Skip to content

Commit 31e9765

Browse files
committed
Add changes for fcfd9c1
1 parent 83bc083 commit 31e9765

File tree

6 files changed

+25
-14
lines changed

6 files changed

+25
-14
lines changed

_sources/api/primitives.rst.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ make_vec
3737
--------
3838
.. doxygenfunction:: kernel_float::make_vec
3939

40-
into_vector
41-
-----------
42-
.. doxygenfunction:: kernel_float::into_vector
40+
into_vec
41+
--------
42+
.. doxygenfunction:: kernel_float::into_vec
4343

4444
concat
4545
------

api.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
103103
<li class="toctree-l2"><a class="reference internal" href="api/primitives.html#broadcast">broadcast</a></li>
104104
<li class="toctree-l2"><a class="reference internal" href="api/primitives.html#convert">convert</a></li>
105105
<li class="toctree-l2"><a class="reference internal" href="api/primitives.html#make-vec">make_vec</a></li>
106-
<li class="toctree-l2"><a class="reference internal" href="api/primitives.html#into-vector">into_vector</a></li>
106+
<li class="toctree-l2"><a class="reference internal" href="api/primitives.html#into-vec">into_vec</a></li>
107107
<li class="toctree-l2"><a class="reference internal" href="api/primitives.html#concat">concat</a></li>
108108
<li class="toctree-l2"><a class="reference internal" href="api/primitives.html#select">select</a></li>
109109
<li class="toctree-l2"><a class="reference internal" href="api/primitives.html#for-each">for_each</a></li>

api/primitives.html

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
<li class="toctree-l3"><a class="reference internal" href="#broadcast">broadcast</a></li>
5858
<li class="toctree-l3"><a class="reference internal" href="#convert">convert</a></li>
5959
<li class="toctree-l3"><a class="reference internal" href="#make-vec">make_vec</a></li>
60-
<li class="toctree-l3"><a class="reference internal" href="#into-vector">into_vector</a></li>
60+
<li class="toctree-l3"><a class="reference internal" href="#into-vec">into_vec</a></li>
6161
<li class="toctree-l3"><a class="reference internal" href="#concat">concat</a></li>
6262
<li class="toctree-l3"><a class="reference internal" href="#select">select</a></li>
6363
<li class="toctree-l3"><a class="reference internal" href="#for-each">for_each</a></li>
@@ -244,12 +244,21 @@ <h3>Example<a class="headerlink" href="#namespacekernel__float_1autotoc_md27" ti
244244
</dd></dl>
245245

246246
</section>
247-
<section id="into-vector">
248-
<h2>into_vector<a class="headerlink" href="#into-vector" title="Permalink to this heading"></a></h2>
249-
<div class="admonition warning">
250-
<p class="admonition-title">Warning</p>
251-
<p>doxygenfunction: Cannot find function “kernel_float::into_vector” in doxygen xml output for project “Kernel Launcher” from directory: ./_doxygen/xml</p>
252-
</div>
247+
<section id="into-vec">
248+
<h2>into_vec<a class="headerlink" href="#into-vec" title="Permalink to this heading"></a></h2>
249+
<dl class="cpp function">
250+
<dt class="sig sig-object cpp" id="_CPPv4I0EN12kernel_float8into_vecE16into_vector_typeI1VERR1V">
251+
<span id="_CPPv3I0EN12kernel_float8into_vecERR1V"></span><span id="_CPPv2I0EN12kernel_float8into_vecERR1V"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">V</span></span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="namespacekernel__float_1af57676243adcc9f9586f5f0da83c0642"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">into_vector_type</span></span><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="#_CPPv4I0EN12kernel_float8into_vecE16into_vector_typeI1VERR1V" title="kernel_float::into_vec::V"><span class="n"><span class="pre">V</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">kernel_float</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">into_vec</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0EN12kernel_float8into_vecE16into_vector_typeI1VERR1V" title="kernel_float::into_vec::V"><span class="n"><span class="pre">V</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">input</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0EN12kernel_float8into_vecE16into_vector_typeI1VERR1V" title="Permalink to this definition"></a><br /></dt>
252+
<dd><p>Convert the given <code class="docutils literal notranslate"><span class="pre">input</span></code> into a vector. This function can perform one of the following actions:</p>
253+
<p><ul class="simple">
254+
<li><p>For vectors <code class="docutils literal notranslate"><span class="pre">vec&lt;T,</span> <span class="pre">N&gt;</span></code>, it simply returns the original vector.</p></li>
255+
<li><p>For primitive types <code class="docutils literal notranslate"><span class="pre">T</span></code> (e.g., <code class="docutils literal notranslate"><span class="pre">int</span></code>, <code class="docutils literal notranslate"><span class="pre">float</span></code>, <code class="docutils literal notranslate"><span class="pre">double</span></code>), it returns a <code class="docutils literal notranslate"><span class="pre">vec&lt;T,</span> <span class="pre">1&gt;</span></code>.</p></li>
256+
<li><p>For array-like types (e.g., <code class="docutils literal notranslate"><span class="pre">std::array&lt;T,</span> <span class="pre">N&gt;</span></code>, <code class="docutils literal notranslate"><span class="pre">T[N]</span></code>), it returns <code class="docutils literal notranslate"><span class="pre">vec&lt;T,</span> <span class="pre">N&gt;</span></code>.</p></li>
257+
<li><p>For vector-like types (e.g., <code class="docutils literal notranslate"><span class="pre">int2</span></code>, <code class="docutils literal notranslate"><span class="pre">dim3</span></code>), it returns <code class="docutils literal notranslate"><span class="pre">vec&lt;T,</span> <span class="pre">N&gt;</span></code>. </p></li>
258+
</ul>
259+
</p>
260+
</dd></dl>
261+
253262
</section>
254263
<section id="concat">
255264
<h2>concat<a class="headerlink" href="#concat" title="Permalink to this heading"></a></h2>

genindex.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,8 @@ <h2 id="K">K</h2>
170170
<li><a href="api/binary_operators.html#_CPPv4I000EN12kernel_float5hypotE15zip_common_typeIN3ops5hypotI1CEE1L1RERR1LRR1R">kernel_float::hypot (C++ function)</a>
171171
</li>
172172
<li><a href="api/mathematical.html#_CPPv4I0EN12kernel_float5ilogbE6vectorI17vector_value_typeI1VE18vector_extent_typeI1VEERK1V">kernel_float::ilogb (C++ function)</a>
173+
</li>
174+
<li><a href="api/primitives.html#_CPPv4I0EN12kernel_float8into_vecE16into_vector_typeI1VERR1V">kernel_float::into_vec (C++ function)</a>
173175
</li>
174176
<li><a href="api/mathematical.html#_CPPv4I0EN12kernel_float5isinfE6vectorI17vector_value_typeI1VE18vector_extent_typeI1VEERK1V">kernel_float::isinf (C++ function)</a>
175177
</li>
@@ -198,11 +200,11 @@ <h2 id="K">K</h2>
198200
<li><a href="api/binary_operators.html#_CPPv4I000EN12kernel_float3minE15zip_common_typeIN3ops3minI1CEE1L1RERR1LRR1R">kernel_float::min (C++ function)</a>, <a href="api/reductions.html#_CPPv4I00EN12kernel_float3minE1TRK1V">[1]</a>
199201
</li>
200202
<li><a href="api/binary_operators.html#_CPPv4I000EN12kernel_float4modfE15zip_common_typeIN3ops4modfI1CEE1L1RERR1LRR1R">kernel_float::modf (C++ function)</a>
201-
</li>
202-
<li><a href="api/binary_operators.html#_CPPv4I000EN12kernel_float8multiplyE15zip_common_typeIN3ops8multiplyI1CEE1L1RERR1LRR1R">kernel_float::multiply (C++ function)</a>
203203
</li>
204204
</ul></td>
205205
<td style="width: 33%; vertical-align: top;"><ul>
206+
<li><a href="api/binary_operators.html#_CPPv4I000EN12kernel_float8multiplyE15zip_common_typeIN3ops8multiplyI1CEE1L1RERR1LRR1R">kernel_float::multiply (C++ function)</a>
207+
</li>
206208
<li><a href="api/mathematical.html#_CPPv4I0EN12kernel_float9nearbyintE6vectorI17vector_value_typeI1VE18vector_extent_typeI1VEERK1V">kernel_float::nearbyint (C++ function)</a>
207209
</li>
208210
<li><a href="api/unary_operators.html#_CPPv4I0EN12kernel_float6negateE6vectorI17vector_value_typeI1VE18vector_extent_typeI1VEERK1V">kernel_float::negate (C++ function)</a>

objects.inv

51 Bytes
Binary file not shown.

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)