Struct afarray::Coords

pub struct Coords { /* fields omitted */ }

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

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 af(&self) -> &Array<u64>

Borrow these Coords as an af::Array<u64>.

pub fn af_mut(&mut self) -> &mut Array<u64>

Borrow these Coords mutably as an af::Array<u64>.

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 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<Vec<u64>>

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<Vec<u64>>

Convert these Coords into a list of Coords.

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

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.