Skip to content

Commit 81dce79

Browse files
9prady99prady9
committed
publish: Merge pull request #159 from arrayfire/devel
generated from commit 289e9dc
1 parent 7681579 commit 81dce79

File tree

3,353 files changed

+74799
-56926
lines changed

Some content is hidden

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

3,353 files changed

+74799
-56926
lines changed

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

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

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

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

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

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

‎arrayfire/array_and_matrix_manipulation.html

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

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

‎arrayfire/configuring_arrayfire_environment.html

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<meta name="generator" content="rustdoc">
7+
<title>Configuring Arrayfire Environment</title>
8+
9+
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
10+
<link rel="stylesheet" type="text/css" href="../main.css">
11+
<link rel="stylesheet" type="text/css" href="../normalize.css">
12+
<link rel="stylesheet" type="text/css" href="../external_docs.css">
13+
14+
15+
</head>
16+
<body class="rustdoc">
17+
<!--[if lte IE 8]>
18+
<div class="warning">
19+
This old browser is unsupported and will most likely display funky
20+
things.
21+
</div>
22+
<![endif]-->
23+
24+
25+
<h1 class="title">Configuring Arrayfire Environment</h1>
26+
<nav id="TOC"><ul>
27+
<li><a href="#af_path">1 AF_PATH</a><ul></ul></li>
28+
<li><a href="#af_print_errors">2 AF_PRINT_ERRORS</a><ul></ul></li>
29+
<li><a href="#af_cuda_default_device">3 AF_CUDA_DEFAULT_DEVICE</a><ul></ul></li>
30+
<li><a href="#af_opencl_default_device">4 AF_OPENCL_DEFAULT_DEVICE</a><ul></ul></li>
31+
<li><a href="#af_opencl_default_device_type">5 AF_OPENCL_DEFAULT_DEVICE_TYPE</a><ul></ul></li>
32+
<li><a href="#af_opencl_device_type">6 AF_OPENCL_DEVICE_TYPE</a><ul></ul></li>
33+
<li><a href="#af_opencl_cpu_offload">7 AF_OPENCL_CPU_OFFLOAD</a><ul></ul></li>
34+
<li><a href="#af_opencl_show_build_info">8 AF_OPENCL_SHOW_BUILD_INFO</a><ul></ul></li>
35+
<li><a href="#af_disable_graphics">9 AF_DISABLE_GRAPHICS</a><ul></ul></li>
36+
<li><a href="#af_synchronous_calls">10 AF_SYNCHRONOUS_CALLS</a><ul></ul></li>
37+
<li><a href="#af_show_load_path">11 AF_SHOW_LOAD_PATH</a><ul></ul></li>
38+
<li><a href="#af_mem_debug">12 AF_MEM_DEBUG</a><ul></ul></li>
39+
<li><a href="#af_max_buffers">13 AF_MAX_BUFFERS</a><ul></ul></li>
40+
<li><a href="#af_opencl_max_jit_len">14 AF_OPENCL_MAX_JIT_LEN</a><ul></ul></li>
41+
<li><a href="#af_cuda_max_jit_len">15 AF_CUDA_MAX_JIT_LEN</a><ul></ul></li>
42+
<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
43+
your experience with ArrayFire.</p>
44+
45+
<h1 id='af_path' class='section-header'><a href='#af_path'>1 AF_PATH</a></h1>
46+
<p>This is the path with ArrayFire gets installed, ie. the includes and libs are
47+
present in this directory. You can use this variable to add include paths and
48+
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>
51+
<p>When AF_PRINT_ERRORS is set to 1, the exceptions thrown are more verbose and
52+
detailed. This helps in locating the exact failure.</p>
53+
54+
<pre class="rust rust-example-rendered">
55+
<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>
58+
<p>Use this variable to set the default CUDA device. Valid values for this
59+
variable are the device identifiers shown when <a href="./fn.info.html">af::info</a> is run.</p>
60+
61+
<pre class="rust rust-example-rendered">
62+
<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+
64+
<p>Note: af::setDevice call in the source code will take precedence over this
65+
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>
68+
<p>Use this variable to set the default OpenCL device. Valid values for this
69+
variable are the device identifiers shown when <a href="./fn.info.html">af::info</a> is run.</p>
70+
71+
<pre class="rust rust-example-rendered">
72+
<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+
74+
<p>Note: <a href="./fn.set_device.html">af::set_device</a> call in the source code will take precedence over this
75+
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>
78+
<p>Use this variable to set the default OpenCL device type. Valid values for this
79+
variable are: CPU, GPU, ACC (Accelerators).</p>
80+
81+
<p>When set, the first device of the specified type is chosen as default device.</p>
82+
83+
<pre class="rust rust-example-rendered">
84+
<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+
86+
<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>
89+
<p>Use this variable to only choose OpenCL devices of specified type. Valid values for this
90+
variable are:</p>
91+
92+
<ul>
93+
<li>ALL: All OpenCL devices. (Default behavior).</li>
94+
<li>CPU: CPU devices only.</li>
95+
<li>GPU: GPU devices only.</li>
96+
<li>ACC: Accelerator devices only.</li>
97+
</ul>
98+
99+
<p>When set, the remaining OpenCL device types are ignored by the OpenCL backend.</p>
100+
101+
<pre class="rust rust-example-rendered">
102+
<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>
105+
<p>When ArrayFire runs on devices with unified memory with the host (ie.
106+
<code>CL_DEVICE_HOST_UNIFIED_MENORY</code> is true for the device) then certain functions
107+
are offloaded to run on the CPU using mapped buffers.</p>
108+
109+
<p>ArrayFire takes advantage of fast libraries such as MKL while spending no time
110+
copying memory from device to host. The device memory is mapped to a host
111+
pointer which can be used in the offloaded functions.</p>
112+
113+
<p>This functionality can be disabled by using the environment variable
114+
<code>AF_OPENCL_CPU_OFFLOAD=0</code>.</p>
115+
116+
<p>The default bevaior of this has changed in version 3.4.</p>
117+
118+
<p>Prior to v3.4, CPU Offload functionality was used only when the user set
119+
<code>AF_OPENCL_CPU_OFFLOAD=1</code> and disabled otherwise.</p>
120+
121+
<p>From v3.4 onwards, CPU Offload is enabled by default and is disabled only when
122+
<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>
125+
<p>This variable is useful when debuggin OpenCL kernel compilation failures. When
126+
this variable is set to 1, and an error occurs during a OpenCL kernel
127+
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>
130+
<p>Setting this variable to 1 will disable window creation when graphics
131+
functions are being called. Disabling window creation will disable all other
132+
graphics calls at runtime as well.</p>
133+
134+
<p>This is a useful enviornment variable when running code on servers and systems
135+
without displays. When graphics calls are run on such machines, they will
136+
print warning about window creation failing. To suppress those calls, set this
137+
variable.</p>
138+
139+
<h1 id='af_synchronous_calls' class='section-header'><a href='#af_synchronous_calls'>10 AF_SYNCHRONOUS_CALLS</a></h1>
140+
<p>When this environment variable is set to 1, ArrayFire will execute all
141+
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>
144+
<p>When using the Unified backend, if this variable is set to 1, it will show the
145+
path where the ArrayFire backend libraries are loaded from.</p>
146+
147+
<p>If the libraries are loaded from system paths, such as PATH or LD_LIBRARY_PATH
148+
etc, then it will print &quot;system path&quot;. If the libraries are loaded from other
149+
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>
152+
<p>When AF_MEM_DEBUG is set to 1 (or anything not equal to 0), the caching mechanism in the memory manager is disabled.
153+
The device buffers are allocated using native functions as needed and freed when going out of scope.</p>
154+
155+
<p>When the environment variable is not set, it is treated to be non zero.</p>
156+
157+
<pre class="rust rust-example-rendered">
158+
<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>
161+
<p>When AF_MAX_BUFFERS is set, this environment variable specifies the maximum number of buffers allocated before garbage collection kicks in.</p>
162+
163+
<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+
165+
<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>
168+
<p>When set, this environment variable specifies the maximum height of the OpenCL JIT tree after which evaluation is forced.</p>
169+
170+
<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>
173+
<p>When set, this environment variable specifies the maximum height of the CUDA JIT tree after which evaluation is forced.</p>
174+
175+
<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>
178+
<p>When set, this environment variable specifies the maximum length of the CPU JIT tree after which evaluation is forced.</p>
179+
180+
<p>The default value, as of v3.4, 100. This value was 20 for older versions.</p>
181+
182+
183+
</body>
184+
</html>

‎arrayfire/constant.DEFAULT_RANDOM_ENGINE.html

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<link rel="shortcut icon" href="http://www.rust-lang.org/favicon.ico">
1818

1919
</head>
20-
<body class="rustdoc">
20+
<body class="rustdoc constant">
2121
<!--[if lte IE 8]>
2222
<div class="warning">
2323
This old browser is unsupported and will most likely display funky
@@ -43,13 +43,14 @@
4343
</form>
4444
</nav>
4545

46-
<section id='main' class="content constant">
47-
<h1 class='fqn'><span class='in-band'>Constant <a href='index.html'>arrayfire</a>::<wbr><a class='constant' href=''>DEFAULT_RANDOM_ENGINE</a></span><span class='out-of-band'><span id='render-detail'>
46+
<section id='main' class="content">
47+
<h1 class='fqn'><span class='in-band'>Constant <a href='index.html'>arrayfire</a>::<wbr><a class="constant" href=''>DEFAULT_RANDOM_ENGINE</a></span><span class='out-of-band'><span id='render-detail'>
4848
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
4949
[<span class='inner'>&#x2212;</span>]
5050
</a>
51-
</span><a class='srclink' href='../src/arrayfire/defines.rs.html#402' title='goto source code'>[src]</a></span></h1>
52-
<pre class='rust const'>pub const DEFAULT_RANDOM_ENGINE: <a class='enum' href='../arrayfire/enum.RandomEngineType.html' title='arrayfire::RandomEngineType'>RandomEngineType</a><code> = </code><code>PHILOX</code></pre></section>
51+
</span><a class='srclink' href='../src/arrayfire/defines.rs.html#423' title='goto source code'>[src]</a></span></h1>
52+
<pre class='rust const'>pub const DEFAULT_RANDOM_ENGINE: <a class="enum" href="../arrayfire/enum.RandomEngineType.html" title="enum arrayfire::RandomEngineType">RandomEngineType</a><code> = </code><code>PHILOX</code></pre><div class='docblock'><p>Default RandomEngine that defaults to <a href="./constant.PHILOX.html">PHILOX</a></p>
53+
</div></section>
5354
<section id='search' class="content hidden"></section>
5455

5556
<section class="footer"></section>

0 commit comments

Comments
 (0)