Skip to content

Commit 6bfa149

Browse files
9prady99prady9
committed
Updated docs after ArrayFire 3.2 release
1 parent da46417 commit 6bfa149

File tree

4,271 files changed

+108743
-64379
lines changed

Some content is hidden

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

4,271 files changed

+108743
-64379
lines changed

‎arrayfire/backend/fn.get_available_backends.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta http-equiv="refresh" content="0;URL=../../arrayfire/fn.get_available_backends.html">
5+
</head>
6+
<body>
7+
<p>Redirecting to <a href="../../arrayfire/fn.get_available_backends.html">../../arrayfire/fn.get_available_backends.html</a>...</p>
8+
<script>location.replace("../../arrayfire/fn.get_available_backends.html" + location.search + location.hash);</script>
9+
</body>
10+
</html>

‎arrayfire/backend/fn.get_backend_count.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta http-equiv="refresh" content="0;URL=../../arrayfire/fn.get_backend_count.html">
5+
</head>
6+
<body>
7+
<p>Redirecting to <a href="../../arrayfire/fn.get_backend_count.html">../../arrayfire/fn.get_backend_count.html</a>...</p>
8+
<script>location.replace("../../arrayfire/fn.get_backend_count.html" + location.search + location.hash);</script>
9+
</body>
10+
</html>

‎arrayfire/backend/fn.set_backend.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta http-equiv="refresh" content="0;URL=../../arrayfire/fn.set_backend.html">
5+
</head>
6+
<body>
7+
<p>Redirecting to <a href="../../arrayfire/fn.set_backend.html">../../arrayfire/fn.set_backend.html</a>...</p>
8+
<script>location.replace("../../arrayfire/fn.set_backend.html" + location.search + location.hash);</script>
9+
</body>
10+
</html>

‎arrayfire/backend/index.html

Whitespace-only changes.

‎arrayfire/backend/sidebar-items.js

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

‎arrayfire/defines/enum.Backend.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta http-equiv="refresh" content="0;URL=../../arrayfire/enum.Backend.html">
5+
</head>
6+
<body>
7+
<p>Redirecting to <a href="../../arrayfire/enum.Backend.html">../../arrayfire/enum.Backend.html</a>...</p>
8+
<script>location.replace("../../arrayfire/enum.Backend.html" + location.search + location.hash);</script>
9+
</body>
10+
</html>

‎arrayfire/defines/enum.HomographyType.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta http-equiv="refresh" content="0;URL=../../arrayfire/enum.HomographyType.html">
5+
</head>
6+
<body>
7+
<p>Redirecting to <a href="../../arrayfire/enum.HomographyType.html">../../arrayfire/enum.HomographyType.html</a>...</p>
8+
<script>location.replace("../../arrayfire/enum.HomographyType.html" + location.search + location.hash);</script>
9+
</body>
10+
</html>

‎arrayfire/defines/sidebar-items.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.

‎arrayfire/device/sidebar-items.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.

‎arrayfire/enum.AfError.html

Lines changed: 53 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,17 @@
2424

2525

2626

27-
<section class="sidebar">
27+
<nav class="sidebar">
2828
<a href='../arrayfire/index.html'><img src='http://www.arrayfire.com/logos/arrayfire_logo_symbol.png' alt='' width='100'></a>
2929
<p class='location'><a href='index.html'>arrayfire</a></p><script>window.sidebarCurrent = {name: 'AfError', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script>
30-
</section>
30+
</nav>
3131

3232
<nav class="sub">
3333
<form class="search-form js-only">
3434
<div class="search-container">
3535
<input class="search-input" name="search"
3636
autocomplete="off"
37-
placeholder="Click or press 'S' to search, '?' for more options..."
37+
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
3838
type="search">
3939
</div>
4040
</form>
@@ -45,7 +45,7 @@ <h1 class='fqn'><span class='in-band'>Enum <a href='index.html'>arrayfire</a>::<
4545
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
4646
[<span class='inner'>&#x2212;</span>]
4747
</a>
48-
</span><a id='src-16853' class='srclink' href='../src/arrayfire/defines.rs.html#8-48' title='goto source code'>[src]</a></span></h1>
48+
</span><a id='src-16912' class='srclink' href='../src/arrayfire/defines.rs.html#8-48' title='goto source code'>[src]</a></span></h1>
4949
<pre class='rust enum'>pub enum AfError {
5050
SUCCESS,
5151
ERR_NO_MEM,
@@ -83,52 +83,61 @@ <h1 class='fqn'><span class='in-band'>Enum <a href='index.html'>arrayfire</a>::<
8383
</div></td></tr><tr><td id='variant.ERR_INTERNAL'><code>ERR_INTERNAL</code></td><td><div class='docblock'><p>There was an internal error either in ArrayFire or in a project
8484
upstream</p>
8585
</div></td></tr><tr><td id='variant.ERR_UNKNOWN'><code>ERR_UNKNOWN</code></td><td><div class='docblock'><p>Unknown Error</p>
86-
</div></td></tr></table><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/fmt/trait.Display.html' title='core::fmt::Display'>Display</a> for <a class='enum' href='../arrayfire/enum.AfError.html' title='arrayfire::AfError'>AfError</a></code></h3><div class='impl-items'><h4 id='method.fmt' class='method'><code>fn <a href='http://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='http://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -&gt; <a class='enum' href='http://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>, <a class='struct' href='http://doc.rust-lang.org/nightly/core/fmt/struct.Error.html' title='core::fmt::Error'>FmtError</a>&gt;</code></h4>
87-
</div><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/std/error/trait.Error.html' title='std::error::Error'>Error</a> for <a class='enum' href='../arrayfire/enum.AfError.html' title='arrayfire::AfError'>AfError</a></code></h3><div class='impl-items'><h4 id='method.description' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.description' class='fnname'>description</a>(&amp;self) -&gt; &amp;<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a></code></h4>
88-
<h4 id='method.cause' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.cause' class='fnname'>cause</a>(&amp;self) -&gt; <a class='enum' href='http://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;&amp;<a class='trait' href='http://doc.rust-lang.org/nightly/std/error/trait.Error.html' title='std::error::Error'>Error</a>&gt;</code></h4>
89-
</div><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/convert/trait.From.html' title='core::convert::From'>From</a>&lt;<a href='http://doc.rust-lang.org/nightly/std/primitive.i32.html'>i32</a>&gt; for <a class='enum' href='../arrayfire/enum.AfError.html' title='arrayfire::AfError'>AfError</a></code></h3><div class='impl-items'><h4 id='method.from' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/core/convert/trait.From.html#method.from' class='fnname'>from</a>(t: <a href='http://doc.rust-lang.org/nightly/std/primitive.i32.html'>i32</a>) -&gt; <a class='enum' href='../arrayfire/enum.AfError.html' title='arrayfire::AfError'>AfError</a></code></h4>
90-
</div><h3 id='derived_implementations'>Derived Implementations </h3><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a> for <a class='enum' href='../arrayfire/enum.AfError.html' title='arrayfire::AfError'>AfError</a></code></h3><div class='impl-items'><h4 id='method.fmt' class='method'><code>fn <a href='http://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='http://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -&gt; <a class='type' href='http://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title='core::fmt::Result'>Result</a></code></h4>
91-
</div><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/marker/trait.Copy.html' title='core::marker::Copy'>Copy</a> for <a class='enum' href='../arrayfire/enum.AfError.html' title='arrayfire::AfError'>AfError</a></code></h3><div class='impl-items'></div><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='enum' href='../arrayfire/enum.AfError.html' title='arrayfire::AfError'>AfError</a></code></h3><div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='http://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.AfError.html' title='arrayfire::AfError'>AfError</a></code></h4>
92-
<h4 id='method.clone_from' class='method'><code>fn <a href='http://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>
86+
</div></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.AfError.html' title='arrayfire::AfError'>AfError</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 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>
87+
</div><h3 class='impl'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/std/error/trait.Error.html' title='std::error::Error'>Error</a> for <a class='enum' href='../arrayfire/enum.AfError.html' title='arrayfire::AfError'>AfError</a></code></h3><div class='impl-items'><h4 id='method.description' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.description' class='fnname'>description</a>(&amp;self) -&gt; &amp;<a href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a></code></h4>
88+
<h4 id='method.cause' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.cause' class='fnname'>cause</a>(&amp;self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;&amp;<a class='trait' href='https://doc.rust-lang.org/nightly/std/error/trait.Error.html' title='std::error::Error'>Error</a>&gt;</code></h4>
89+
</div><h3 class='impl'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html' title='core::convert::From'>From</a>&lt;<a href='https://doc.rust-lang.org/nightly/std/primitive.i32.html'>i32</a>&gt; for <a class='enum' href='../arrayfire/enum.AfError.html' title='arrayfire::AfError'>AfError</a></code></h3><div class='impl-items'><h4 id='method.from' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#method.from' class='fnname'>from</a>(t: <a href='https://doc.rust-lang.org/nightly/std/primitive.i32.html'>i32</a>) -&gt; <a class='enum' href='../arrayfire/enum.AfError.html' title='arrayfire::AfError'>AfError</a></code></h4>
90+
</div><h3 id='derived_implementations'>Derived Implementations </h3><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.AfError.html' title='arrayfire::AfError'>AfError</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.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>
91+
</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.AfError.html' title='arrayfire::AfError'>AfError</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.AfError.html' title='arrayfire::AfError'>AfError</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.AfError.html' title='arrayfire::AfError'>AfError</a></code></h4>
92+
<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></h4>
9393
</div></section>
9494
<section id='search' class="content hidden"></section>
9595

9696
<section class="footer"></section>
9797

98-
<div id="help" class="hidden">
99-
<div class="shortcuts">
100-
<h1>Keyboard shortcuts</h1>
101-
<dl>
102-
<dt>?</dt>
103-
<dd>Show this help dialog</dd>
104-
<dt>S</dt>
105-
<dd>Focus the search field</dd>
106-
<dt>&larrb;</dt>
107-
<dd>Move up in search results</dd>
108-
<dt>&rarrb;</dt>
109-
<dd>Move down in search results</dd>
110-
<dt>&#9166;</dt>
111-
<dd>Go to active search result</dd>
112-
</dl>
113-
</div>
114-
<div class="infos">
115-
<h1>Search tricks</h1>
116-
<p>
117-
Prefix searches with a type followed by a colon (e.g.
118-
<code>fn:</code>) to restrict the search to a given type.
119-
</p>
120-
<p>
121-
Accepted types are: <code>fn</code>, <code>mod</code>,
122-
<code>struct</code>, <code>enum</code>,
123-
<code>trait</code>, <code>typedef</code> (or
124-
<code>tdef</code>).
125-
</p>
126-
<p>
127-
Search functions by type signature (e.g.
128-
<code>vec -> usize</code>)
129-
</p>
98+
<aside id="help" class="hidden">
99+
<div>
100+
<h1 class="hidden">Help</h1>
101+
102+
<div class="shortcuts">
103+
<h2>Keyboard Shortcuts</h2>
104+
105+
<dl>
106+
<dt>?</dt>
107+
<dd>Show this help dialog</dd>
108+
<dt>S</dt>
109+
<dd>Focus the search field</dd>
110+
<dt>&larrb;</dt>
111+
<dd>Move up in search results</dd>
112+
<dt>&rarrb;</dt>
113+
<dd>Move down in search results</dd>
114+
<dt>&#9166;</dt>
115+
<dd>Go to active search result</dd>
116+
</dl>
117+
</div>
118+
119+
<div class="infos">
120+
<h2>Search Tricks</h2>
121+
122+
<p>
123+
Prefix searches with a type followed by a colon (e.g.
124+
<code>fn:</code>) to restrict the search to a given type.
125+
</p>
126+
127+
<p>
128+
Accepted types are: <code>fn</code>, <code>mod</code>,
129+
<code>struct</code>, <code>enum</code>,
130+
<code>trait</code>, <code>type</code>, <code>macro</code>,
131+
and <code>const</code>.
132+
</p>
133+
134+
<p>
135+
Search functions by type signature (e.g.
136+
<code>vec -> usize</code>)
137+
</p>
138+
</div>
130139
</div>
131-
</div>
140+
</aside>
132141

133142

134143

0 commit comments

Comments
 (0)