data.h Source File

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
30 template<typename T>
31 array constant(T val, const dim4 &dims, const dtype ty=(af_dtype)dtype_traits<T>::ctype);
32
43 template<typename T>
44 array constant(T val, const dim_t d0, const af_dtype ty=(af_dtype)dtype_traits<T>::ctype);
45
56 template<typename T>
57 array constant(T val, const dim_t d0, const dim_t d1, const af_dtype ty=(af_dtype)dtype_traits<T>::ctype);
58
70 template<typename T>
71 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);
72
85 template<typename T>
86 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);
87
96 AFAPI array identity(const dim4 &dims, const dtype ty=f32);
97
106 AFAPI array identity(const dim_t d0, const dtype ty=f32);
107
117 AFAPI array identity(const dim_t d0, const dim_t d1, const dtype ty=f32);
118
129 AFAPI array identity(const dim_t d0, const dim_t d1,
130 const dim_t d2, const dtype ty=f32);
131
143 AFAPI array identity(const dim_t d0, const dim_t d1,
144 const dim_t d2, const dim_t d3, const dtype ty=f32);
145
155 AFAPI array range(const dim4 &dims, const int seq_dim = -1, const dtype ty=f32);
156
169 AFAPI array range(const dim_t d0, const dim_t d1 = 1, const dim_t d2 = 1,
170 const dim_t d3 = 1, const int seq_dim = -1, const dtype ty=f32);
171
181 AFAPI array iota(const dim4 &dims, const dim4 &tile_dims = dim4(1), const dtype ty=f32);
182
193 AFAPI array diag(const array &in, const int num = 0, const bool extract = true);
194
205 AFAPI array join(const int dim, const array &first, const array &second);
206
218 AFAPI array join(const int dim, const array &first, const array &second, const array &third);
219
232 AFAPI array join(const int dim, const array &first, const array &second,
233 const array &third, const array &fourth);
234
245 AFAPI array tile(const array &in, const unsigned x, const unsigned y=1,
246 const unsigned z=1, const unsigned w=1);
247
255 AFAPI array tile(const array &in, const dim4 &dims);
256
267 AFAPI array reorder(const array& in, const unsigned x,
268 const unsigned y=1, const unsigned z=2, const unsigned w=3);
269
281 AFAPI array shift(const array& in, const int x, const int y=0, const int z=0, const int w=0);
282
291 AFAPI array moddims(const array& in, const unsigned ndims, const dim_t * const dims);
292
300 AFAPI array moddims(const array& in, const dim4& dims);
301
312 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);
313
320 AFAPI array flat(const array &in);
321
329 AFAPI array flip(const array &in, const unsigned dim);
330
338 AFAPI array lower(const array &in, bool is_unit_diag=false);
339
347 AFAPI array upper(const array &in, bool is_unit_diag=false);
348
349 #if AF_API_VERSION >= 31
350
358 AFAPI array select(const array &cond, const array &a, const array &b);
359 #endif
360
361 #if AF_API_VERSION >= 31
362
370 AFAPI array select(const array &cond, const array &a, const double &b);
371 #endif
372
373 #if AF_API_VERSION >= 31
374
382 AFAPI array select(const array &cond, const double &a, const array &b);
383 #endif
384
385 #if AF_API_VERSION >= 31
386
395 AFAPI void replace(array &a, const array &cond, const array &b);
396 #endif
397
398 #if AF_API_VERSION >= 31
399
408 AFAPI void replace(array &a, const array &cond, const double &b);
409 #endif
410
414 }
415 #endif
416
417 #ifdef __cplusplus
418 extern "C" {
419 #endif
420
421
431 AFAPI af_err af_constant(af_array *arr, const double val, const unsigned ndims, const dim_t * const dims, const af_dtype type);
432
444 AFAPI af_err af_constant_complex(af_array *arr, const double real, const double imag,
445 const unsigned ndims, const dim_t * const dims, const af_dtype type);
446
456 AFAPI af_err af_constant_long (af_array *arr, const intl val, const unsigned ndims, const dim_t * const dims);
457
467 AFAPI af_err af_constant_ulong(af_array *arr, const uintl val, const unsigned ndims, const dim_t * const dims);
481 AFAPI af_err af_range(af_array *out, const unsigned ndims, const dim_t * const dims,
482 const int seq_dim, const af_dtype type);
483
494 AFAPI af_err af_iota(af_array *out, const unsigned ndims, const dim_t * const dims,
495 const unsigned t_ndims, const dim_t * const tdims, const af_dtype type);
496
497
506 AFAPI af_err af_identity(af_array *out, const unsigned ndims, const dim_t * const dims, const af_dtype type);
507
515 AFAPI af_err af_diag_create(af_array *out, const af_array in, const int num);
516
524 AFAPI af_err af_diag_extract(af_array *out, const af_array in, const int num);
525
536 AFAPI af_err af_join(af_array *out, const int dim, const af_array first, const af_array second);
537
550 AFAPI af_err af_join_many(af_array *out, const int dim, const unsigned n_arrays, const af_array *inputs);
551
562 AFAPI af_err af_tile(af_array *out, const af_array in,
563 const unsigned x, const unsigned y, const unsigned z, const unsigned w);
564
575 AFAPI af_err af_reorder(af_array *out, const af_array in,
576 const unsigned x, const unsigned y, const unsigned z, const unsigned w);
577
588 AFAPI af_err af_shift(af_array *out, const af_array in, const int x, const int y, const int z, const int w);
589
598 AFAPI af_err af_moddims(af_array *out, const af_array in, const unsigned ndims, const dim_t * const dims);
599
606 AFAPI af_err af_flat(af_array *out, const af_array in);
607
615 AFAPI af_err af_flip(af_array *out, const af_array in, const unsigned dim);
616
624 AFAPI af_err af_lower(af_array *out, const af_array in, bool is_unit_diag);
625
633 AFAPI af_err af_upper(af_array *out, const af_array in, bool is_unit_diag);
638 #if AF_API_VERSION >= 31
639
647 AFAPI af_err af_select(af_array *out, const af_array cond, const af_array a, const af_array b);
648 #endif
649
650 #if AF_API_VERSION >= 31
651
659 AFAPI af_err af_select_scalar_r(af_array *out, const af_array cond, const af_array a, const double b);
660 #endif
661
662 #if AF_API_VERSION >= 31
663
671 AFAPI af_err af_select_scalar_l(af_array *out, const af_array cond, const double a, const af_array b);
672 #endif
673
674 #if AF_API_VERSION >= 31
675
684 AFAPI af_err af_replace(af_array a, const af_array cond, const af_array b);
685 #endif
686
687 #if AF_API_VERSION >= 31
688
697 AFAPI af_err af_replace_scalar(af_array a, const af_array cond, const double b);
698 #endif
699
700 #ifdef __cplusplus
701 }
702 #endif
traits.hpp
af::join
AFAPI array join(const int dim, const array &first, const array &second)
Join 2 arrays along dim.
af::moddims
AFAPI array moddims(const array &in, const unsigned ndims, const dim_t *const dims)
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)
af::lower
AFAPI array lower(const array &in, bool is_unit_diag=false)
af
Definition: algorithm.h:14
af::flip
AFAPI array flip(const array &in, const unsigned dim)
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)
af_moddims
AFAPI af_err af_moddims(af_array *out, const af_array in, const unsigned ndims, const dim_t *const dims)
af_constant_long
AFAPI af_err af_constant_long(af_array *arr, const intl val, const unsigned ndims, const dim_t *const dims)
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)
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)
af_identity
AFAPI af_err af_identity(af_array *out, const unsigned ndims, const dim_t *const dims, const af_dtype type)
af_replace
AFAPI af_err af_replace(af_array a, const af_array cond, const af_array b)
af_join_many
AFAPI af_err af_join_many(af_array *out, const int dim, const unsigned n_arrays, const af_array *inputs)
Join many arrays along dim.
af_select
AFAPI af_err af_select(af_array *out, const af_array cond, const af_array a, const af_array b)
af_diag_extract
AFAPI af_err af_diag_extract(af_array *out, const af_array in, const int num)
af_flat
AFAPI af_err af_flat(af_array *out, const af_array in)
af::range
AFAPI array range(const dim4 &dims, const int seq_dim=-1, const dtype ty=f32)
dim4.hpp
af::diag
AFAPI array diag(const array &in, const int num=0, const bool extract=true)
af::reorder
AFAPI array reorder(const array &in, const unsigned x, const unsigned y=1, const unsigned z=2, const unsigned w=3)
af_err
af_err
Definition: defines.h:63
af_join
AFAPI af_err af_join(af_array *out, const int dim, const af_array first, const af_array second)
Join 2 arrays along dim.
defines.h
af_diag_create
AFAPI af_err af_diag_create(af_array *out, const af_array in, const int num)
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)
af::select
AFAPI array select(const array &cond, const array &a, const array &b)
af_upper
AFAPI af_err af_upper(af_array *out, const af_array in, bool is_unit_diag)
dim_t
long long dim_t
Definition: defines.h:50
af::imag
AFAPI array imag(const array &in)
C++ Interface for getting imaginary part from complex array.
af::real
AFAPI array real(const array &in)
C++ Interface for getting real part from complex array.
af::flat
AFAPI array flat(const array &in)
af_constant_ulong
AFAPI af_err af_constant_ulong(af_array *arr, const uintl val, const unsigned ndims, const dim_t *const dims)
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)
AFAPI
#define AFAPI
Definition: defines.h:31
af_replace_scalar
AFAPI af_err af_replace_scalar(af_array a, const af_array cond, const double b)
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)
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:327
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)
uintl
unsigned long long uintl
Definition: defines.h:56
af::constant
array constant(T val, const dim4 &dims, const dtype ty=(af_dtype) dtype_traits< T >::ctype)
af::tile
AFAPI array tile(const array &in, const unsigned x, const unsigned y=1, const unsigned z=1, const unsigned w=1)
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)
af_array
void * af_array
Definition: defines.h:222
af::replace
AFAPI void replace(array &a, const array &cond, const array &b)
f32
32-bit floating point values
Definition: defines.h:196
af_lower
AFAPI af_err af_lower(af_array *out, const af_array in, bool is_unit_diag)
af::shift
AFAPI array shift(const array &in, const int x, const int y=0, const int z=0, const int w=0)
af::iota
AFAPI array iota(const dim4 &dims, const dim4 &tile_dims=dim4(1), const dtype ty=f32)
af_dtype
af_dtype
Definition: defines.h:195
af_flip
AFAPI af_err af_flip(af_array *out, const af_array in, const unsigned dim)
af::dtype
af_dtype dtype
Definition: defines.h:461
intl
long long intl
Definition: defines.h:55
af::upper
AFAPI array upper(const array &in, bool is_unit_diag=false)
af::identity
AFAPI array identity(const dim4 &dims, const dtype ty=f32)