util.h
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  * http://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 
31  AFAPI void print(const char *exp, const array &arr);
32 
33  // Purpose of Addition: "How to add Function" documentation
34  AFAPI array exampleFunction(const array& in, const af_someenum_t param);
35 }
36 
37 #define af_print(exp) af::print(#exp, exp);
38 
39 #endif //__cplusplus
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
57  AFAPI af_err af_get_elements(dim_t *elems, const af_array arr);
58 
67  AFAPI af_err af_get_type(af_dtype *type, const af_array arr);
68 
80  AFAPI af_err af_get_dims(dim_t *d0, dim_t *d1, dim_t *d2, dim_t *d3,
81  const af_array arr);
82 
91  AFAPI af_err af_get_numdims(unsigned *result, const af_array arr);
92 
101  AFAPI af_err af_is_empty (bool *result, const af_array arr);
102 
111  AFAPI af_err af_is_scalar (bool *result, const af_array arr);
112 
121  AFAPI af_err af_is_row (bool *result, const af_array arr);
122 
131  AFAPI af_err af_is_column (bool *result, const af_array arr);
132 
143  AFAPI af_err af_is_vector (bool *result, const af_array arr);
144 
153  AFAPI af_err af_is_complex (bool *result, const af_array arr);
154 
165  AFAPI af_err af_is_real (bool *result, const af_array arr);
166 
175  AFAPI af_err af_is_double (bool *result, const af_array arr);
176 
185  AFAPI af_err af_is_single (bool *result, const af_array arr);
186 
195  AFAPI af_err af_is_realfloating (bool *result, const af_array arr);
196 
207  AFAPI af_err af_is_floating (bool *result, const af_array arr);
208 
217  AFAPI af_err af_is_integer (bool *result, const af_array arr);
218 
227  AFAPI af_err af_is_bool (bool *result, const af_array arr);
240 
241  // Purpose of Addition: "How to add Function" documentation
242  AFAPI af_err af_example_function(af_array* out, const af_array in, const af_someenum_t param);
243 
247  AFAPI af_err af_get_version(int *major, int *minor, int *patch);
248 
249 #ifdef __cplusplus
250 }
251 #endif
AFAPI af_err af_is_row(bool *result, const af_array arr)
Check if an array is row vector.
AFAPI af_err af_is_real(bool *result, const af_array arr)
Check if an array is real type.
Definition: algorithm.h:14
AFAPI af_err af_is_realfloating(bool *result, const af_array arr)
Check if an array is real floating point type.
AFAPI af_err af_is_complex(bool *result, const af_array arr)
Check if an array is complex type.
AFAPI void print(const char *exp, const array &arr)
AFAPI af_err af_example_function(af_array *out, const af_array in, const af_someenum_t param)
AFAPI af_err af_is_bool(bool *result, const af_array arr)
Check if an array is bool type.
AFAPI af_err af_is_double(bool *result, const af_array arr)
Check if an array is double precision type.
AFAPI af_err af_is_vector(bool *result, const af_array arr)
Check if an array is a vector.
AFAPI af_err af_is_integer(bool *result, const af_array arr)
Check if an array is integer type.
af_err
Definition: defines.h:58
af_someenum_t
Definition: defines.h:282
AFAPI af_err af_get_type(af_dtype *type, const af_array arr)
Gets the type of an array.
long long dim_t
Definition: defines.h:50
AFAPI af_err af_is_single(bool *result, const af_array arr)
Check if an array is single precision type.
AFAPI af_err af_get_dims(dim_t *d0, dim_t *d1, dim_t *d2, dim_t *d3, const af_array arr)
Gets the dimseions of an array.
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.
#define AFAPI
Definition: defines.h:31
AFAPI af_err af_is_scalar(bool *result, const af_array arr)
Check if an array is scalar, ie.
AFAPI af_err af_get_elements(dim_t *elems, const af_array arr)
Gets the number of elements in an array.
AFAPI af_err af_get_numdims(unsigned *result, const af_array arr)
Gets the number of dimensions of an array.
AFAPI af_err af_is_empty(bool *result, const af_array arr)
Check if an array is empty.
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:105
AFAPI array exp(const array &in)
C++ Interface for exponential of an array.
AFAPI af_err af_is_column(bool *result, const af_array arr)
Check if an array is a column vector.
void * af_array
Definition: defines.h:172
AFAPI af_err af_is_floating(bool *result, const af_array arr)
Check if an array is floating precision type.
af_dtype
Definition: defines.h:151
AFAPI array exampleFunction(const array &in, const af_someenum_t param)