Skip to content

Commit 4041867

Browse files
committed
Add changes for 933c1b9
1 parent 294aba7 commit 4041867

File tree

4 files changed

+8
-20
lines changed

4 files changed

+8
-20
lines changed

api/memory_read_write.html

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -202,20 +202,10 @@ <h2>write_aligned<a class="headerlink" href="#write-aligned" title="Permalink to
202202
</section>
203203
<section id="assert-aligned">
204204
<h2>assert_aligned<a class="headerlink" href="#assert-aligned" title="Permalink to this heading"></a></h2>
205-
<dl class="cpp function">
206-
<dt class="sig sig-object cpp" id="_CPPv4I_6size_t0EN12kernel_float14assert_alignedE10vector_ptrI1T1NEP1T">
207-
<span id="_CPPv3I_6size_t0EN12kernel_float14assert_alignedEP1T"></span><span id="_CPPv2I_6size_t0EN12kernel_float14assert_alignedEP1T"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">N</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </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">T</span></span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="namespacekernel__float_1a77b856664e3bfe42f673eb3d2bcef1ae"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0_6size_t0_6size_tEN12kernel_float10vector_ptrE" title="kernel_float::vector_ptr"><span class="n"><span class="pre">vector_ptr</span></span></a><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="#_CPPv4I_6size_t0EN12kernel_float14assert_alignedE10vector_ptrI1T1NEP1T" title="kernel_float::assert_aligned::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I_6size_t0EN12kernel_float14assert_alignedE10vector_ptrI1T1NEP1T" title="kernel_float::assert_aligned::N"><span class="n"><span class="pre">N</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">assert_aligned</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I_6size_t0EN12kernel_float14assert_alignedE10vector_ptrI1T1NEP1T" title="kernel_float::assert_aligned::T"><span class="n"><span class="pre">T</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">ptr</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I_6size_t0EN12kernel_float14assert_alignedE10vector_ptrI1T1NEP1T" title="Permalink to this definition"></a><br /></dt>
208-
<dd><p>Creates a <code class="docutils literal notranslate"><a class="reference internal" href="#structkernel__float_1_1vector__ptr"><span class="std std-ref"><span class="pre">vector_ptr</span></span></a><span class="pre">&lt;T,</span> <span class="pre">N&gt;</span></code> from a raw pointer <code class="docutils literal notranslate"><span class="pre">T*</span></code> by asserting a specific alignment <code class="docutils literal notranslate"><span class="pre">N</span></code>.</p>
209-
<dl class="field-list simple">
210-
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
211-
<dd class="field-odd"><ul class="simple">
212-
<li><p><strong>N</strong> – The alignment constraint for the <a class="reference internal" href="#structkernel__float_1_1vector__ptr"><span class="std std-ref">vector_ptr</span></a>. </p></li>
213-
<li><p><strong>T</strong> – The type of the elements pointed to by the raw pointer. </p></li>
214-
</ul>
215-
</dd>
216-
</dl>
217-
</dd></dl>
218-
205+
<div class="admonition warning">
206+
<p class="admonition-title">Warning</p>
207+
<p>doxygenfunction: Cannot find function “kernel_float::assert_aligned” in doxygen xml output for project “Kernel Launcher” from directory: ./_doxygen/xml</p>
208+
</div>
219209
</section>
220210
<section id="vector-ptr">
221211
<h2>vector_ptr<a class="headerlink" href="#vector-ptr" title="Permalink to this heading"></a></h2>
@@ -256,8 +246,8 @@ <h2>vector_ptr<a class="headerlink" href="#vector-ptr" title="Permalink to this
256246
</dd></dl>
257247

258248
<dl class="cpp function">
259-
<dt class="sig sig-object cpp" id="_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail19alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E">
260-
<span id="_CPPv3I0_6size_t_6size_t_11enable_if_tIFN6detail19alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E"></span><span id="_CPPv2I0_6size_t_6size_t_11enable_if_tIFN6detail19alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E"></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">T2</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">N2</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">A2</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">enable_if_t</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">alignment_divisible</span></span><span class="p"><span class="pre">(</span></span><a class="reference internal" href="#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail19alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E" title="kernel_float::vector_ptr::vector_ptr::A2"><span class="n"><span class="pre">A2</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0_6size_t0_6size_tEN12kernel_float10vector_ptrE" title="kernel_float::vector_ptr::Alignment"><span class="n"><span class="pre">Alignment</span></span></a><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="structkernel__float_1_1vector__ptr_1abf8d2d9082972d8f02ab3512a7256d21"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">vector_ptr</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail19alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E" title="kernel_float::vector_ptr::vector_ptr"><span class="n"><span class="pre">vector_ptr</span></span></a><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail19alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E" title="kernel_float::vector_ptr::vector_ptr::T2"><span class="n"><span class="pre">T2</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail19alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E" title="kernel_float::vector_ptr::vector_ptr::N2"><span class="n"><span class="pre">N2</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0_6size_t0_6size_tEN12kernel_float10vector_ptrE" title="kernel_float::vector_ptr::U"><span class="n"><span class="pre">U</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail19alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E" title="kernel_float::vector_ptr::vector_ptr::A2"><span class="n"><span class="pre">A2</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">p</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail19alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E" title="Permalink to this definition"></a><br /></dt>
249+
<dt class="sig sig-object cpp" id="_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail22is_alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E">
250+
<span id="_CPPv3I0_6size_t_6size_t_11enable_if_tIFN6detail22is_alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E"></span><span id="_CPPv2I0_6size_t_6size_t_11enable_if_tIFN6detail22is_alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E"></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">T2</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">N2</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">A2</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">enable_if_t</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_alignment_divisible</span></span><span class="p"><span class="pre">(</span></span><a class="reference internal" href="#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail22is_alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E" title="kernel_float::vector_ptr::vector_ptr::A2"><span class="n"><span class="pre">A2</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0_6size_t0_6size_tEN12kernel_float10vector_ptrE" title="kernel_float::vector_ptr::Alignment"><span class="n"><span class="pre">Alignment</span></span></a><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="structkernel__float_1_1vector__ptr_1abf8d2d9082972d8f02ab3512a7256d21"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">vector_ptr</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail22is_alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E" title="kernel_float::vector_ptr::vector_ptr"><span class="n"><span class="pre">vector_ptr</span></span></a><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail22is_alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E" title="kernel_float::vector_ptr::vector_ptr::T2"><span class="n"><span class="pre">T2</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail22is_alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E" title="kernel_float::vector_ptr::vector_ptr::N2"><span class="n"><span class="pre">N2</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0_6size_t0_6size_tEN12kernel_float10vector_ptrE" title="kernel_float::vector_ptr::U"><span class="n"><span class="pre">U</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail22is_alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E" title="kernel_float::vector_ptr::vector_ptr::A2"><span class="n"><span class="pre">A2</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">p</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail22is_alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E" title="Permalink to this definition"></a><br /></dt>
261251
<dd><p>Constructs a <a class="reference internal" href="#structkernel__float_1_1vector__ptr"><span class="std std-ref">vector_ptr</span></a> from another <a class="reference internal" href="#structkernel__float_1_1vector__ptr"><span class="std std-ref">vector_ptr</span></a> with potentially different alignment and type. This constructor only allows conversion if the alignment of the source is greater than or equal to the alignment of the target. </p>
262252
</dd></dl>
263253

genindex.html

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,6 @@ <h2 id="K">K</h2>
9696
<li><a href="api/mathematical.html#_CPPv4I00EN12kernel_float4asinE6vectorI17vector_value_typeI1VE18vector_extent_typeI1VEERK1V">kernel_float::asin (C++ function)</a>
9797
</li>
9898
<li><a href="api/mathematical.html#_CPPv4I00EN12kernel_float5asinhE6vectorI17vector_value_typeI1VE18vector_extent_typeI1VEERK1V">kernel_float::asinh (C++ function)</a>
99-
</li>
100-
<li><a href="api/memory_read_write.html#_CPPv4I_6size_t0EN12kernel_float14assert_alignedE10vector_ptrI1T1NEP1T">kernel_float::assert_aligned (C++ function)</a>
10199
</li>
102100
<li><a href="api/mathematical.html#_CPPv4I00EN12kernel_float4atanE6vectorI17vector_value_typeI1VE18vector_extent_typeI1VEERK1V">kernel_float::atan (C++ function)</a>
103101
</li>
@@ -375,7 +373,7 @@ <h2 id="K">K</h2>
375373
</li>
376374
<li><a href="api/memory_read_write.html#_CPPv4I_6size_tENK12kernel_float10vector_ptr4readE6vectorI10value_type6extentI1KEE6size_t">kernel_float::vector_ptr::read (C++ function)</a>
377375
</li>
378-
<li><a href="api/memory_read_write.html#_CPPv4I0_11enable_if_tIXeq9Alignmentat1VEiEEN12kernel_float10vector_ptr10vector_ptrE12pointer_type">kernel_float::vector_ptr::vector_ptr (C++ function)</a>, <a href="api/memory_read_write.html#_CPPv4I0_11enable_if_tIXne9Alignmentat1VEiEEN12kernel_float10vector_ptr10vector_ptrE12pointer_type">[1]</a>, <a href="api/memory_read_write.html#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail19alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E">[2]</a>, <a href="api/memory_read_write.html#_CPPv4N12kernel_float10vector_ptr10vector_ptrEv">[3]</a>
376+
<li><a href="api/memory_read_write.html#_CPPv4I0_11enable_if_tIXeq9Alignmentat1VEiEEN12kernel_float10vector_ptr10vector_ptrE12pointer_type">kernel_float::vector_ptr::vector_ptr (C++ function)</a>, <a href="api/memory_read_write.html#_CPPv4I0_11enable_if_tIXne9Alignmentat1VEiEEN12kernel_float10vector_ptr10vector_ptrE12pointer_type">[1]</a>, <a href="api/memory_read_write.html#_CPPv4I0_6size_t_6size_t_11enable_if_tIFN6detail22is_alignment_divisibleE2A29AlignmentEiEEN12kernel_float10vector_ptr10vector_ptrE10vector_ptrI2T22N21U2A2E">[2]</a>, <a href="api/memory_read_write.html#_CPPv4N12kernel_float10vector_ptr10vector_ptrEv">[3]</a>
379377
</li>
380378
<li><a href="api/memory_read_write.html#_CPPv4I_6size_t0ENK12kernel_float10vector_ptr5writeEv6size_tRK1V">kernel_float::vector_ptr::write (C++ function)</a>
381379
</li>

objects.inv

-86 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)