Struct afarray::Coords

pub struct Coords { /* fields omitted */ }

A hardware-accelerated set of n-dimensional coordinates, all with the same dimension.

TODO: separate out a CoordBasis struct

Implementations

impl Coords

pub fn empty(shape: &[u64], size: usize) -> Self

Constructs Coords with the given size full of zeros (origin points) for the given shape.

Panics: if shape is empty

pub fn from_iter<I: IntoIterator<Item = Coord>>(iter: I, ndim: usize) -> Self

Constructs a new Coords from an iterator of Coords.

Panics: if any Coord is not of length ndim, or if ndim is zero.

pub fn from_offsets(offsets: Offsets, shape: &[u64]) -> Self

Constructs a new Coords from an ArrayExt of offsets with respect to the given shape.

Panics: if shape is empty

pub async fn from_stream<S: Stream<Item = Coord> + Unpin>(
    source: S,
    ndim: usize,
    size_hint: Option<usize>
) -> Self

Constructs a new Coords from a [Stream] of Coords.

Panics: if any Coord has a length other than ndim, or if ndim is zero

pub async fn try_from_stream<E, S: TryStream<Ok = Coord, Error = E> + Unpin>(
    source: S,
    ndim: usize,
    size_hint: Option<usize>
) -> Result<Self, E>

Constructs a new Coords from a [TryStream] of Coords.

Panics: if any Coord has a length other than ndim

pub fn is_empty(&self) -> bool

Return true if the number of coordinates in these Coords is zero.

pub fn is_sorted(&self, shape: &[u64]) -> bool

Return true if these Coords are in sorted order with respect to the given shape.

pub fn len(&self) -> usize

Return the number of coordinates stored in these Coords.

pub fn ndim(&self) -> usize

Return the number of dimensions of these Coords.

pub fn contract_dim(&self, axis: usize) -> Self

Return a copy of these Coords without the specified axis.

Panics: if there is no dimension at axis

pub fn expand_dim(&self, axis: usize) -> Self

Return a copy of these Coords with a new dimension at the given axis.

Panics: if axis is greater than self.ndim()

pub fn flip(self, shape: &[u64], axis: usize) -> Self

Return these Coords as flipped around axis with respect to the given shape.

E.g. flipping axis 1 of coordinate [0, 1, 2] in shape [5, 5, 5] produces [0, 4, 2].

Panics: if self.ndim() != shape.len()

pub fn slice(
    &self,
    shape: &[u64],
    elided: &HashMap<usize, u64>,
    offset: &HashMap<usize, u64>
) -> Self

Transform the coordinate basis of these Coords from a source tensor to a slice.

pub fn transpose<P: AsRef<[usize]>>(&self, permutation: Option<P>) -> Coords

Transpose these Coords according to the given permutation.

If no permutation is given, the coordinate axes will be inverted.

pub fn unbroadcast(&self, source_shape: &[u64], broadcast: &[bool]) -> Coords

Invert the given broadcast of these Coords.

Panics: if source_shape and broadcast are not the same length.

pub fn unslice(
    &self,
    source_shape: &[u64],
    elided: &HashMap<usize, u64>,
    offset: &HashMap<usize, u64>
) -> Self

Transform the coordinate basis of these Coords from a slice to a source tensor.

Panics: if source_shape.len() - self.ndim() does not match elided.len()

pub fn get(&self, axes: &[usize]) -> Self

Construct a new Coords from the selected indices.

Panics: if any index is out of bounds

pub fn set(&mut self, axes: &[usize], value: &Self)

Update these Coords by writing the given value at the given index.

Panics: if any index is out of bounds, or if value.len() does not match self.len()

pub fn to_offsets(&self, shape: &[u64]) -> ArrayExt<u64>

Return these Coords as Offsets with respect to the given shape.

Panics: if shape.len() does not equal self.ndim()

pub fn to_vec(&self) -> Vec<Coord>

Return a list of Coords from these Coords.

Panics: if the given number of dimensions does not fit the set of coordinates

pub fn into_vec(self) -> Vec<Coord>

Convert these Coords into a list of Coords.

Panics: if the given number of dimensions does not fit the set of coordinates.

Methods from Deref<Target = Array<u64>>

pub 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.

pub 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.

pub fn elements(&self) -> usize

Returns the number of elements in the Array

pub fn get_type(&self) -> DType

Returns the Array data type

pub fn dims(&self) -> Dim4

Returns the dimensions of the Array

pub fn strides(&self) -> Dim4

Returns the strides of the Array

pub fn numdims(&self) -> u32

Returns the number of dimensions of the Array

pub fn offset(&self) -> i64

Returns the offset to the pointer from where data begins

pub unsafe fn get(&self) -> *mut c_void

Returns the native FFI handle for Rust object Array

pub fn set(&mut self, handle: *mut c_void)

Set the native FFI handle for Rust object Array

pub fn host<O>(&self, data: &mut [O]) where
    O: HasAfEnum, 

Copies the data from the Array to the mutable slice data

Examples

Basic case

let a:Vec<u8> = vec![0,1,2,3,4,5,6,7,8];
let b = Array::<u8>::new(&a,Dim4::new(&[3,3,1,1]));
let mut c = vec!(u8::default();b.elements());
b.host(&mut c);
assert_eq!(c,a);

Generic case

fn to_vec<T:HasAfEnum+Default+Clone>(array:&Array<T>) -> Vec<T> {
    let mut vec = vec!(T::default();array.elements());
    array.host(&mut vec);
    return vec;
}

let a = Array::<u8>::new(&[0,1,2,3,4,5,6,7,8],Dim4::new(&[3,3,1,1]));
let b:Vec<u8> = vec![0,1,2,3,4,5,6,7,8];
assert_eq!(to_vec(&a),b);

pub fn eval(&self)

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

pub fn copy(&self) -> Array<T>

Makes an copy of the Array

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

pub fn is_empty(&self) -> bool

Check if Array is empty

pub fn is_scalar(&self) -> bool

Check if Array is scalar

pub fn is_row(&self) -> bool

Check if Array is a row

pub fn is_column(&self) -> bool

Check if Array is a column

pub fn is_vector(&self) -> bool

Check if Array is a vector

pub fn is_real(&self) -> bool

Check if Array is of real (not complex) type

pub fn is_complex(&self) -> bool

Check if Array is of complex type

pub fn is_double(&self) -> bool

Check if Array’s numerical type is of double precision

pub fn is_single(&self) -> bool

Check if Array’s numerical type is of single precision

pub fn is_half(&self) -> bool

Check if Array’s numerical type is of half precision

pub fn is_integer(&self) -> bool

Check if Array is of integral type

pub fn is_bool(&self) -> bool

Check if Array is of boolean type

pub fn is_realfloating(&self) -> bool

Check if Array is floating point real(not complex) data type

pub fn is_floating(&self) -> bool

Check if Array is floating point type, either real or complex data

pub fn is_linear(&self) -> bool

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

pub fn is_sparse(&self) -> bool

Check if Array is a sparse matrix

pub fn is_owner(&self) -> bool

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

pub fn cast<O>(&self) -> Array<O> where
    O: HasAfEnum, 

Cast the Array data type to target_type

pub fn lock(&self)

Lock the device buffer in the memory manager

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

pub 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.

pub unsafe fn device_ptr(&self) -> *mut c_void

Get the device pointer and lock the buffer in memory manager

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

pub 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 Clone for Coords

fn clone(&self) -> Coords

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for Coords

type Target = Array<u64>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Coords

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.