Skip to content

Commit a5c6635

Browse files
committed
Update docs after ArrayFire 3.3.2 release
1 parent 6af1abf commit a5c6635

File tree

3,235 files changed

+60825
-30804
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

3,235 files changed

+60825
-30804
lines changed

arrayfire/enum.AfError.html

Lines changed: 33 additions & 14 deletions
Large diffs are not rendered by default.

arrayfire/enum.Backend.html

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
1313
<link rel="stylesheet" type="text/css" href="../main.css">
14+
1415

1516
<link rel="shortcut icon" href="http://www.rust-lang.org/favicon.ico">
1617

@@ -43,10 +44,10 @@
4344

4445
<section id='main' class="content enum">
4546
<h1 class='fqn'><span class='in-band'>Enum <a href='index.html'>arrayfire</a>::<wbr><a class='enum' href=''>Backend</a></span><span class='out-of-band'><span id='render-detail'>
46-
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
47-
[<span class='inner'>&#x2212;</span>]
48-
</a>
49-
</span><a id='src-2482' class='srclink' href='../src/arrayfire/src/defines.rs.html#55-64' title='goto source code'>[src]</a></span></h1>
47+
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
48+
[<span class='inner'>&#x2212;</span>]
49+
</a>
50+
</span><a id='src-2492' class='srclink' href='../src/arrayfire/src/defines.rs.html#55-64' title='goto source code'>[src]</a></span></h1>
5051
<pre class='rust enum'>pub enum Backend {
5152
DEFAULT,
5253
CPU,
@@ -58,13 +59,24 @@ <h1 class='fqn'><span class='in-band'>Enum <a href='index.html'>arrayfire</a>::<
5859
</div></td><td></td></tr><tr><td id='variant.CPU'><code>CPU</code></td><td><div class='docblock'><p>CPU a.k.a sequential algorithms</p>
5960
</div></td><td></td></tr><tr><td id='variant.CUDA'><code>CUDA</code></td><td><div class='docblock'><p>CUDA Compute Backend</p>
6061
</div></td><td></td></tr><tr><td id='variant.OPENCL'><code>OPENCL</code></td><td><div class='docblock'><p>OpenCL Compute Backend</p>
61-
</div></td><td></td></tr></table><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html' title='core::fmt::Display'>Display</a> for <a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a></code></h3><div class='impl-items'><h4 id='method.fmt' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#method.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>, <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html' title='core::fmt::Error'>FmtError</a>&gt;</code></h4>
62-
</div><h3 id='derived_implementations'>Derived Implementations </h3><h3 class='impl'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html' title='core::cmp::PartialEq'>PartialEq</a> for <a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a></code></h3><div class='impl-items'><h4 id='method.eq' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a>) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
63-
<h4 id='method.ne' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, __arg_0: &amp;<a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a>) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
64-
</div><h3 class='impl'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a> for <a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a></code></h3><div class='impl-items'><h4 id='method.fmt-1' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#method.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -&gt; <a class='type' href='https://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title='core::fmt::Result'>Result</a></code></h4>
65-
</div><h3 class='impl'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html' title='core::marker::Copy'>Copy</a> for <a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a></code></h3><div class='impl-items'></div><h3 class='impl'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a></code></h3><div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a></code></h4>
66-
<h4 id='method.clone_from' class='method'><span class="since">1.0.0</span><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code></h4>
67-
</div></section>
62+
</div></td><td></td></tr></table><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html' title='core::fmt::Display'>Display</a> for <a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-2519' class='srclink' href='../src/arrayfire/src/defines.rs.html#66-76' title='goto source code'>[src]</a></span></h3>
63+
<div class='impl-items'><h4 id='method.fmt' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>, <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html' title='core::fmt::Error'>FmtError</a>&gt;</code></h4>
64+
<div class='docblock'><p>Formats the value using the given formatter.</p>
65+
</div></div><h3 id='derived_implementations'>Derived Implementations </h3><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html' title='core::cmp::PartialEq'>PartialEq</a> for <a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-2501' class='srclink' href='../src/arrayfire/src/defines.rs.html#54' title='goto source code'>[src]</a></span></h3>
66+
<div class='impl-items'><h4 id='method.eq' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a>) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
67+
<div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
68+
</div><h4 id='method.ne' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, other: &amp;Rhs) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></h4>
69+
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
70+
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a> for <a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-2507' class='srclink' href='../src/arrayfire/src/defines.rs.html#54' title='goto source code'>[src]</a></span></h3>
71+
<div class='impl-items'><h4 id='method.fmt-1' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -&gt; <a class='type' href='https://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title='core::fmt::Result'>Result</a></code></h4>
72+
<div class='docblock'><p>Formats the value using the given formatter.</p>
73+
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html' title='core::marker::Copy'>Copy</a> for <a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-2515' class='srclink' href='../src/arrayfire/src/defines.rs.html#54' title='goto source code'>[src]</a></span></h3>
74+
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-2516' class='srclink' href='../src/arrayfire/src/defines.rs.html#54' title='goto source code'>[src]</a></span></h3>
75+
<div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class='enum' href='../arrayfire/enum.Backend.html' title='arrayfire::Backend'>Backend</a></code></h4>
76+
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
77+
</div><h4 id='method.clone_from' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></h4>
78+
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
79+
</div></div></section>
6880
<section id='search' class="content hidden"></section>
6981

7082
<section class="footer"></section>
@@ -87,6 +99,8 @@ <h2>Keyboard Shortcuts</h2>
8799
<dd>Move down in search results</dd>
88100
<dt>&#9166;</dt>
89101
<dd>Go to active search result</dd>
102+
<dt>+</dt>
103+
<dd>Collapse/expand all sections</dd>
90104
</dl>
91105
</div>
92106

0 commit comments

Comments
 (0)