Skip to content

Commit bb4ba4c

Browse files
pavankypavanky
committed
Updating documentation
1 parent e2679d8 commit bb4ba4c

Some content is hidden

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

75 files changed

+13272
-3414
lines changed

‎_modules/arrayfire/algorithm.html

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1+
12
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
23
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
34

4-
55
<html xmlns="http://www.w3.org/1999/xhtml">
66
<head>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
@@ -15,26 +15,27 @@
1515
<script type="text/javascript">
1616
var DOCUMENTATION_OPTIONS = {
1717
URL_ROOT: '../../',
18-
VERSION: '3.4.20160925',
18+
VERSION: '3.5.20170718',
1919
COLLAPSE_INDEX: false,
2020
FILE_SUFFIX: '.html',
21-
HAS_SOURCE: true
21+
HAS_SOURCE: true,
22+
SOURCELINK_SUFFIX: '.txt'
2223
};
2324
</script>
2425
<script type="text/javascript" src="../../_static/jquery.js"></script>
2526
<script type="text/javascript" src="../../_static/underscore.js"></script>
2627
<script type="text/javascript" src="../../_static/doctools.js"></script>
27-
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
28-
<link rel="top" title="ArrayFire Python documentation" href="../../index.html" />
29-
<link rel="up" title="Module code" href="../index.html" />
28+
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
29+
<link rel="index" title="Index" href="../../genindex.html" />
30+
<link rel="search" title="Search" href="../../search.html" />
3031

3132
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
3233

3334

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

3637
</head>
37-
<body role="document">
38+
<body>
3839

3940

4041
<div class="document">
@@ -518,35 +519,35 @@ <h1>Source code for arrayfire.algorithm</h1><div class="highlight"><pre>
518519
<span class="n">c_uint_t</span><span class="p">(</span><span class="n">dim</span><span class="p">),</span> <span class="n">c_bool_t</span><span class="p">(</span><span class="n">is_ascending</span><span class="p">)))</span>
519520
<span class="k">return</span> <span class="n">out</span><span class="p">,</span><span class="n">idx</span></div>
520521

521-
<div class="viewcode-block" id="sort_by_key"><a class="viewcode-back" href="../../arrayfire.algorithm.html#arrayfire.algorithm.sort_by_key">[docs]</a><span class="k">def</span> <span class="nf">sort_by_key</span><span class="p">(</span><span class="n">iv</span><span class="p">,</span> <span class="n">ik</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">is_ascending</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
522+
<div class="viewcode-block" id="sort_by_key"><a class="viewcode-back" href="../../arrayfire.algorithm.html#arrayfire.algorithm.sort_by_key">[docs]</a><span class="k">def</span> <span class="nf">sort_by_key</span><span class="p">(</span><span class="n">ik</span><span class="p">,</span> <span class="n">iv</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">is_ascending</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
522523
<span class="sd">&quot;&quot;&quot;</span>
523524
<span class="sd"> Sort an array based on specified keys</span>
524525

525526
<span class="sd"> Parameters</span>
526527
<span class="sd"> ----------</span>
527-
<span class="sd"> iv : af.Array</span>
528-
<span class="sd"> An Array containing the values</span>
529528
<span class="sd"> ik : af.Array</span>
530529
<span class="sd"> An Array containing the keys</span>
530+
<span class="sd"> iv : af.Array</span>
531+
<span class="sd"> An Array containing the values</span>
531532
<span class="sd"> dim: optional: int. default: 0</span>
532533
<span class="sd"> Dimension along which sort is to be performed.</span>
533534
<span class="sd"> is_ascending: optional: bool. default: True</span>
534535
<span class="sd"> Specifies the direction of the sort</span>
535536

536537
<span class="sd"> Returns</span>
537538
<span class="sd"> -------</span>
538-
<span class="sd"> (ov, ok): tuple of af.Array</span>
539-
<span class="sd"> `ov` contains the values from `iv` after sorting them based on `ik`</span>
539+
<span class="sd"> (ok, ov): tuple of af.Array</span>
540540
<span class="sd"> `ok` contains the values from `ik` in sorted order</span>
541+
<span class="sd"> `ov` contains the values from `iv` after sorting them based on `ik`</span>
541542

542543
<span class="sd"> Note</span>
543544
<span class="sd"> -------</span>
544545
<span class="sd"> Currently `dim` is only supported for 0.</span>
545546
<span class="sd"> &quot;&quot;&quot;</span>
546547
<span class="n">ov</span> <span class="o">=</span> <span class="n">Array</span><span class="p">()</span>
547548
<span class="n">ok</span> <span class="o">=</span> <span class="n">Array</span><span class="p">()</span>
548-
<span class="n">safe_call</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_sort_by_key</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="n">ov</span><span class="o">.</span><span class="n">arr</span><span class="p">),</span> <span class="n">c_pointer</span><span class="p">(</span><span class="n">ok</span><span class="o">.</span><span class="n">arr</span><span class="p">),</span>
549-
<span class="n">iv</span><span class="o">.</span><span class="n">arr</span><span class="p">,</span> <span class="n">ik</span><span class="o">.</span><span class="n">arr</span><span class="p">,</span> <span class="n">c_uint_t</span><span class="p">(</span><span class="n">dim</span><span class="p">),</span> <span class="n">c_bool_t</span><span class="p">(</span><span class="n">is_ascending</span><span class="p">)))</span>
549+
<span class="n">safe_call</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_sort_by_key</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="n">ok</span><span class="o">.</span><span class="n">arr</span><span class="p">),</span> <span class="n">c_pointer</span><span class="p">(</span><span class="n">ov</span><span class="o">.</span><span class="n">arr</span><span class="p">),</span>
550+
<span class="n">ik</span><span class="o">.</span><span class="n">arr</span><span class="p">,</span> <span class="n">iv</span><span class="o">.</span><span class="n">arr</span><span class="p">,</span> <span class="n">c_uint_t</span><span class="p">(</span><span class="n">dim</span><span class="p">),</span> <span class="n">c_bool_t</span><span class="p">(</span><span class="n">is_ascending</span><span class="p">)))</span>
550551
<span class="k">return</span> <span class="n">ov</span><span class="p">,</span><span class="n">ok</span></div>
551552

552553
<div class="viewcode-block" id="set_unique"><a class="viewcode-back" href="../../arrayfire.algorithm.html#arrayfire.algorithm.set_unique">[docs]</a><span class="k">def</span> <span class="nf">set_unique</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">is_sorted</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
@@ -648,8 +649,8 @@ <h3>Quick search</h3>
648649
&copy;2016, Pavan Yalamanchili.
649650

650651
|
651-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.6</a>
652-
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
652+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.2</a>
653+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
653654

654655
</div>
655656

‎_modules/arrayfire/arith.html

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1+
12
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
23
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
34

4-
55
<html xmlns="http://www.w3.org/1999/xhtml">
66
<head>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
@@ -15,26 +15,27 @@
1515
<script type="text/javascript">
1616
var DOCUMENTATION_OPTIONS = {
1717
URL_ROOT: '../../',
18-
VERSION: '3.4.20160925',
18+
VERSION: '3.5.20170718',
1919
COLLAPSE_INDEX: false,
2020
FILE_SUFFIX: '.html',
21-
HAS_SOURCE: true
21+
HAS_SOURCE: true,
22+
SOURCELINK_SUFFIX: '.txt'
2223
};
2324
</script>
2425
<script type="text/javascript" src="../../_static/jquery.js"></script>
2526
<script type="text/javascript" src="../../_static/underscore.js"></script>
2627
<script type="text/javascript" src="../../_static/doctools.js"></script>
27-
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
28-
<link rel="top" title="ArrayFire Python documentation" href="../../index.html" />
29-
<link rel="up" title="Module code" href="../index.html" />
28+
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
29+
<link rel="index" title="Index" href="../../genindex.html" />
30+
<link rel="search" title="Search" href="../../search.html" />
3031

3132
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
3233

3334

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

3637
</head>
37-
<body role="document">
38+
<body>
3839

3940

4041
<div class="document">
@@ -1158,8 +1159,8 @@ <h3>Quick search</h3>
11581159
&copy;2016, Pavan Yalamanchili.
11591160

11601161
|
1161-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.6</a>
1162-
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
1162+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.2</a>
1163+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
11631164

11641165
</div>
11651166

0 commit comments

Comments
 (0)