Skip to content

Commit a5f45a7

Browse files
9prady99prady9
committed
publish: Fix documentation test in graphics module
generated from commit a5256f3
1 parent 81dce79 commit a5f45a7

File tree

10,178 files changed

+8778
-499817
lines changed

Some content is hidden

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

10,178 files changed

+8778
-499817
lines changed

‎COPYRIGHT.txt‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,6 @@ included, and carry their own copyright notices and license terms:
2727
Licensed under the SIL Open Font License, Version 1.1.
2828
See Heuristica-LICENSE.txt.
2929

30-
* jQuery (jquery-2.1.4.min.js):
31-
32-
Copyright 2005, 2015 jQuery Foundation, Inc.
33-
Licensed under the MIT license (see LICENSE-MIT.txt).
34-
3530
* rustdoc.css, main.js, and playpen.js:
3631

3732
Copyright 2015 The Rust Developers.

‎aliases.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
var ALIASES = {};
2+
ALIASES['arrayfire'] = {};

‎arrayfire/DiffusionEq.t.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=enum.DiffusionEq.html">
5+
</head>
6+
<body>
7+
<p>Redirecting to <a href="enum.DiffusionEq.html">enum.DiffusionEq.html</a>...</p>
8+
<script>location.replace("enum.DiffusionEq.html" + location.search + location.hash);</script>
9+
</body>
10+
</html>

‎arrayfire/FluxFn.t.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=enum.FluxFn.html">
5+
</head>
6+
<body>
7+
<p>Redirecting to <a href="enum.FluxFn.html">enum.FluxFn.html</a>...</p>
8+
<script>location.replace("enum.FluxFn.html" + location.search + location.hash);</script>
9+
</body>
10+
</html>

‎arrayfire/ImplicitPromote.t.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=trait.ImplicitPromote.html">
5+
</head>
6+
<body>
7+
<p>Redirecting to <a href="trait.ImplicitPromote.html">trait.ImplicitPromote.html</a>...</p>
8+
<script>location.replace("trait.ImplicitPromote.html" + location.search + location.hash);</script>
9+
</body>
10+
</html>

‎arrayfire/TopkFn.t.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=enum.TopkFn.html">
5+
</head>
6+
<body>
7+
<p>Redirecting to <a href="enum.TopkFn.html">enum.TopkFn.html</a>...</p>
8+
<script>location.replace("enum.TopkFn.html" + location.search + location.hash);</script>
9+
</body>
10+
</html>

‎arrayfire/all.html‎

Lines changed: 7 additions & 0 deletions
Large diffs are not rendered by default.

‎arrayfire/anisotropic_diffusion.v.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=fn.anisotropic_diffusion.html">
5+
</head>
6+
<body>
7+
<p>Redirecting to <a href="fn.anisotropic_diffusion.html">fn.anisotropic_diffusion.html</a>...</p>
8+
<script>location.replace("fn.anisotropic_diffusion.html" + location.search + location.hash);</script>
9+
</body>
10+
</html>

‎arrayfire/array_and_matrix_manipulation.html‎

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
<h1 class="title">Array and Matrix Manipulation</h1>
2626
<p>ArrayFire provides several different methods for manipulating arrays and matrices.
2727
The functionality includes:</p>
28-
2928
<ul>
3029
<li><a href="#moddims">moddims()</a> - change the dimensions of an array without changing the data</li>
3130
<li><a href="#flat">flat()</a> - flatten an array to one dimension</li>
@@ -36,10 +35,8 @@ <h1 class="title">Array and Matrix Manipulation</h1>
3635
<li><a href="#tile">tile()</a> - repeats an array along a dimension</li>
3736
<li><a href="#transpose">transpose()</a> - performs a matrix transpose</li>
3837
</ul>
39-
4038
<p>Below we provide several examples of these functions and their use.</p>
41-
42-
<h3 id='moddims' class='section-header'><a href='#moddims'>moddims()</a></h3>
39+
<h3 id="moddims" class="section-header"><a href="#moddims">moddims()</a></h3>
4340
<p>The <a href="./fn.moddims.html">moddims</a> function changes the dimensions of an array without
4441
changing its data or order. Note that this function modifies only the <em>metadata</em>
4542
associated with the array. It does not modify the content of the array.
@@ -73,8 +70,7 @@ <h3 id='moddims' class='section-header'><a href='#moddims'>moddims()</a></h3>
7370
<span class="number">2.0000</span>
7471
<span class="number">1.0000</span>
7572
<span class="number">2.0000</span></pre>
76-
77-
<h3 id='flat' class='section-header'><a href='#flat'>flat()</a></h3>
73+
<h3 id="flat" class="section-header"><a href="#flat">flat()</a></h3>
7874
<p>The <a href="./fn.flat.html">flat</a> function flattens an array to one dimension:</p>
7975

8076
<pre class="rust rust-example-rendered">
@@ -94,8 +90,7 @@ <h3 id='flat' class='section-header'><a href='#flat'>flat()</a></h3>
9490
<span class="number">7.0000</span>
9591
<span class="number">8.0000</span>
9692
<span class="number">9.0000</span></pre>
97-
98-
<h3 id='flip' class='section-header'><a href='#flip'>flip()</a></h3>
93+
<h3 id="flip" class="section-header"><a href="#flip">flip()</a></h3>
9994
<p>The <a href="./fn.flip.html">flip</a> function flips the contents of an array along a
10095
chosen dimension. In the example below, we show the 5x2 array flipped
10196
along the zeroth (i.e. within a column) and first (e.g. across rows) axes:</p>
@@ -121,11 +116,9 @@ <h3 id='flip' class='section-header'><a href='#flip'>flip()</a></h3>
121116
<span class="number">8.0000</span> <span class="number">3.0000</span>
122117
<span class="number">9.0000</span> <span class="number">4.0000</span>
123118
<span class="number">10.0000</span> <span class="number">5.0000</span></pre>
124-
125-
<h3 id='join' class='section-header'><a href='#join'>join()</a></h3>
119+
<h3 id="join" class="section-header"><a href="#join">join()</a></h3>
126120
<p>The <a href="./fn.join.html">join</a>, <a href="./fn.join_many.html">join_many</a> functions can be
127121
used to join arrays along a specific dimension.</p>
128-
129122
<p>Here is an example of how to use join an array to itself:</p>
130123

131124
<pre class="rust rust-example-rendered">
@@ -154,8 +147,7 @@ <h3 id='join' class='section-header'><a href='#join'>join()</a></h3>
154147
<span class="number">3.0000</span> <span class="number">3.0000</span>
155148
<span class="number">4.0000</span> <span class="number">4.0000</span>
156149
<span class="number">5.0000</span> <span class="number">5.0000</span></pre>
157-
158-
<h3 id='reorder' class='section-header'><a href='#reorder'>reorder()</a></h3>
150+
<h3 id="reorder" class="section-header"><a href="#reorder">reorder()</a></h3>
159151
<p>The <a href="./fn.reorder.html">reorder</a> function modifies the order of data within an array by
160152
exchanging data according to the change in dimensionality. The linear ordering
161153
of data within the array is preserved.</p>
@@ -193,8 +185,7 @@ <h3 id='reorder' class='section-header'><a href='#reorder'>reorder()</a></h3>
193185
<span class="number">3.0000</span> <span class="number">4.0000</span>
194186
<span class="number">3.0000</span> <span class="number">4.0000</span>
195187
<span class="number">3.0000</span> <span class="number">4.0000</span></pre>
196-
197-
<h3 id='shift' class='section-header'><a href='#shift'>shift()</a></h3>
188+
<h3 id="shift" class="section-header"><a href="#shift">shift()</a></h3>
198189
<p>The <a href="./fn.shift.html">shift</a> function shifts data in a circular buffer fashion along a
199190
chosen dimension. Consider the following example:</p>
200191

@@ -215,8 +206,7 @@ <h3 id='shift' class='section-header'><a href='#shift'>shift()</a></h3>
215206
<span class="number">1.0000</span> <span class="number">2.0000</span> <span class="number">3.0000</span> <span class="number">4.0000</span> <span class="number">5.0000</span>
216207
<span class="number">1.0000</span> <span class="number">2.0000</span> <span class="number">3.0000</span> <span class="number">4.0000</span> <span class="number">5.0000</span>
217208
<span class="number">0.0000</span> <span class="number">0.0000</span> <span class="number">0.0000</span> <span class="number">0.0000</span> <span class="number">0.0000</span></pre>
218-
219-
<h3 id='tile' class='section-header'><a href='#tile'>tile()</a></h3>
209+
<h3 id="tile" class="section-header"><a href="#tile">tile()</a></h3>
220210
<p>The <a href="./fn.tile.html">tile</a> function repeats an array along the specified dimension.
221211
For example below we show how to tile an array along the zeroth and first
222212
dimensions of an array:</p>
@@ -262,8 +252,7 @@ <h3 id='tile' class='section-header'><a href='#tile'>tile()</a></h3>
262252
<span class="number">1.0000</span> <span class="number">1.0000</span>
263253
<span class="number">2.0000</span> <span class="number">2.0000</span>
264254
<span class="number">3.0000</span> <span class="number">3.0000</span></pre>
265-
266-
<h3 id='transpose' class='section-header'><a href='#transpose'>transpose()</a></h3>
255+
<h3 id="transpose" class="section-header"><a href="#transpose">transpose()</a></h3>
267256
<p>The <a href="./fn.transpose.html">transpose</a> function performs a standard matrix transpose. The input
268257
array must have the dimensions of a 2D-matrix.</p>
269258

‎arrayfire/configuring_arrayfire_environment.html‎

Lines changed: 16 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -41,142 +41,107 @@ <h1 class="title">Configuring Arrayfire Environment</h1>
4141
<li><a href="#af_cuda_max_jit_len">15 AF_CUDA_MAX_JIT_LEN</a><ul></ul></li>
4242
<li><a href="#af_cpu_max_jit_len">16 AF_CPU_MAX_JIT_LEN</a><ul></ul></li></ul></nav><p>Following are the list of environment and runtime configurations that will help enhance
4343
your experience with ArrayFire.</p>
44-
45-
<h1 id='af_path' class='section-header'><a href='#af_path'>1 AF_PATH</a></h1>
44+
<h1 id="af_path" class="section-header"><a href="#af_path">1 AF_PATH</a></h1>
4645
<p>This is the path with ArrayFire gets installed, ie. the includes and libs are
4746
present in this directory. You can use this variable to add include paths and
4847
libraries to your projects.</p>
49-
50-
<h1 id='af_print_errors' class='section-header'><a href='#af_print_errors'>2 AF_PRINT_ERRORS</a></h1>
48+
<h1 id="af_print_errors" class="section-header"><a href="#af_print_errors">2 AF_PRINT_ERRORS</a></h1>
5149
<p>When AF_PRINT_ERRORS is set to 1, the exceptions thrown are more verbose and
5250
detailed. This helps in locating the exact failure.</p>
5351

5452
<pre class="rust rust-example-rendered">
5553
<span class="ident">AF_PRINT_ERRORS</span><span class="op">=</span><span class="number">1</span> .<span class="op">/</span><span class="ident">myprogram</span></pre>
56-
57-
<h1 id='af_cuda_default_device' class='section-header'><a href='#af_cuda_default_device'>3 AF_CUDA_DEFAULT_DEVICE</a></h1>
54+
<h1 id="af_cuda_default_device" class="section-header"><a href="#af_cuda_default_device">3 AF_CUDA_DEFAULT_DEVICE</a></h1>
5855
<p>Use this variable to set the default CUDA device. Valid values for this
5956
variable are the device identifiers shown when <a href="./fn.info.html">af::info</a> is run.</p>
6057

6158
<pre class="rust rust-example-rendered">
6259
<span class="ident">AF_CUDA_DEFAULT_DEVICE</span><span class="op">=</span><span class="number">1</span> .<span class="op">/</span><span class="ident">myprogram</span></pre>
63-
6460
<p>Note: af::setDevice call in the source code will take precedence over this
6561
variable.</p>
66-
67-
<h1 id='af_opencl_default_device' class='section-header'><a href='#af_opencl_default_device'>4 AF_OPENCL_DEFAULT_DEVICE</a></h1>
62+
<h1 id="af_opencl_default_device" class="section-header"><a href="#af_opencl_default_device">4 AF_OPENCL_DEFAULT_DEVICE</a></h1>
6863
<p>Use this variable to set the default OpenCL device. Valid values for this
6964
variable are the device identifiers shown when <a href="./fn.info.html">af::info</a> is run.</p>
7065

7166
<pre class="rust rust-example-rendered">
7267
<span class="ident">AF_OPENCL_DEFAULT_DEVICE</span><span class="op">=</span><span class="number">1</span> .<span class="op">/</span><span class="ident">myprogram</span></pre>
73-
7468
<p>Note: <a href="./fn.set_device.html">af::set_device</a> call in the source code will take precedence over this
7569
variable.</p>
76-
77-
<h1 id='af_opencl_default_device_type' class='section-header'><a href='#af_opencl_default_device_type'>5 AF_OPENCL_DEFAULT_DEVICE_TYPE</a></h1>
70+
<h1 id="af_opencl_default_device_type" class="section-header"><a href="#af_opencl_default_device_type">5 AF_OPENCL_DEFAULT_DEVICE_TYPE</a></h1>
7871
<p>Use this variable to set the default OpenCL device type. Valid values for this
7972
variable are: CPU, GPU, ACC (Accelerators).</p>
80-
8173
<p>When set, the first device of the specified type is chosen as default device.</p>
8274

8375
<pre class="rust rust-example-rendered">
8476
<span class="ident">AF_OPENCL_DEFAULT_DEVICE_TYPE</span><span class="op">=</span><span class="ident">CPU</span> .<span class="op">/</span><span class="ident">myprogram</span></pre>
85-
8677
<p>Note: <code>AF_OPENCL_DEFAULT_DEVICE</code> and <a href="./fn.set_device.html">af::set_device</a> takes precedence over this variable.</p>
87-
88-
<h1 id='af_opencl_device_type' class='section-header'><a href='#af_opencl_device_type'>6 AF_OPENCL_DEVICE_TYPE</a></h1>
78+
<h1 id="af_opencl_device_type" class="section-header"><a href="#af_opencl_device_type">6 AF_OPENCL_DEVICE_TYPE</a></h1>
8979
<p>Use this variable to only choose OpenCL devices of specified type. Valid values for this
9080
variable are:</p>
91-
9281
<ul>
9382
<li>ALL: All OpenCL devices. (Default behavior).</li>
9483
<li>CPU: CPU devices only.</li>
9584
<li>GPU: GPU devices only.</li>
9685
<li>ACC: Accelerator devices only.</li>
9786
</ul>
98-
9987
<p>When set, the remaining OpenCL device types are ignored by the OpenCL backend.</p>
10088

10189
<pre class="rust rust-example-rendered">
10290
<span class="ident">AF_OPENCL_DEVICE_TYPE</span><span class="op">=</span><span class="ident">CPU</span> .<span class="op">/</span><span class="ident">myprogram</span></pre>
103-
104-
<h1 id='af_opencl_cpu_offload' class='section-header'><a href='#af_opencl_cpu_offload'>7 AF_OPENCL_CPU_OFFLOAD</a></h1>
91+
<h1 id="af_opencl_cpu_offload" class="section-header"><a href="#af_opencl_cpu_offload">7 AF_OPENCL_CPU_OFFLOAD</a></h1>
10592
<p>When ArrayFire runs on devices with unified memory with the host (ie.
10693
<code>CL_DEVICE_HOST_UNIFIED_MENORY</code> is true for the device) then certain functions
10794
are offloaded to run on the CPU using mapped buffers.</p>
108-
10995
<p>ArrayFire takes advantage of fast libraries such as MKL while spending no time
11096
copying memory from device to host. The device memory is mapped to a host
11197
pointer which can be used in the offloaded functions.</p>
112-
11398
<p>This functionality can be disabled by using the environment variable
11499
<code>AF_OPENCL_CPU_OFFLOAD=0</code>.</p>
115-
116100
<p>The default bevaior of this has changed in version 3.4.</p>
117-
118101
<p>Prior to v3.4, CPU Offload functionality was used only when the user set
119102
<code>AF_OPENCL_CPU_OFFLOAD=1</code> and disabled otherwise.</p>
120-
121103
<p>From v3.4 onwards, CPU Offload is enabled by default and is disabled only when
122104
<code>AF_OPENCL_CPU_OFFLOAD=0</code> is set.</p>
123-
124-
<h1 id='af_opencl_show_build_info' class='section-header'><a href='#af_opencl_show_build_info'>8 AF_OPENCL_SHOW_BUILD_INFO</a></h1>
105+
<h1 id="af_opencl_show_build_info" class="section-header"><a href="#af_opencl_show_build_info">8 AF_OPENCL_SHOW_BUILD_INFO</a></h1>
125106
<p>This variable is useful when debuggin OpenCL kernel compilation failures. When
126107
this variable is set to 1, and an error occurs during a OpenCL kernel
127108
compilation, then the log and kernel are printed to screen.</p>
128-
129-
<h1 id='af_disable_graphics' class='section-header'><a href='#af_disable_graphics'>9 AF_DISABLE_GRAPHICS</a></h1>
109+
<h1 id="af_disable_graphics" class="section-header"><a href="#af_disable_graphics">9 AF_DISABLE_GRAPHICS</a></h1>
130110
<p>Setting this variable to 1 will disable window creation when graphics
131111
functions are being called. Disabling window creation will disable all other
132112
graphics calls at runtime as well.</p>
133-
134113
<p>This is a useful enviornment variable when running code on servers and systems
135114
without displays. When graphics calls are run on such machines, they will
136115
print warning about window creation failing. To suppress those calls, set this
137116
variable.</p>
138-
139-
<h1 id='af_synchronous_calls' class='section-header'><a href='#af_synchronous_calls'>10 AF_SYNCHRONOUS_CALLS</a></h1>
117+
<h1 id="af_synchronous_calls" class="section-header"><a href="#af_synchronous_calls">10 AF_SYNCHRONOUS_CALLS</a></h1>
140118
<p>When this environment variable is set to 1, ArrayFire will execute all
141119
functions synchronously.</p>
142-
143-
<h1 id='af_show_load_path' class='section-header'><a href='#af_show_load_path'>11 AF_SHOW_LOAD_PATH</a></h1>
120+
<h1 id="af_show_load_path" class="section-header"><a href="#af_show_load_path">11 AF_SHOW_LOAD_PATH</a></h1>
144121
<p>When using the Unified backend, if this variable is set to 1, it will show the
145122
path where the ArrayFire backend libraries are loaded from.</p>
146-
147123
<p>If the libraries are loaded from system paths, such as PATH or LD_LIBRARY_PATH
148124
etc, then it will print &quot;system path&quot;. If the libraries are loaded from other
149125
paths, then those paths are shown in full.</p>
150-
151-
<h1 id='af_mem_debug' class='section-header'><a href='#af_mem_debug'>12 AF_MEM_DEBUG</a></h1>
126+
<h1 id="af_mem_debug" class="section-header"><a href="#af_mem_debug">12 AF_MEM_DEBUG</a></h1>
152127
<p>When AF_MEM_DEBUG is set to 1 (or anything not equal to 0), the caching mechanism in the memory manager is disabled.
153128
The device buffers are allocated using native functions as needed and freed when going out of scope.</p>
154-
155129
<p>When the environment variable is not set, it is treated to be non zero.</p>
156130

157131
<pre class="rust rust-example-rendered">
158132
<span class="ident">AF_MEM_DEBUG</span><span class="op">=</span><span class="number">1</span> .<span class="op">/</span><span class="ident">myprogram</span></pre>
159-
160-
<h1 id='af_max_buffers' class='section-header'><a href='#af_max_buffers'>13 AF_MAX_BUFFERS</a></h1>
133+
<h1 id="af_max_buffers" class="section-header"><a href="#af_max_buffers">13 AF_MAX_BUFFERS</a></h1>
161134
<p>When AF_MAX_BUFFERS is set, this environment variable specifies the maximum number of buffers allocated before garbage collection kicks in.</p>
162-
163135
<p>Please note that the total number of buffers that can exist simultaneously can be higher than this number. This variable tells the garbage collector that it should free any available buffers immediately if the treshold is reached.</p>
164-
165136
<p>When not set, the default value is 1000.</p>
166-
167-
<h1 id='af_opencl_max_jit_len' class='section-header'><a href='#af_opencl_max_jit_len'>14 AF_OPENCL_MAX_JIT_LEN</a></h1>
137+
<h1 id="af_opencl_max_jit_len" class="section-header"><a href="#af_opencl_max_jit_len">14 AF_OPENCL_MAX_JIT_LEN</a></h1>
168138
<p>When set, this environment variable specifies the maximum height of the OpenCL JIT tree after which evaluation is forced.</p>
169-
170139
<p>The default value, as of v3.4, is 50 on OSX, 100 everywhere else. This value was 20 for older versions.</p>
171-
172-
<h1 id='af_cuda_max_jit_len' class='section-header'><a href='#af_cuda_max_jit_len'>15 AF_CUDA_MAX_JIT_LEN</a></h1>
140+
<h1 id="af_cuda_max_jit_len" class="section-header"><a href="#af_cuda_max_jit_len">15 AF_CUDA_MAX_JIT_LEN</a></h1>
173141
<p>When set, this environment variable specifies the maximum height of the CUDA JIT tree after which evaluation is forced.</p>
174-
175142
<p>The default value, as of v3.4, 100. This value was 20 for older versions.</p>
176-
177-
<h1 id='af_cpu_max_jit_len' class='section-header'><a href='#af_cpu_max_jit_len'>16 AF_CPU_MAX_JIT_LEN</a></h1>
143+
<h1 id="af_cpu_max_jit_len" class="section-header"><a href="#af_cpu_max_jit_len">16 AF_CPU_MAX_JIT_LEN</a></h1>
178144
<p>When set, this environment variable specifies the maximum length of the CPU JIT tree after which evaluation is forced.</p>
179-
180145
<p>The default value, as of v3.4, 100. This value was 20 for older versions.</p>
181146

182147

0 commit comments

Comments
 (0)