Skip to content

Commit b94c2f7

Browse files
syurkevi9prady9
syurkevi
authored and
9prady9
committed
update documentation to v3.8
1 parent 8b202b2 commit b94c2f7

Some content is hidden

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

69 files changed

+24257
-10643
lines changed

‎_modules/arrayfire/algorithm.html

Lines changed: 219 additions & 22 deletions
Large diffs are not rendered by default.

‎_modules/arrayfire/arith.html

Lines changed: 51 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11

2-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<!DOCTYPE html>
43

5-
<html xmlns="http://www.w3.org/1999/xhtml">
4+
<html>
65
<head>
7-
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
98
<title>arrayfire.arith &#8212; ArrayFire Python documentation</title>
10-
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
119
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
10+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
1211
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css" />
13-
<link rel="stylesheet" type="text/css" href="../../_static/style.css" />
14-
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
15-
<script type="text/javascript" src="../../_static/jquery.js"></script>
16-
<script type="text/javascript" src="../../_static/underscore.js"></script>
17-
<script type="text/javascript" src="../../_static/doctools.js"></script>
18-
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
12+
<link rel="stylesheet" href="../../_static/style.css" type="text/css" />
13+
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
14+
<script src="../../_static/jquery.js"></script>
15+
<script src="../../_static/underscore.js"></script>
16+
<script src="../../_static/doctools.js"></script>
1917
<link rel="index" title="Index" href="../../genindex.html" />
2018
<link rel="search" title="Search" href="../../search.html" />
2119

@@ -30,6 +28,8 @@
3028
<div class="document">
3129
<div class="documentwrapper">
3230
<div class="bodywrapper">
31+
32+
3333
<div class="body" role="main">
3434

3535
<h1>Source code for arrayfire.arith</h1><div class="highlight"><pre>
@@ -46,10 +46,10 @@ <h1>Source code for arrayfire.arith</h1><div class="highlight"><pre>
4646
<span class="sd">Math functions (sin, sqrt, exp, etc).</span>
4747
<span class="sd">&quot;&quot;&quot;</span>
4848

49-
<span class="kn">from</span> <span class="nn">.library</span> <span class="k">import</span> <span class="o">*</span>
50-
<span class="kn">from</span> <span class="nn">.array</span> <span class="k">import</span> <span class="o">*</span>
51-
<span class="kn">from</span> <span class="nn">.bcast</span> <span class="k">import</span> <span class="n">_bcast_var</span>
52-
<span class="kn">from</span> <span class="nn">.util</span> <span class="k">import</span> <span class="n">_is_number</span>
49+
<span class="kn">from</span> <span class="nn">.library</span> <span class="kn">import</span> <span class="o">*</span>
50+
<span class="kn">from</span> <span class="nn">.array</span> <span class="kn">import</span> <span class="o">*</span>
51+
<span class="kn">from</span> <span class="nn">.bcast</span> <span class="kn">import</span> <span class="n">_bcast_var</span>
52+
<span class="kn">from</span> <span class="nn">.util</span> <span class="kn">import</span> <span class="n">_is_number</span>
5353

5454
<span class="k">def</span> <span class="nf">_arith_binary_func</span><span class="p">(</span><span class="n">lhs</span><span class="p">,</span> <span class="n">rhs</span><span class="p">,</span> <span class="n">c_func</span><span class="p">):</span>
5555
<span class="n">out</span> <span class="o">=</span> <span class="n">Array</span><span class="p">()</span>
@@ -993,6 +993,26 @@ <h1>Source code for arrayfire.arith</h1><div class="highlight"><pre>
993993
<span class="sd"> &quot;&quot;&quot;</span>
994994
<span class="k">return</span> <span class="n">_arith_unary_func</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_sqrt</span><span class="p">)</span></div>
995995

996+
<div class="viewcode-block" id="rsqrt"><a class="viewcode-back" href="../../arrayfire.arith.html#arrayfire.arith.rsqrt">[docs]</a><span class="k">def</span> <span class="nf">rsqrt</span><span class="p">(</span><span class="n">a</span><span class="p">):</span>
997+
<span class="sd">&quot;&quot;&quot;</span>
998+
<span class="sd"> Reciprocal or inverse square root of each element in the array.</span>
999+
1000+
<span class="sd"> Parameters</span>
1001+
<span class="sd"> ----------</span>
1002+
<span class="sd"> a : af.Array</span>
1003+
<span class="sd"> Multi dimensional arrayfire array.</span>
1004+
1005+
<span class="sd"> Returns</span>
1006+
<span class="sd"> --------</span>
1007+
<span class="sd"> out : af.Array</span>
1008+
<span class="sd"> array containing the inverse square root of each value from `a`.</span>
1009+
1010+
<span class="sd"> Note</span>
1011+
<span class="sd"> -------</span>
1012+
<span class="sd"> `a` must not be complex.</span>
1013+
<span class="sd"> &quot;&quot;&quot;</span>
1014+
<span class="k">return</span> <span class="n">_arith_unary_func</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_rsqrt</span><span class="p">)</span></div>
1015+
9961016
<div class="viewcode-block" id="cbrt"><a class="viewcode-back" href="../../arrayfire.arith.html#arrayfire.arith.cbrt">[docs]</a><span class="k">def</span> <span class="nf">cbrt</span><span class="p">(</span><span class="n">a</span><span class="p">):</span>
9971017
<span class="sd">&quot;&quot;&quot;</span>
9981018
<span class="sd"> Cube root of each element in the array.</span>
@@ -1135,6 +1155,7 @@ <h1>Source code for arrayfire.arith</h1><div class="highlight"><pre>
11351155
</pre></div>
11361156

11371157
</div>
1158+
11381159
</div>
11391160
</div>
11401161
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
@@ -1163,27 +1184,33 @@ <h3>Related Topics</h3>
11631184
</ul>
11641185
</div>
11651186
<div id="searchbox" style="display: none" role="search">
1166-
<h3>Quick search</h3>
1187+
<h3 id="searchlabel">Quick search</h3>
11671188
<div class="searchformwrapper">
11681189
<form class="search" action="../../search.html" method="get">
1169-
<input type="text" name="q" />
1190+
<input type="text" name="q" aria-labelledby="searchlabel" />
11701191
<input type="submit" value="Go" />
1171-
<input type="hidden" name="check_keywords" value="yes" />
1172-
<input type="hidden" name="area" value="default" />
11731192
</form>
11741193
</div>
11751194
</div>
1176-
<script type="text/javascript">$('#searchbox').show(0);</script>
1195+
<script>$('#searchbox').show(0);</script>
1196+
1197+
1198+
1199+
1200+
1201+
1202+
1203+
11771204
</div>
11781205
</div>
11791206
<div class="clearer"></div>
11801207
</div>
11811208
<div class="footer">
1182-
&copy;2016, Pavan Yalamanchili.
1209+
&copy;2020, ArrayFire.
11831210

11841211
|
1185-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.1</a>
1186-
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
1212+
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.1</a>
1213+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
11871214

11881215
</div>
11891216

0 commit comments

Comments
 (0)