$darkmode
A high-performance general-purpose compute library
data.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 #include <af/dim4.hpp>
15 #include <af/traits.hpp>
16 namespace af
17 {
18  class array;
19 
29  template<typename T>
30  array constant(T val, const dim4 &dims, const dtype ty=(af_dtype)dtype_traits<T>::ctype);
31 
41  template<typename T>
42  array constant(T val, const dim_t d0, const af_dtype ty=(af_dtype)dtype_traits<T>::ctype);
43 
54  template<typename T>
55  array constant(T val, const dim_t d0, const dim_t d1, const af_dtype ty=(af_dtype)dtype_traits<T>::ctype);
56 
68  template<typename T>
69  array constant(T val, const dim_t d0, const dim_t d1, const dim_t d2, const af_dtype ty=(af_dtype)dtype_traits<T>::ctype);
70 
83  template<typename T>
84  array constant(T val, const dim_t d0, const dim_t d1, const dim_t d2, const dim_t d3, const af_dtype ty=(af_dtype)dtype_traits<T>::ctype);
85 
93  AFAPI array identity(const dim4 &dims, const dtype ty=f32);
94 
102  AFAPI array identity(const dim_t d0, const dtype ty=f32);
103 
112  AFAPI array identity(const dim_t d0, const dim_t d1, const dtype ty=f32);
113 
123  AFAPI array identity(const dim_t d0, const dim_t d1,
124  const dim_t d2, const dtype ty=f32);
125 
136  AFAPI array identity(const dim_t d0, const dim_t d1,
137  const dim_t d2, const dim_t d3, const dtype ty=f32);
138 
148  AFAPI array range(const dim4 &dims, const int seq_dim = -1, const dtype ty=f32);
149 
163  AFAPI array range(const dim_t d0, const dim_t d1 = 1, const dim_t d2 = 1,
164  const dim_t d3 = 1, const int seq_dim = -1, const dtype ty=f32);
165 
175  AFAPI array iota(const dim4 &dims, const dim4 &tile_dims = dim4(1), const dtype ty=f32);
176 
186  AFAPI array diag(const array &in, const int num = 0, const bool extract = true);
187 
198  AFAPI array join(const int dim, const array &first, const array &second);
199 
211  AFAPI array join(const int dim, const array &first, const array &second, const array &third);
212 
225  AFAPI array join(const int dim, const array &first, const array &second,
226  const array &third, const array &fourth);
227 
240  AFAPI array tile(const array &in, const unsigned x, const unsigned y=1,
241  const unsigned z=1, const unsigned w=1);
242 
254  AFAPI array tile(const array &in, const dim4 &dims);
255 
266  AFAPI array reorder(const array& in, const unsigned x,
267  const unsigned y=1, const unsigned z=2, const unsigned w=3);
268 
279  AFAPI array shift(const array& in, const int x, const int y=0, const int z=0, const int w=0);
280 
289  AFAPI array moddims(const array& in, const dim4& dims);
290 
302  AFAPI array moddims(const array& in, const dim_t d0, const dim_t d1=1, const dim_t d2=1, const dim_t d3=1);
303 
313  AFAPI array moddims(const array& in, const unsigned ndims, const dim_t* const dims);
314 
321  AFAPI array flat(const array &in);
322 
330  AFAPI array flip(const array &in, const unsigned dim);
331 
339  AFAPI array lower(const array &in, bool is_unit_diag=false);
340 
348  AFAPI array upper(const array &in, bool is_unit_diag=false);
349 
350 #if AF_API_VERSION >= 31
351  AFAPI array select(const array &cond, const array &a, const array &b);
360 #endif
361 
362 #if AF_API_VERSION >= 31
363  AFAPI array select(const array &cond, const array &a, const double &b);
372 #endif
373 
374 #if AF_API_VERSION >= 31
375  AFAPI array select(const array &cond, const double &a, const array &b);
384 #endif
385 
386 #if AF_API_VERSION >= 31
387  AFAPI void replace(array &a, const array &cond, const array &b);
399 #endif
400 
401 #if AF_API_VERSION >= 31
402  AFAPI void replace(array &a, const array &cond, const double &b);
412 #endif
413 
414 #if AF_API_VERSION >= 37
415  AFAPI array pad(const array &in, const dim4 &beginPadding,
427  const dim4 &endPadding, const borderType padFillType);
428 #endif
429 
430 #if AF_API_VERSION >= 39
431  AFAPI void replace(array &a, const array &cond, const long long b);
441 
451  AFAPI void replace(array &a, const array &cond,
452  const unsigned long long b);
453 
462  AFAPI array select(const array &cond, const array &a, const long long b);
463 
472  AFAPI array select(const array &cond, const array &a,
473  const unsigned long long b);
474 
483  AFAPI array select(const array &cond, const long long a, const array &b);
484 
493  AFAPI array select(const array &cond, const unsigned long long a,
494  const array &b);
495 #endif
496 }
497 #endif
498 
499 #ifdef __cplusplus
500 extern "C" {
501 #endif
502 
515  AFAPI af_err af_constant(af_array *arr, const double val, const unsigned ndims, const dim_t * const dims, const af_dtype type);
516 
532  AFAPI af_err af_constant_complex(af_array *arr, const double real, const double imag,
533  const unsigned ndims, const dim_t * const dims, const af_dtype type);
534 
549  AFAPI af_err af_constant_long (af_array *arr, const long long val, const unsigned ndims, const dim_t * const dims);
550 
566  AFAPI af_err af_constant_ulong(af_array *arr, const unsigned long long val, const unsigned ndims, const dim_t * const dims);
567 
580  AFAPI af_err af_identity(af_array* out, const unsigned ndims, const dim_t* const dims, const af_dtype type);
581 
596  AFAPI af_err af_range(af_array *out, const unsigned ndims, const dim_t * const dims,
597  const int seq_dim, const af_dtype type);
598 
614  AFAPI af_err af_iota(af_array *out, const unsigned ndims, const dim_t * const dims,
615  const unsigned t_ndims, const dim_t * const tdims, const af_dtype type);
616 
631  AFAPI af_err af_diag_create(af_array *out, const af_array in, const int num);
632 
646  AFAPI af_err af_diag_extract(af_array *out, const af_array in, const int num);
647 
662  AFAPI af_err af_join(af_array *out, const int dim, const af_array first, const af_array second);
663 
679  AFAPI af_err af_join_many(af_array *out, const int dim, const unsigned n_arrays, const af_array *inputs);
680 
697  AFAPI af_err af_tile(af_array *out, const af_array in,
698  const unsigned x, const unsigned y, const unsigned z, const unsigned w);
699 
714  AFAPI af_err af_reorder(af_array *out, const af_array in,
715  const unsigned x, const unsigned y, const unsigned z, const unsigned w);
716 
731  AFAPI af_err af_shift(af_array *out, const af_array in, const int x, const int y, const int z, const int w);
732 
746  AFAPI af_err af_moddims(af_array *out, const af_array in, const unsigned ndims, const dim_t * const dims);
747 
758  AFAPI af_err af_flat(af_array *out, const af_array in);
759 
771  AFAPI af_err af_flip(af_array *out, const af_array in, const unsigned dim);
772 
784  AFAPI af_err af_lower(af_array *out, const af_array in, bool is_unit_diag);
785 
797  AFAPI af_err af_upper(af_array *out, const af_array in, bool is_unit_diag);
798 
799 #if AF_API_VERSION >= 31
800 
812  AFAPI af_err af_select(af_array *out, const af_array cond, const af_array a, const af_array b);
813 #endif
814 
815 #if AF_API_VERSION >= 31
816 
828  AFAPI af_err af_select_scalar_r(af_array *out, const af_array cond, const af_array a, const double b);
829 #endif
830 
831 #if AF_API_VERSION >= 31
832 
844  AFAPI af_err af_select_scalar_l(af_array *out, const af_array cond, const double a, const af_array b);
845 #endif
846 
847 #if AF_API_VERSION >= 31
848 
863  AFAPI af_err af_replace(af_array a, const af_array cond, const af_array b);
864 #endif
865 
866 #if AF_API_VERSION >= 31
867 
880  AFAPI af_err af_replace_scalar(af_array a, const af_array cond, const double b);
881 #endif
882 
883 #if AF_API_VERSION >= 37
884 
901  AFAPI af_err af_pad(af_array *out, const af_array in,
902  const unsigned begin_ndims,
903  const dim_t *const begin_dims, const unsigned end_ndims,
904  const dim_t *const end_dims,
905  const af_border_type pad_fill_type);
906 #endif
907 
908 #if AF_API_VERSION >= 39
909 
922  AFAPI af_err af_replace_scalar_long(af_array a, const af_array cond,
923  const long long b);
924 
938  AFAPI af_err af_replace_scalar_ulong(af_array a, const af_array cond,
939  const unsigned long long b);
940 
953  AFAPI af_err af_select_scalar_r_long(af_array *out, const af_array cond,
954  const af_array a, const long long b);
955 
968  AFAPI af_err af_select_scalar_r_ulong(af_array *out, const af_array cond,
969  const af_array a,
970  const unsigned long long b);
971 
984  AFAPI af_err af_select_scalar_l_long(af_array *out, const af_array cond,
985  const long long a, const af_array b);
986 
999  AFAPI af_err af_select_scalar_l_ulong(af_array *out, const af_array cond,
1000  const unsigned long long a,
1001  const af_array b);
1002 #endif
1003 
1004 #ifdef __cplusplus
1005 }
1006 #endif
af_constant_long
AFAPI af_err af_constant_long(af_array *arr, const long long val, const unsigned ndims, const dim_t *const dims)
C Interface to generate an array with elements set to a specified value.
af::join
AFAPI array join(const int dim, const array &first, const array &second)
C++ Interface to join 2 arrays along a dimension.
af_constant_complex
AFAPI af_err af_constant_complex(af_array *arr, const double real, const double imag, const unsigned ndims, const dim_t *const dims, const af_dtype type)
C Interface to generate a complex array with elements set to a specified value.
af::lower
AFAPI array lower(const array &in, bool is_unit_diag=false)
C++ Interface to return the lower triangle array.
af
Definition: algorithm.h:14
af::flip
AFAPI array flip(const array &in, const unsigned dim)
C++ Interface to flip an array.
af_shift
AFAPI af_err af_shift(af_array *out, const af_array in, const int x, const int y, const int z, const int w)
C Interface to shift an array.
af_select_scalar_r_long
AFAPI af_err af_select_scalar_r_long(af_array *out, const af_array cond, const af_array a, const long long b)
C Interface to select elements based on a conditional array.
af_select_scalar_r_ulong
AFAPI af_err af_select_scalar_r_ulong(af_array *out, const af_array cond, const af_array a, const unsigned long long b)
C Interface to select elements based on a conditional array.
af_border_type
af_border_type
Definition: defines.h:266
af_moddims
AFAPI af_err af_moddims(af_array *out, const af_array in, const unsigned ndims, const dim_t *const dims)
C Interface to modify the dimensions of an input array to a specified shape.
af_range
AFAPI af_err af_range(af_array *out, const unsigned ndims, const dim_t *const dims, const int seq_dim, const af_dtype type)
C Interface to generate an array with [0, n-1] values along the seq_dim dimension and tiled across ot...
af_iota
AFAPI af_err af_iota(af_array *out, const unsigned ndims, const dim_t *const dims, const unsigned t_ndims, const dim_t *const tdims, const af_dtype type)
C Interface to generate an array with [0, n-1] values modified to specified dimensions and tiling...
af_identity
AFAPI af_err af_identity(af_array *out, const unsigned ndims, const dim_t *const dims, const af_dtype type)
C Interface to generate an identity array.
af_constant_ulong
AFAPI af_err af_constant_ulong(af_array *arr, const unsigned long long val, const unsigned ndims, const dim_t *const dims)
C Interface to generate an array with elements set to a specified value.
af_replace
AFAPI af_err af_replace(af_array a, const af_array cond, const af_array b)
C Interface to replace elements of an array with elements of another array.
af_join_many
AFAPI af_err af_join_many(af_array *out, const int dim, const unsigned n_arrays, const af_array *inputs)
C Interface to join many arrays along a dimension.
af_select
AFAPI af_err af_select(af_array *out, const af_array cond, const af_array a, const af_array b)
C Interface to select elements based on a conditional array.
af_select_scalar_l_long
AFAPI af_err af_select_scalar_l_long(af_array *out, const af_array cond, const long long a, const af_array b)
C Interface to select elements based on a conditional array.
af_diag_extract
AFAPI af_err af_diag_extract(af_array *out, const af_array in, const int num)
C Interface to extract the diagonal from an array.
af_flat
AFAPI af_err af_flat(af_array *out, const af_array in)
C Interface to flatten an array.
af::range
AFAPI array range(const dim4 &dims, const int seq_dim=-1, const dtype ty=f32)
C++ Interface to generate an array with [0, n-1] values along the seq_dim dimension and tiled across ...
af::diag
AFAPI array diag(const array &in, const int num=0, const bool extract=true)
C++ Interface to extract the diagonal from an array.
af::reorder
AFAPI array reorder(const array &in, const unsigned x, const unsigned y=1, const unsigned z=2, const unsigned w=3)
C++ Interface to reorder an array.
af_err
af_err
Definition: defines.h:71
af_join
AFAPI af_err af_join(af_array *out, const int dim, const af_array first, const af_array second)
C Interface to join 2 arrays along a dimension.
af_diag_create
AFAPI af_err af_diag_create(af_array *out, const af_array in, const int num)
C Interface to create a diagonal matrix from an extracted diagonal array.
af::moddims
AFAPI array moddims(const array &in, const dim4 &dims)
C++ Interface to modify the dimensions of an input array to a specified shape.
af_constant
AFAPI af_err af_constant(af_array *arr, const double val, const unsigned ndims, const dim_t *const dims, const af_dtype type)
C Interface to generate an array with elements set to a specified value.
af::select
AFAPI array select(const array &cond, const array &a, const array &b)
C++ Interface to select elements based on a conditional array.
af_select_scalar_l_ulong
AFAPI af_err af_select_scalar_l_ulong(af_array *out, const af_array cond, const unsigned long long a, const af_array b)
C Interface to select elements based on a conditional array.
af_upper
AFAPI af_err af_upper(af_array *out, const af_array in, bool is_unit_diag)
C Interface to return the upper triangle array.
dim_t
long long dim_t
Definition: defines.h:56
af::imag
AFAPI array imag(const array &in)
C++ Interface to return the imaginary part of a complex array.
af_pad
AFAPI af_err af_pad(af_array *out, const af_array in, const unsigned begin_ndims, const dim_t *const begin_dims, const unsigned end_ndims, const dim_t *const end_dims, const af_border_type pad_fill_type)
C Interface to pad an array.
af::real
AFAPI array real(const array &in)
C++ Interface to return the real part of a complex array.
af::flat
AFAPI array flat(const array &in)
C++ Interface to flatten an array.
af_select_scalar_r
AFAPI af_err af_select_scalar_r(af_array *out, const af_array cond, const af_array a, const double b)
C Interface to select elements based on a conditional array.
AFAPI
#define AFAPI
Definition: defines.h:38
af_replace_scalar
AFAPI af_err af_replace_scalar(af_array a, const af_array cond, const double b)
C Interface to replace elements of an array with a scalar value.
af::borderType
af_border_type borderType
Definition: defines.h:556
af_replace_scalar_long
AFAPI af_err af_replace_scalar_long(af_array a, const af_array cond, const long long b)
C Interface to replace elements of an array with a scalar value.
af_select_scalar_l
AFAPI af_err af_select_scalar_l(af_array *out, const af_array cond, const double a, const af_array b)
C Interface to select elements based on a conditional array.
afcl::array
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:330
af_tile
AFAPI af_err af_tile(af_array *out, const af_array in, const unsigned x, const unsigned y, const unsigned z, const unsigned w)
C Interface to generate a tiled array.
af::constant
array constant(T val, const dim4 &dims, const dtype ty=(af_dtype) dtype_traits< T >::ctype)
C++ Interface to generate an array with elements set to a specified value.
af::tile
AFAPI array tile(const array &in, const unsigned x, const unsigned y=1, const unsigned z=1, const unsigned w=1)
C++ Interface to generate a tiled array.
af_reorder
AFAPI af_err af_reorder(af_array *out, const af_array in, const unsigned x, const unsigned y, const unsigned z, const unsigned w)
C Interface to reorder an array.
af_array
void * af_array
Definition: defines.h:240
af::replace
AFAPI void replace(array &a, const array &cond, const array &b)
C++ Interface to replace elements of an array with elements of another array.
f32
32-bit floating point values
Definition: defines.h:211
af_lower
AFAPI af_err af_lower(af_array *out, const af_array in, bool is_unit_diag)
C Interface to return the lower triangle array.
af::shift
AFAPI array shift(const array &in, const int x, const int y=0, const int z=0, const int w=0)
C++ Interface to shift an array.
af_replace_scalar_ulong
AFAPI af_err af_replace_scalar_ulong(af_array a, const af_array cond, const unsigned long long b)
C Interface to replace elements of an array with a scalar value.
af::iota
AFAPI array iota(const dim4 &dims, const dim4 &tile_dims=dim4(1), const dtype ty=f32)
C++ Interface to generate an array with [0, n-1] values modified to specified dimensions and tiling...
af_dtype
af_dtype
Definition: defines.h:210
af_flip
AFAPI af_err af_flip(af_array *out, const af_array in, const unsigned dim)
C Interface to flip an array.
af::dtype
af_dtype dtype
Definition: defines.h:553
af::pad
AFAPI array pad(const array &in, const dim4 &beginPadding, const dim4 &endPadding, const borderType padFillType)
C++ Interface to pad an array.
af::upper
AFAPI array upper(const array &in, bool is_unit_diag=false)
C++ Interface to return the upper triangle array.
af::identity
AFAPI array identity(const dim4 &dims, const dtype ty=f32)
C++ Interface to generate an identity array.