util.h (2020-10-27 00:11:00 -0400, (build d99887ae))
Go to the documentation of this file.
1 /*******************************************************
2  * Copyright (c) 2014, ArrayFire
3  * All rights reserved.
4  *
5  * This file is distributed under 3-clause BSD license.
6  * The complete license agreement can be obtained at:
7  * https://arrayfire.com/licenses/BSD-3-Clause
8  ********************************************************/
9 
10 #pragma once
11 #include <af/defines.h>
12 
13 #ifdef __cplusplus
14 namespace af
15 {
16  class array;
17 
24  AFAPI void print(const char *exp, const array &arr);
25 
26 #if AF_API_VERSION >= 31
27 
34  AFAPI void print(const char *exp, const array &arr, const int precision);
35 #endif
36 
37 #if AF_API_VERSION >= 31
38 
49  AFAPI int saveArray(const char *key, const array &arr, const char *filename, const bool append = false);
50 #endif
51 
52 #if AF_API_VERSION >= 31
53 
63  AFAPI array readArray(const char *filename, const unsigned index);
64 #endif
65 
66 #if AF_API_VERSION >= 31
67 
77  AFAPI array readArray(const char *filename, const char *key);
78 #endif
79 
80 #if AF_API_VERSION >= 31
81 
92  AFAPI int readArrayCheck(const char *filename, const char *key);
93 #endif
94 
95 #if AF_API_VERSION >= 31
96 
108  AFAPI void toString(char **output, const char *exp, const array &arr,
109  const int precision = 4, const bool transpose = true);
110 #endif
111 
112 #if AF_API_VERSION >= 33
113 
126  AFAPI const char* toString(const char *exp, const array &arr,
127  const int precision = 4, const bool transpose = true);
128 #endif
129 
130  // Purpose of Addition: "How to add Function" documentation
131  AFAPI array exampleFunction(const array& in, const af_someenum_t param);
132 
133 #if AF_API_VERSION >= 34
134  AFAPI size_t getSizeOf(af::dtype type);
138 #endif
139 }
140 
141 #if AF_API_VERSION >= 31
142 
143 #define AF_PRINT1(exp) af::print(#exp, exp);
144 #define AF_PRINT2(exp, precision) af::print(#exp, exp, precision);
145 
146 #define GET_PRINT_MACRO(_1, _2, NAME, ...) NAME
147 
148 #define af_print(...) GET_PRINT_MACRO(__VA_ARGS__, AF_PRINT2, AF_PRINT1)(__VA_ARGS__)
149 
150 #else // AF_API_VERSION
151 
152 #define af_print(exp) af::print(#exp, exp);
153 
154 #endif // AF_API_VERSION
155 
156 #endif //__cplusplus
157 
158 #ifdef __cplusplus
159 extern "C" {
160 #endif
161 
170 
171 #if AF_API_VERSION >= 31
172 
181  AFAPI af_err af_print_array_gen(const char *exp, const af_array arr, const int precision);
182 #endif
183 
184 #if AF_API_VERSION >= 31
185 
195  AFAPI af_err af_save_array(int *index, const char* key, const af_array arr, const char *filename, const bool append);
196 #endif
197 
198 #if AF_API_VERSION >= 31
199 
208  AFAPI af_err af_read_array_index(af_array *out, const char *filename, const unsigned index);
209 #endif
210 
211 #if AF_API_VERSION >= 31
212 
221  AFAPI af_err af_read_array_key(af_array *out, const char *filename, const char* key);
222 #endif
223 
224 #if AF_API_VERSION >= 31
225 
235  AFAPI af_err af_read_array_key_check(int *index, const char *filename, const char* key);
236 #endif
237 
238 #if AF_API_VERSION >= 31
239 
250  AFAPI af_err af_array_to_string(char **output, const char *exp, const af_array arr,
251  const int precision, const bool transpose);
252 #endif
253 
254  // Purpose of Addition: "How to add Function" documentation
256  const af_array in,
257  const af_someenum_t param);
258 
262  AFAPI af_err af_get_version(int *major, int *minor, int *patch);
263 
264 
265 #if AF_API_VERSION >= 33
266  AFAPI const char *af_get_revision();
272 #endif
273 
274 #if AF_API_VERSION >= 34
275  AFAPI af_err af_get_size_of(size_t *size, af_dtype type);
279 #endif
280 
281 #if AF_API_VERSION >= 37
282  AFAPI af_err af_set_enable_stacktrace(int is_enabled);
288 #endif
289 
290 #ifdef __cplusplus
291 }
292 #endif
AFAPI size_t getSizeOf(af::dtype type)
Get the size of the type represented by an af_dtype enum.
AFAPI void toString(char **output, const char *exp, const array &arr, const int precision=4, const bool transpose=true)
Definition: algorithm.h:14
AFAPI af_err af_read_array_index(af_array *out, const char *filename, const unsigned index)
AFAPI array readArray(const char *filename, const unsigned index)
AFAPI af_err af_set_enable_stacktrace(int is_enabled)
Enable(default) or disable error messages that display the stacktrace.
AFAPI af_err af_read_array_key(af_array *out, const char *filename, const char *key)
AFAPI void print(const char *exp, const array &arr)
AFAPI int readArrayCheck(const char *filename, const char *key)
When reading by key, it may be a good idea to run this function first to check for the key and then c...
AFAPI const char * af_get_revision()
Get the revision (commit) information of the library.
AFAPI af_err af_get_size_of(size_t *size, af_dtype type)
Get the size of the type represented by an af_dtype enum.
AFAPI af_err af_example_function(af_array *out, const af_array in, const af_someenum_t param)
af_err
Definition: defines.h:71
AFAPI af_err af_print_array_gen(const char *exp, const af_array arr, const int precision)
AFAPI af_err af_save_array(int *index, const char *key, const af_array arr, const char *filename, const bool append)
af_someenum_t
Definition: defines.h:424
AFAPI af_err af_print_array(af_array arr)
AFAPI af_err af_get_version(int *major, int *minor, int *patch)
Get the version information of the library.
AFAPI af_err af_read_array_key_check(int *index, const char *filename, const char *key)
When reading by key, it may be a good idea to run this function first to check for the key and then c...
#define AFAPI
Definition: defines.h:38
AFAPI af_err af_array_to_string(char **output, const char *exp, const af_array arr, const int precision, const bool transpose)
AFAPI int saveArray(const char *key, const array &arr, const char *filename, const bool append=false)
static af::array array(af::dim4 idims, cl_mem buf, af::dtype type, bool retain=false)
Create an af::array object from an OpenCL cl_mem buffer.
Definition: opencl.h:327
AFAPI array exp(const array &in)
C++ Interface for exponential of an array.
void * af_array
Definition: defines.h:240
af_dtype
Definition: defines.h:210
AFAPI array exampleFunction(const array &in, const af_someenum_t param)
AFAPI array transpose(const array &in, const bool conjugate=false)
Transposes a matrix.