Skip to content

Commit 8b202b2

Browse files
mlloredamlloreda
committed
Updated documentation for 3.6.20181017 release
1 parent bb4ba4c commit 8b202b2

File tree

92 files changed

+13347
-1988
lines changed

Some content is hidden

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

92 files changed

+13347
-1988
lines changed

‎_modules/arrayfire/algorithm.html

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,18 @@
44

55
<html xmlns="http://www.w3.org/1999/xhtml">
66
<head>
7+
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
78
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8-
99
<title>arrayfire.algorithm &#8212; ArrayFire Python documentation</title>
10-
1110
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
1211
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
13-
<link rel="stylesheet" href="../../_static/style.css" type="text/css" />
14-
15-
<script type="text/javascript">
16-
var DOCUMENTATION_OPTIONS = {
17-
URL_ROOT: '../../',
18-
VERSION: '3.5.20170718',
19-
COLLAPSE_INDEX: false,
20-
FILE_SUFFIX: '.html',
21-
HAS_SOURCE: true,
22-
SOURCELINK_SUFFIX: '.txt'
23-
};
24-
</script>
12+
<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>
2515
<script type="text/javascript" src="../../_static/jquery.js"></script>
2616
<script type="text/javascript" src="../../_static/underscore.js"></script>
2717
<script type="text/javascript" src="../../_static/doctools.js"></script>
28-
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></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>
2919
<link rel="index" title="Index" href="../../genindex.html" />
3020
<link rel="search" title="Search" href="../../search.html" />
3121

@@ -34,8 +24,7 @@
3424

3525
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
3626

37-
</head>
38-
<body>
27+
</head><body>
3928

4029

4130
<div class="document">
@@ -622,7 +611,19 @@ <h1>Source code for arrayfire.algorithm</h1><div class="highlight"><pre>
622611
<div class="sphinxsidebarwrapper">
623612
<p class="logo"><a href="../../index.html">
624613
<img class="logo" src="../../_static/arrayfire_logo_symbol.png" alt="Logo"/>
625-
</a></p><div class="relations">
614+
</a></p>
615+
<h1 class="logo"><a href="../../index.html">ArrayFire</a></h1>
616+
617+
618+
619+
620+
621+
622+
623+
624+
<h3>Navigation</h3>
625+
626+
<div class="relations">
626627
<h3>Related Topics</h3>
627628
<ul>
628629
<li><a href="../../index.html">Documentation overview</a><ul>
@@ -633,12 +634,14 @@ <h3>Related Topics</h3>
633634
</div>
634635
<div id="searchbox" style="display: none" role="search">
635636
<h3>Quick search</h3>
637+
<div class="searchformwrapper">
636638
<form class="search" action="../../search.html" method="get">
637-
<div><input type="text" name="q" /></div>
638-
<div><input type="submit" value="Go" /></div>
639+
<input type="text" name="q" />
640+
<input type="submit" value="Go" />
639641
<input type="hidden" name="check_keywords" value="yes" />
640642
<input type="hidden" name="area" value="default" />
641643
</form>
644+
</div>
642645
</div>
643646
<script type="text/javascript">$('#searchbox').show(0);</script>
644647
</div>
@@ -649,7 +652,7 @@ <h3>Quick search</h3>
649652
&copy;2016, Pavan Yalamanchili.
650653

651654
|
652-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.2</a>
655+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.1</a>
653656
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
654657

655658
</div>

‎_modules/arrayfire/arith.html

Lines changed: 45 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,18 @@
44

55
<html xmlns="http://www.w3.org/1999/xhtml">
66
<head>
7+
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
78
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8-
99
<title>arrayfire.arith &#8212; ArrayFire Python documentation</title>
10-
1110
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
1211
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
13-
<link rel="stylesheet" href="../../_static/style.css" type="text/css" />
14-
15-
<script type="text/javascript">
16-
var DOCUMENTATION_OPTIONS = {
17-
URL_ROOT: '../../',
18-
VERSION: '3.5.20170718',
19-
COLLAPSE_INDEX: false,
20-
FILE_SUFFIX: '.html',
21-
HAS_SOURCE: true,
22-
SOURCELINK_SUFFIX: '.txt'
23-
};
24-
</script>
12+
<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>
2515
<script type="text/javascript" src="../../_static/jquery.js"></script>
2616
<script type="text/javascript" src="../../_static/underscore.js"></script>
2717
<script type="text/javascript" src="../../_static/doctools.js"></script>
28-
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></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>
2919
<link rel="index" title="Index" href="../../genindex.html" />
3020
<link rel="search" title="Search" href="../../search.html" />
3121

@@ -34,8 +24,7 @@
3424

3525
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
3626

37-
</head>
38-
<body>
27+
</head><body>
3928

4029

4130
<div class="document">
@@ -210,6 +199,26 @@ <h1>Source code for arrayfire.arith</h1><div class="highlight"><pre>
210199

211200
<span class="k">return</span> <span class="n">out</span></div>
212201

202+
<div class="viewcode-block" id="mod"><a class="viewcode-back" href="../../arrayfire.arith.html#arrayfire.arith.mod">[docs]</a><span class="k">def</span> <span class="nf">mod</span><span class="p">(</span><span class="n">lhs</span><span class="p">,</span> <span class="n">rhs</span><span class="p">):</span>
203+
<span class="sd">&quot;&quot;&quot;</span>
204+
<span class="sd"> Find the modulus.</span>
205+
<span class="sd"> Parameters</span>
206+
<span class="sd"> ----------</span>
207+
<span class="sd"> lhs : af.Array or scalar</span>
208+
<span class="sd"> Multi dimensional arrayfire array or a scalar number.</span>
209+
<span class="sd"> rhs : af.Array or scalar</span>
210+
<span class="sd"> Multi dimensional arrayfire array or a scalar number.</span>
211+
<span class="sd"> Returns</span>
212+
<span class="sd"> --------</span>
213+
<span class="sd"> out : af.Array</span>
214+
<span class="sd"> Contains the moduli after dividing each value of lhs` with those in `rhs`.</span>
215+
<span class="sd"> Note</span>
216+
<span class="sd"> -------</span>
217+
<span class="sd"> - Atleast one of `lhs` and `rhs` needs to be af.Array.</span>
218+
<span class="sd"> - If `lhs` and `rhs` are both af.Array, they must be of same size.</span>
219+
<span class="sd"> &quot;&quot;&quot;</span>
220+
<span class="k">return</span> <span class="n">_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">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_mod</span><span class="p">)</span></div>
221+
213222
<div class="viewcode-block" id="rem"><a class="viewcode-back" href="../../arrayfire.arith.html#arrayfire.arith.rem">[docs]</a><span class="k">def</span> <span class="nf">rem</span><span class="p">(</span><span class="n">lhs</span><span class="p">,</span> <span class="n">rhs</span><span class="p">):</span>
214223
<span class="sd">&quot;&quot;&quot;</span>
215224
<span class="sd"> Find the remainder.</span>
@@ -278,7 +287,7 @@ <h1>Source code for arrayfire.arith</h1><div class="highlight"><pre>
278287
<span class="sd"> Returns</span>
279288
<span class="sd"> --------</span>
280289
<span class="sd"> out : af.Array</span>
281-
<span class="sd"> array containing -1 for negative values, 1 otherwise.</span>
290+
<span class="sd"> array containing 1 for negative values, 0 otherwise.</span>
282291
<span class="sd"> &quot;&quot;&quot;</span>
283292
<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_sign</span><span class="p">)</span></div>
284293

@@ -1132,7 +1141,19 @@ <h1>Source code for arrayfire.arith</h1><div class="highlight"><pre>
11321141
<div class="sphinxsidebarwrapper">
11331142
<p class="logo"><a href="../../index.html">
11341143
<img class="logo" src="../../_static/arrayfire_logo_symbol.png" alt="Logo"/>
1135-
</a></p><div class="relations">
1144+
</a></p>
1145+
<h1 class="logo"><a href="../../index.html">ArrayFire</a></h1>
1146+
1147+
1148+
1149+
1150+
1151+
1152+
1153+
1154+
<h3>Navigation</h3>
1155+
1156+
<div class="relations">
11361157
<h3>Related Topics</h3>
11371158
<ul>
11381159
<li><a href="../../index.html">Documentation overview</a><ul>
@@ -1143,12 +1164,14 @@ <h3>Related Topics</h3>
11431164
</div>
11441165
<div id="searchbox" style="display: none" role="search">
11451166
<h3>Quick search</h3>
1167+
<div class="searchformwrapper">
11461168
<form class="search" action="../../search.html" method="get">
1147-
<div><input type="text" name="q" /></div>
1148-
<div><input type="submit" value="Go" /></div>
1169+
<input type="text" name="q" />
1170+
<input type="submit" value="Go" />
11491171
<input type="hidden" name="check_keywords" value="yes" />
11501172
<input type="hidden" name="area" value="default" />
11511173
</form>
1174+
</div>
11521175
</div>
11531176
<script type="text/javascript">$('#searchbox').show(0);</script>
11541177
</div>
@@ -1159,7 +1182,7 @@ <h3>Quick search</h3>
11591182
&copy;2016, Pavan Yalamanchili.
11601183

11611184
|
1162-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.2</a>
1185+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.1</a>
11631186
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
11641187

11651188
</div>

0 commit comments

Comments
 (0)