Struct arrayfire::Array [−] [src]

pub struct Array { /* fields omitted */ }

A multidimensional data container

Currently, Array objects can store only data until four dimensions

NOTE

All operators(traits) from std::ops module implemented for Array object carry out element wise operations. For example, * does multiplication of elements at corresponding locations in two different Arrays.

Methods

`impl Array`
[src]

`fn new<T: HasAfEnum>(slice: &[T], dims: Dim4) -> Array`

Constructs a new Array object

Examples

use arrayfire::{Array, Dim4, print};
let values: [f32; 3] = [1.0, 2.0, 3.0];
let indices = Array::new(&values, Dim4::new(&[3, 1, 1, 1]));
print(&indices);

`fn new_strided<T: HasAfEnum>( slice: &[T], offset: i64, dims: Dim4, strides: Dim4 ) -> Array`

Constructs a new Array object from strided data

The data pointed by the slice passed to this function can possibily be offseted using an additional offset parameter.

`fn new_empty(dims: Dim4, aftype: DType) -> Array`

Constructs a new Array object of specified dimensions and type

Examples

use arrayfire::{Array, Dim4, DType};
let garbageVals = Array::new_empty(Dim4::new(&[3, 1, 1, 1]), DType::F32);

`fn get_backend(&self) -> Backend`

Returns the backend of the Array

Return Values

Returns an value of type Backend which indicates which backend was active when Array was created.

`fn get_device_id(&self) -> i32`

Returns the device identifier(integer) on which the Array was created

Return Values

Return the device id on which Array was created.

`fn elements(&self) -> usize`

Returns the number of elements in the Array

`fn get_type(&self) -> DType`

Returns the Array data type

`fn dims(&self) -> Dim4`

Returns the dimensions of the Array

`fn strides(&self) -> Dim4`

Returns the strides of the Array

`fn numdims(&self) -> u32`

Returns the number of dimensions of the Array

`fn offset(&self) -> i64`

Returns the offset to the pointer from where data begins

`fn get(&self) -> i64`

Returns the native FFI handle for Rust object Array

`fn host<T: HasAfEnum>(&self, data: &mut [T])`

Copies the data from the Array to the mutable slice data

`fn eval(&self)`

Evaluates any pending lazy expressions that represent the data in the Array object

`fn copy(&self) -> Array`

Makes an copy of the Array

This does a deep copy of the data into a new Array

`fn is_empty(&self) -> bool`

Check if Array is empty

`fn is_scalar(&self) -> bool`

Check if Array is scalar

`fn is_row(&self) -> bool`

Check if Array is a row

`fn is_column(&self) -> bool`

Check if Array is a column

`fn is_vector(&self) -> bool`

Check if Array is a vector

`fn is_complex(&self) -> bool`

Check if Array is of complex type

`fn is_double(&self) -> bool`

Check if Array's numerical type is of double precision

`fn is_single(&self) -> bool`

Check if Array's numerical type is of single precision

`fn is_real(&self) -> bool`

Check if Array is of real type

`fn is_floating(&self) -> bool`

Check if Array is of single precision

`fn is_integer(&self) -> bool`

Check if Array is of integral type

`fn is_bool(&self) -> bool`

Check if Array is of boolean type

`fn is_linear(&self) -> bool`

Check if Array's memory layout is continuous and one dimensional

`fn is_owner(&self) -> bool`

Check if Array's memory is owned by it and not a view of another Array

`fn cast<T: HasAfEnum>(&self) -> Array`

Cast the Array data type to target_type

`fn is_sparse(&self) -> bool`

Find if the current array is sparse

`fn lock(&self)`

Lock the device buffer in the memory manager

Locked buffers are not freed by memory manager until unlock is called.

`fn unlock(&self)`

Unlock the device buffer in the memory manager

This function will give back the control over the device pointer to the memory manager.

`fn device_ptr(&self) -> u64`

Get the device pointer and lock the buffer in memory manager

The device pointer is not freed by memory manager until unlock is called.

`fn get_allocated_bytes(&self) -> usize`

Get the size of physical allocated bytes.

This function will return the size of the parent/owner if the current Array object is an indexed Array.

Trait Implementations

`impl From<i64> for Array`
[src]

Used for creating Array object from native resource id

`fn from(t: i64) -> Array`

Performs the conversion.

`impl Clone for Array`
[src]

Returns a new Array object after incrementing the reference count of native resource

Cloning an Array does not do a deep copy of the underlying array data. It increments the reference count of native resource and returns you the new reference in the form a new Array object.

To create a deep copy use copy()

`fn clone(&self) -> Array`

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`
1.0.0

Performs copy-assignment from source. Read more

`impl Drop for Array`
[src]

To free resources when Array goes out of scope

`fn drop(&mut self)`

A method called when the value goes out of scope. Read more

`impl AddAssign<Array> for Array`
[src]

`fn add_assign(&mut self, rhs: Array)`

The method for the += operator

`impl SubAssign<Array> for Array`
[src]

`fn sub_assign(&mut self, rhs: Array)`

The method for the -= operator

`impl MulAssign<Array> for Array`
[src]

`fn mul_assign(&mut self, rhs: Array)`

The method for the *= operator

`impl DivAssign<Array> for Array`
[src]

`fn div_assign(&mut self, rhs: Array)`

The method for the /= operator

`impl RemAssign<Array> for Array`
[src]

`fn rem_assign(&mut self, rhs: Array)`

The method for the %= operator

`impl ShlAssign<Array> for Array`
[src]

`fn shl_assign(&mut self, rhs: Array)`

The method for the <<= operator

`impl ShrAssign<Array> for Array`
[src]

`fn shr_assign(&mut self, rhs: Array)`

The method for the >>= operator

`impl BitAndAssign<Array> for Array`
[src]

`fn bitand_assign(&mut self, rhs: Array)`

The method for the &= operator

`impl BitOrAssign<Array> for Array`
[src]

`fn bitor_assign(&mut self, rhs: Array)`

The method for the |= operator

`impl BitXorAssign<Array> for Array`
[src]

`fn bitxor_assign(&mut self, rhs: Array)`

The method for the ^= operator

`impl<'f> Not for &'f Array`
[src]

Enables use of ! on objects of type Array

Struct arrayfire::Array [−] [src]

NOTE

Methods

impl Array[src]

fn new<T: HasAfEnum>(slice: &[T], dims: Dim4) -> Array

Examples

fn new_strided<T: HasAfEnum>( slice: &[T], offset: i64, dims: Dim4, strides: Dim4) -> Array

fn new_empty(dims: Dim4, aftype: DType) -> Array

Examples

fn get_backend(&self) -> Backend

Return Values

fn get_device_id(&self) -> i32

Return Values

fn elements(&self) -> usize

fn get_type(&self) -> DType

fn dims(&self) -> Dim4

fn strides(&self) -> Dim4

fn numdims(&self) -> u32

fn offset(&self) -> i64

fn get(&self) -> i64

fn host<T: HasAfEnum>(&self, data: &mut [T])

fn eval(&self)

fn copy(&self) -> Array

fn is_empty(&self) -> bool

fn is_scalar(&self) -> bool

fn is_row(&self) -> bool

fn is_column(&self) -> bool

fn is_vector(&self) -> bool

fn is_complex(&self) -> bool

fn is_double(&self) -> bool

fn is_single(&self) -> bool

fn is_real(&self) -> bool

fn is_floating(&self) -> bool

fn is_integer(&self) -> bool

fn is_bool(&self) -> bool

fn is_linear(&self) -> bool

fn is_owner(&self) -> bool

fn cast<T: HasAfEnum>(&self) -> Array

fn is_sparse(&self) -> bool

fn lock(&self)

fn unlock(&self)

fn device_ptr(&self) -> u64

fn get_allocated_bytes(&self) -> usize

Trait Implementations

impl From<i64> for Array[src]

fn from(t: i64) -> Array

impl Clone for Array[src]

fn clone(&self) -> Array

fn clone_from(&mut self, source: &Self)1.0.0

impl Drop for Array[src]

fn drop(&mut self)

impl AddAssign<Array> for Array[src]

fn add_assign(&mut self, rhs: Array)

impl SubAssign<Array> for Array[src]

fn sub_assign(&mut self, rhs: Array)

impl MulAssign<Array> for Array[src]

fn mul_assign(&mut self, rhs: Array)

impl DivAssign<Array> for Array[src]

fn div_assign(&mut self, rhs: Array)

impl RemAssign<Array> for Array[src]

fn rem_assign(&mut self, rhs: Array)

impl ShlAssign<Array> for Array[src]

fn shl_assign(&mut self, rhs: Array)

impl ShrAssign<Array> for Array[src]

fn shr_assign(&mut self, rhs: Array)

impl BitAndAssign<Array> for Array[src]

fn bitand_assign(&mut self, rhs: Array)

impl BitOrAssign<Array> for Array[src]

fn bitor_assign(&mut self, rhs: Array)

impl BitXorAssign<Array> for Array[src]

fn bitxor_assign(&mut self, rhs: Array)

impl<'f> Not for &'f Array[src]

type Output = Array

fn not(self) -> Array

impl Convertable for Array[src]

fn convert(&self) -> Array

impl<'f> Add<Complex<f64>> for &'f Array[src]

type Output = Array

fn add(self, rhs: Complex<f64>) -> Array

impl Add<Complex<f64>> for Array[src]

`impl Array`
[src]

`fn new<T: HasAfEnum>(slice: &[T], dims: Dim4) -> Array`

`fn new_strided<T: HasAfEnum>( slice: &[T], offset: i64, dims: Dim4, strides: Dim4 ) -> Array`

`fn new_empty(dims: Dim4, aftype: DType) -> Array`

`fn get_backend(&self) -> Backend`

`fn get_device_id(&self) -> i32`

`fn elements(&self) -> usize`

`fn get_type(&self) -> DType`

`fn dims(&self) -> Dim4`

`fn strides(&self) -> Dim4`

`fn numdims(&self) -> u32`

`fn offset(&self) -> i64`

`fn get(&self) -> i64`

`fn host<T: HasAfEnum>(&self, data: &mut [T])`

`fn eval(&self)`

`fn copy(&self) -> Array`

`fn is_empty(&self) -> bool`

`fn is_scalar(&self) -> bool`

`fn is_row(&self) -> bool`

`fn is_column(&self) -> bool`

`fn is_vector(&self) -> bool`

`fn is_complex(&self) -> bool`

`fn is_double(&self) -> bool`

`fn is_single(&self) -> bool`

`fn is_real(&self) -> bool`

`fn is_floating(&self) -> bool`

`fn is_integer(&self) -> bool`

`fn is_bool(&self) -> bool`

`fn is_linear(&self) -> bool`

`fn is_owner(&self) -> bool`

`fn cast<T: HasAfEnum>(&self) -> Array`

`fn is_sparse(&self) -> bool`

`fn lock(&self)`

`fn unlock(&self)`

`fn device_ptr(&self) -> u64`

`fn get_allocated_bytes(&self) -> usize`

`impl From<i64> for Array`
[src]

`fn from(t: i64) -> Array`

`impl Clone for Array`
[src]

`fn clone(&self) -> Array`

`fn clone_from(&mut self, source: &Self)`
1.0.0

`impl Drop for Array`
[src]

`fn drop(&mut self)`

`impl AddAssign<Array> for Array`
[src]

`fn add_assign(&mut self, rhs: Array)`

`impl SubAssign<Array> for Array`
[src]

`fn sub_assign(&mut self, rhs: Array)`

`impl MulAssign<Array> for Array`
[src]

`fn mul_assign(&mut self, rhs: Array)`

`impl DivAssign<Array> for Array`
[src]

`fn div_assign(&mut self, rhs: Array)`

`impl RemAssign<Array> for Array`
[src]

`fn rem_assign(&mut self, rhs: Array)`

`impl ShlAssign<Array> for Array`
[src]

`fn shl_assign(&mut self, rhs: Array)`

`impl ShrAssign<Array> for Array`
[src]

`fn shr_assign(&mut self, rhs: Array)`

`impl BitAndAssign<Array> for Array`
[src]

`fn bitand_assign(&mut self, rhs: Array)`

`impl BitOrAssign<Array> for Array`
[src]

`fn bitor_assign(&mut self, rhs: Array)`

`impl BitXorAssign<Array> for Array`
[src]

`fn bitxor_assign(&mut self, rhs: Array)`

`impl<'f> Not for &'f Array`
[src]

`type Output = Array`

`fn not(self) -> Array`

`impl Convertable for Array`
[src]

`fn convert(&self) -> Array`

`impl<'f> Add<Complex<f64>> for &'f Array`
[src]

`type Output = Array`

`fn add(self, rhs: Complex<f64>) -> Array`

`impl Add<Complex<f64>> for Array`
[src]

`type Output = Array`

`fn add(self, rhs: Complex<f64>) -> Array`

`impl<'f> Sub<Complex<f64>> for &'f Array`
[src]

`type Output = Array`

`fn sub(self, rhs: Complex<f64>) -> Array`

`impl Sub<Complex<f64>> for Array`
[src]

`type Output = Array`

`fn sub(self, rhs: Complex<f64>) -> Array`