Skip to content

Commit 50bdc06

Browse files
9prady99prady9
committed
Merge pull request #39 from 9prady9/gh-pages
Documentation for ArrayFire 3.0 compliant API
2 parents 8007355 + 448c652 commit 50bdc06

File tree

1,334 files changed

+74438
-3861
lines changed

Some content is hidden

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

1,334 files changed

+74438
-3861
lines changed

‎arrayfire/algorithm/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/array/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/blas/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/data/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/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/dim4/sidebar-items.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
initSidebarItems({"struct":[["Dim4",""]]});
1+
initSidebarItems({"struct":[["Dim4","Dim4 is used to store Array dimensions"]]});

‎arrayfire/enum.AfError.html‎

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

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

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

1616
</head>
1717
<body class="rustdoc">
@@ -25,7 +25,7 @@
2525

2626

2727
<section class="sidebar">
28-
28+
<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>
3030
</section>
3131

@@ -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-15499' class='srclink' href='../src/arrayfire/defines.rs.html#7-79' title='goto source code'>[src]</a></span></h1>
48+
</span><a id='src-15687' 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,
@@ -63,7 +63,8 @@ <h1 class='fqn'><span class='in-band'>Enum <a href='index.html'>arrayfire</a>::<
6363
ERR_NO_GFX,
6464
ERR_INTERNAL,
6565
ERR_UNKNOWN,
66-
}</pre><h2 class='variants'>Variants</h2>
66+
}</pre><div class='docblock'><p>Error codes</p>
67+
</div><h2 class='variants'>Variants</h2>
6768
<table><tr><td id='variant.SUCCESS'><code>SUCCESS</code></td><td><div class='docblock'><p>The function returned successfully</p>
6869
</div></td></tr><tr><td id='variant.ERR_NO_MEM'><code>ERR_NO_MEM</code></td><td><div class='docblock'><p>The system or device ran out of memory</p>
6970
</div></td></tr><tr><td id='variant.ERR_DRIVER'><code>ERR_DRIVER</code></td><td><div class='docblock'><p>There was an error in the device driver</p>

‎arrayfire/enum.Aftype.html‎

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

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

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

1616
</head>
1717
<body class="rustdoc">
@@ -25,7 +25,7 @@
2525

2626

2727
<section class="sidebar">
28-
28+
<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: 'Aftype', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script>
3030
</section>
3131

@@ -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-15844' class='srclink' href='../src/arrayfire/defines.rs.html#111-122' title='goto source code'>[src]</a></span></h1>
48+
</span><a id='src-16032' class='srclink' href='../src/arrayfire/defines.rs.html#81-102' title='goto source code'>[src]</a></span></h1>
4949
<pre class='rust enum'>pub enum Aftype {
5050
F32,
5151
C32,
@@ -57,8 +57,19 @@ <h1 class='fqn'><span class='in-band'>Enum <a href='index.html'>arrayfire</a>::<
5757
U8,
5858
S64,
5959
U64,
60-
}</pre><h2 class='variants'>Variants</h2>
61-
<table><tr><td id='variant.F32'><code>F32</code></td><td></td></tr><tr><td id='variant.C32'><code>C32</code></td><td></td></tr><tr><td id='variant.F64'><code>F64</code></td><td></td></tr><tr><td id='variant.C64'><code>C64</code></td><td></td></tr><tr><td id='variant.B8'><code>B8</code></td><td></td></tr><tr><td id='variant.S32'><code>S32</code></td><td></td></tr><tr><td id='variant.U32'><code>U32</code></td><td></td></tr><tr><td id='variant.U8'><code>U8</code></td><td></td></tr><tr><td id='variant.S64'><code>S64</code></td><td></td></tr><tr><td id='variant.U64'><code>U64</code></td><td></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/convert/trait.From.html' title='core::convert::From'>From</a>&lt;<a href='http://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a>&gt; for <a class='enum' href='../arrayfire/enum.Aftype.html' title='arrayfire::Aftype'>Aftype</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.u8.html'>u8</a>) -&gt; <a class='enum' href='../arrayfire/enum.Aftype.html' title='arrayfire::Aftype'>Aftype</a></code></h4>
60+
}</pre><div class='docblock'><p>Types of Array data type</p>
61+
</div><h2 class='variants'>Variants</h2>
62+
<table><tr><td id='variant.F32'><code>F32</code></td><td><div class='docblock'><p>32 bit float</p>
63+
</div></td></tr><tr><td id='variant.C32'><code>C32</code></td><td><div class='docblock'><p>32 bit complex float</p>
64+
</div></td></tr><tr><td id='variant.F64'><code>F64</code></td><td><div class='docblock'><p>64 bit float</p>
65+
</div></td></tr><tr><td id='variant.C64'><code>C64</code></td><td><div class='docblock'><p>64 bit complex float</p>
66+
</div></td></tr><tr><td id='variant.B8'><code>B8</code></td><td><div class='docblock'><p>8 bit boolean</p>
67+
</div></td></tr><tr><td id='variant.S32'><code>S32</code></td><td><div class='docblock'><p>32 bit signed integer</p>
68+
</div></td></tr><tr><td id='variant.U32'><code>U32</code></td><td><div class='docblock'><p>32 bit unsigned integer</p>
69+
</div></td></tr><tr><td id='variant.U8'><code>U8</code></td><td><div class='docblock'><p>8 bit unsigned integer</p>
70+
</div></td></tr><tr><td id='variant.S64'><code>S64</code></td><td><div class='docblock'><p>64 bit signed integer</p>
71+
</div></td></tr><tr><td id='variant.U64'><code>U64</code></td><td><div class='docblock'><p>64 bit unsigned integer</p>
72+
</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/convert/trait.From.html' title='core::convert::From'>From</a>&lt;<a href='http://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a>&gt; for <a class='enum' href='../arrayfire/enum.Aftype.html' title='arrayfire::Aftype'>Aftype</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.u8.html'>u8</a>) -&gt; <a class='enum' href='../arrayfire/enum.Aftype.html' title='arrayfire::Aftype'>Aftype</a></code></h4>
6273
</div><h3 id='derived_implementations'>Derived Implementations </h3><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.Aftype.html' title='arrayfire::Aftype'>Aftype</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.Aftype.html' title='arrayfire::Aftype'>Aftype</a></code></h4>
6374
<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>
6475
</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.Aftype.html' title='arrayfire::Aftype'>Aftype</a></code></h3><div class='impl-items'></div></section>

‎arrayfire/enum.BorderType.html‎

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

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

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

1616
</head>
1717
<body class="rustdoc">
@@ -25,7 +25,7 @@
2525

2626

2727
<section class="sidebar">
28-
28+
<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: 'BorderType', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script>
3030
</section>
3131

@@ -45,12 +45,15 @@ <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-15972' class='srclink' href='../src/arrayfire/defines.rs.html#133-136' title='goto source code'>[src]</a></span></h1>
48+
</span><a id='src-16160' class='srclink' href='../src/arrayfire/defines.rs.html#119-124' title='goto source code'>[src]</a></span></h1>
4949
<pre class='rust enum'>pub enum BorderType {
5050
ZERO,
5151
SYMMETRIC,
52-
}</pre><h2 class='variants'>Variants</h2>
53-
<table><tr><td id='variant.ZERO'><code>ZERO</code></td><td></td></tr><tr><td id='variant.SYMMETRIC'><code>SYMMETRIC</code></td><td></td></tr></table><h2 id='implementations'>Trait Implementations</h2><h3 id='derived_implementations'>Derived Implementations </h3><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.BorderType.html' title='arrayfire::BorderType'>BorderType</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.BorderType.html' title='arrayfire::BorderType'>BorderType</a></code></h4>
52+
}</pre><div class='docblock'><p>Helps determine how to pad kernels along borders</p>
53+
</div><h2 class='variants'>Variants</h2>
54+
<table><tr><td id='variant.ZERO'><code>ZERO</code></td><td><div class='docblock'><p>Pad using zeros</p>
55+
</div></td></tr><tr><td id='variant.SYMMETRIC'><code>SYMMETRIC</code></td><td><div class='docblock'><p>Pad using mirrored values along border</p>
56+
</div></td></tr></table><h2 id='implementations'>Trait Implementations</h2><h3 id='derived_implementations'>Derived Implementations </h3><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.BorderType.html' title='arrayfire::BorderType'>BorderType</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.BorderType.html' title='arrayfire::BorderType'>BorderType</a></code></h4>
5457
<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>
5558
</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.BorderType.html' title='arrayfire::BorderType'>BorderType</a></code></h3><div class='impl-items'></div></section>
5659
<section id='search' class="content hidden"></section>

0 commit comments

Comments
 (0)