![]() |
|
Get information about the array object. More...
Functions | |
const array | as (dtype type) const |
Converts the array into another type. More... | |
array | T () const |
Get the transposed the array. More... | |
array | H () const |
Get the conjugate-transpose of the current array. More... | |
AFAPI af_err | af_copy_array (af_array *arr, const af_array in) |
Deep copy an array to another. More... | |
AFAPI af_err | af_get_data_ref_count (int *use_count, const af_array in) |
Get the use count of af_array More... | |
AFAPI af_err | af_write_array (af_array arr, const void *data, const size_t bytes, af_source src) |
Copy data from a C pointer (host/device) to an existing array. More... | |
AFAPI af_err | af_get_data_ptr (void *data, const af_array arr) |
Copy data from an af_array to a C pointer. More... | |
AFAPI af_err | af_release_array (af_array arr) |
Reduce the reference count of the af_array. More... | |
AFAPI af_err | af_retain_array (af_array *out, const af_array in) |
Increments an af_array reference count. More... | |
AFAPI af_err | af_eval (af_array in) |
Evaluate any expressions in the Array. More... | |
AFAPI af_err | af_get_elements (dim_t *elems, const af_array arr) |
Gets the number of elements in an array. More... | |
AFAPI af_err | af_get_type (af_dtype *type, const af_array arr) |
Gets the type of an array. More... | |
AFAPI af_err | af_get_dims (dim_t *d0, dim_t *d1, dim_t *d2, dim_t *d3, const af_array arr) |
Gets the dimensions of an array. More... | |
AFAPI af_err | af_get_numdims (unsigned *result, const af_array arr) |
Gets the number of dimensions of an array. More... | |
AFAPI af_err | af_is_empty (bool *result, const af_array arr) |
Check if an array is empty. More... | |
AFAPI af_err | af_is_scalar (bool *result, const af_array arr) |
Check if an array is scalar, ie. More... | |
AFAPI af_err | af_is_row (bool *result, const af_array arr) |
Check if an array is row vector. More... | |
AFAPI af_err | af_is_column (bool *result, const af_array arr) |
Check if an array is a column vector. More... | |
AFAPI af_err | af_is_vector (bool *result, const af_array arr) |
Check if an array is a vector. More... | |
AFAPI af_err | af_is_complex (bool *result, const af_array arr) |
Check if an array is complex type. More... | |
AFAPI af_err | af_is_real (bool *result, const af_array arr) |
Check if an array is real type. More... | |
AFAPI af_err | af_is_double (bool *result, const af_array arr) |
Check if an array is double precision type. More... | |
AFAPI af_err | af_is_single (bool *result, const af_array arr) |
Check if an array is single precision type. More... | |
AFAPI af_err | af_is_realfloating (bool *result, const af_array arr) |
Check if an array is real floating point type. More... | |
AFAPI af_err | af_is_floating (bool *result, const af_array arr) |
Check if an array is floating precision type. More... | |
AFAPI af_err | af_is_integer (bool *result, const af_array arr) |
Check if an array is integer type. More... | |
AFAPI af_err | af_is_bool (bool *result, const af_array arr) |
Check if an array is bool type. More... | |
AFAPI af_err | af_is_sparse (bool *result, const af_array arr) |
Check if an array is sparse. More... | |
AFAPI af_err | af_get_scalar (void *output_value, const af_array arr) |
Get first element from an array. More... | |
array & | eval (array &a) |
Evaluate an expression (nonblocking). More... | |
AFAPI void | eval (int num, array **arrays) |
Evaluate multiple arrays simultaneously. More... | |
void | eval (array &a, array &b) |
void | eval (array &a, array &b, array &c) |
void | eval (array &a, array &b, array &c, array &d) |
void | eval (array &a, array &b, array &c, array &d, array &e) |
void | eval (array &a, array &b, array &c, array &d, array &e, array &f) |
AFAPI void | setManualEvalFlag (bool flag) |
Turn the manual eval flag on or off. More... | |
AFAPI bool | getManualEvalFlag () |
Get the manual eval flag. More... | |
af_array | get () |
get the af_array handle More... | |
af_array | get () const |
get the af_array handle More... | |
dim_t | elements () const |
get the number of elements in array More... | |
template<typename T > | |
T * | host () const |
Copy array data to host and return host pointer. More... | |
void | host (void *ptr) const |
Copy array data to existing host pointer. More... | |
template<typename T > | |
void | write (const T *ptr, const size_t bytes, af::source src=afHost) |
Perform deep copy from host/device pointer to an existing array. More... | |
dtype | type () const |
Get array data type. More... | |
dim4 | dims () const |
Get dimensions of the array. More... | |
dim_t | dims (unsigned dim) const |
Get dimensions of the array. More... | |
unsigned | numdims () const |
Get the number of dimensions of the array. More... | |
size_t | bytes () const |
Get the size of the array in bytes. More... | |
size_t | allocated () const |
Get the size of the array in memory. More... | |
array | copy () const |
Perform deep copy of the array. More... | |
bool | isempty () const |
Returns true of the array is empty. More... | |
bool | isscalar () const |
Returns true of the array contains only one value. More... | |
bool | isvector () const |
Returns true if only one of the array dimensions has more than one element. More... | |
bool | isrow () const |
Returns true if only the second dimension has more than one element. More... | |
bool | iscolumn () const |
Returns true if only the first dimension has more than one element. More... | |
bool | iscomplex () const |
Returns true if the array type is c32 or c64. More... | |
bool | isreal () const |
Returns true if the array type is neither c32 nor c64. More... | |
bool | isdouble () const |
Returns true if the array type is f64 or c64. More... | |
bool | issingle () const |
Returns true if the array type is neither f64 nor c64. More... | |
bool | isrealfloating () const |
Returns true if the array type is f32 or f64. More... | |
bool | isfloating () const |
Returns true if the array type is f32, f64, c32 or c64. More... | |
bool | isinteger () const |
Returns true if the array type is u8, b8, s32 u32, s64, u64, s16, u16. More... | |
bool | isbool () const |
Returns true if the array type is b8. More... | |
bool | issparse () const |
Returns true if the array is a sparse array. More... | |
void | eval () const |
Evaluate any JIT expressions to generate data for the array. More... | |
template<typename T > | |
T | scalar () const |
Get the first element of the array as a scalar. More... | |
Get information about the array object.
Copy data from an af_array to a C pointer.
Needs to used in conjunction with the two functions above
Get the use count of af_array
Gets the dimensions of an array.
[out] | d0 | is the output that contains the size of first dimension of arr |
[out] | d1 | is the output that contains the size of second dimension of arr |
[out] | d2 | is the output that contains the size of third dimension of arr |
[out] | d3 | is the output that contains the size of fourth dimension of arr |
[in] | arr | is the input array |
Gets the number of elements in an array.
[out] | elems | is the output that contains number of elements of arr |
[in] | arr | is the input array |
Gets the number of dimensions of an array.
[out] | result | is the output that contains the number of dims of arr |
[in] | arr | is the input array |
Get first element from an array.
[out] | output_value | is the element requested |
[in] | arr | is the input array |
Gets the type of an array.
[out] | type | is the output that contains the type of arr |
[in] | arr | is the input array |
Check if an array is bool type.
[out] | result | is true if arr is of b8 type, otherwise false |
[in] | arr | is the input array |
Check if an array is a column vector.
[out] | result | is true if arr has dims [x 1 1 1], false otherwise |
[in] | arr | is the input array |
Check if an array is empty.
[out] | result | is true if elements of arr is 0, otherwise false |
[in] | arr | is the input array |
Check if an array is floating precision type.
This is a combination of af_is_realfloating and af_is_complex
[out] | result | is true if arr is of type f32, f64, c32 or c64, otherwise false |
[in] | arr | is the input array |
Check if an array is integer type.
[out] | result | is true if arr is of integer types, otherwise false |
[in] | arr | is the input array |
Check if an array is real type.
This is mutually exclusive to af_is_complex
[out] | result | is true if arr is NOT of type c32 or c64, otherwise false |
[in] | arr | is the input array |
Check if an array is row vector.
[out] | result | is true if arr has dims [1 x 1 1], false otherwise |
[in] | arr | is the input array |
Check if an array is scalar, ie.
single element.
[out] | result | is true if elements of arr is 1, otherwise false |
[in] | arr | is the input array |
Check if an array is sparse.
[out] | result | is true if arr is sparse, otherwise false |
[in] | arr | is the input array |
Check if an array is a vector.
A vector is any array that has exactly 1 dimension not equal to 1.
[out] | result | is true if arr is a vector, false otherwise |
[in] | arr | is the input array |
Increments an af_array reference count.
Copy data from a C pointer (host/device) to an existing array.
size_t allocated | ( | ) | const |
Get the size of the array in memory.
This will return the parent's bytes() if the array is indexed.
Converts the array into another type.
[in] | type | is the desired type(f32, s64, etc.) |
type
size_t bytes | ( | ) | const |
Get the size of the array in bytes.
array copy | ( | ) | const |
Perform deep copy of the array.
dim4 dims | ( | ) | const |
Get dimensions of the array.
dim_t dims | ( | unsigned | dim | ) | const |
Get dimensions of the array.
dim_t elements | ( | ) | const |
get the number of elements in array
void eval | ( | ) | const |
Evaluate any JIT expressions to generate data for the array.
Evaluate an expression (nonblocking).
Definition at line 1346 of file array.h.
Definition at line 1356 of file array.h.
Definition at line 1366 of file array.h.
Definition at line 1377 of file array.h.
Definition at line 1387 of file array.h.
AFAPI bool af::getManualEvalFlag | ( | ) |
Get the manual eval flag.
array H | ( | ) | const |
Get the conjugate-transpose of the current array.
T* host | ( | ) | const |
Copy array data to host and return host pointer.
void host | ( | void * | ptr | ) | const |
Copy array data to existing host pointer.
bool isbool | ( | ) | const |
Returns true if the array type is b8.
bool iscolumn | ( | ) | const |
Returns true if only the first dimension has more than one element.
bool isempty | ( | ) | const |
Returns true of the array is empty.
|
inline |
bool isrow | ( | ) | const |
Returns true if only the second dimension has more than one element.
bool isscalar | ( | ) | const |
Returns true of the array contains only one value.
bool issparse | ( | ) | const |
Returns true if the array is a sparse array.
bool isvector | ( | ) | const |
Returns true if only one of the array dimensions has more than one element.
unsigned numdims | ( | ) | const |
Get the number of dimensions of the array.
T scalar | ( | ) | const |
Get the first element of the array as a scalar.
AFAPI void af::setManualEvalFlag | ( | bool | flag | ) |
Turn the manual eval flag on or off.
array T | ( | ) | const |
Get the transposed the array.
dtype type | ( | ) | const |
Get array data type.
void write | ( | const T * | ptr, |
const size_t | bytes, | ||
af::source | src = afHost |
||
) |
Perform deep copy from host/device pointer to an existing array.