Enum ha_ndarray::Array

source ·
pub enum Array<T: CDatatype> {
    Base(ArrayBase<Box<dyn BufferRead<DType = T>>>),
    Op(ArrayOp<Arc<dyn Op<Out = T>>>),
    Slice(Box<ArraySlice<Self>>),
    View(Box<ArrayView<Self>>),
}
Expand description

A generic n-dimensional array

Variants§

§

Base(ArrayBase<Box<dyn BufferRead<DType = T>>>)

§

Op(ArrayOp<Arc<dyn Op<Out = T>>>)

§

Slice(Box<ArraySlice<Self>>)

§

View(Box<ArrayView<Self>>)

Trait Implementations§

source§

impl<T: CDatatype> Debug for Array<T>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<T: CDatatype> From<ArrayBase<Arc<Buffer<T>>>> for Array<T>

source§

fn from(base: ArrayBase<Arc<Buffer<T>>>) -> Self

Converts to this type from the input type.
source§

impl<T: CDatatype> From<ArrayBase<Arc<Vec<T>>>> for Array<T>

source§

fn from(base: ArrayBase<Arc<Vec<T>>>) -> Self

Converts to this type from the input type.
source§

impl<T: CDatatype> From<ArrayBase<Box<dyn BufferRead<DType = T>>>> for Array<T>

source§

fn from(base: ArrayBase<Box<dyn BufferRead<DType = T>>>) -> Self

Converts to this type from the input type.
source§

impl<T: CDatatype> From<ArrayBase<Buffer<T>>> for Array<T>

source§

fn from(base: ArrayBase<Buffer<T>>) -> Self

Converts to this type from the input type.
source§

impl<T: CDatatype> From<ArrayBase<Vec<T>>> for Array<T>

source§

fn from(base: ArrayBase<Vec<T>>) -> Self

Converts to this type from the input type.
source§

impl<Op: Op + 'static> From<ArrayOp<Op>> for Array<Op::Out>

source§

fn from(op: ArrayOp<Op>) -> Self

Converts to this type from the input type.
source§

impl<T: CDatatype, A: Into<Array<T>>> From<ArraySlice<A>> for Array<T>

source§

fn from(slice: ArraySlice<A>) -> Self

Converts to this type from the input type.
source§

impl<T: CDatatype, A: Into<Array<T>>> From<ArrayView<A>> for Array<T>

source§

fn from(view: ArrayView<A>) -> Self

Converts to this type from the input type.
source§

impl<T: CDatatype> NDArray for Array<T>

§

type DType = T

The data type of the elements in this array
source§

fn context(&self) -> &Context

Borrow the execution Context of this array.
source§

fn shape(&self) -> &[usize]

Borrow the shape of this array.
source§

fn ndim(&self) -> usize

Return the number of dimensions in this array.
source§

fn size(&self) -> usize

Return the number of elements in this array.
source§

impl<T: CDatatype> NDArrayRead for Array<T>

source§

fn read(&self, queue: &Queue) -> Result<BufferConverter<'_, Self::DType>, Error>

Read the value of this NDArray.
source§

fn read_value(&self, coord: &[usize]) -> Result<Self::DType, Error>

Read the value at one coord in this NDArray.
source§

fn to_host( &self, queue: &Queue ) -> Result<SliceConverter<'_, Self::DType>, Error>

Read the value of this NDArray as a SliceConverter in main memory
source§

impl<T: CDatatype> NDArrayTransform for Array<T>

§

type Broadcast = Array<T>

The type returned by broadcast
§

type Expand = Array<T>

The type returned by expand_dims
§

type Reshape = Array<T>

The type returned by reshape
§

type Slice = Array<T>

The type returned by slice
§

type Transpose = Array<T>

The type returned by transpose
source§

fn broadcast(self, shape: Shape) -> Result<Self, Error>

Broadcast this array into the given shape.
source§

fn expand_dims(self, axes: Vec<usize>) -> Result<Self, Error>

Expand the given axes of this array.
source§

fn reshape(self, shape: Shape) -> Result<Self, Error>

Reshape this array into the given shape.
source§

fn slice(self, bounds: Vec<AxisBound>) -> Result<Self, Error>

Construct a slice of this array.
source§

fn transpose(self, axes: Option<Vec<usize>>) -> Result<Self, Error>

Transpose this array according to the given permutation. If no permutation is given, the array axes will be reversed.

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Array<T>

§

impl<T> Send for Array<T>

§

impl<T> Sync for Array<T>

§

impl<T> Unpin for Array<T>

§

impl<T> !UnwindSafe for Array<T>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<A> MatrixMath for Awhere A: NDArray + Debug,

source§

fn diagonal(self) -> Result<ArrayOp<MatDiag<Self>>, Error>where Self: Sized,

Construct an operation to read the diagonal of this matrix or batch of matrices.
source§

fn matmul<O>( self, other: O ) -> Result<ArrayOp<MatMul<Self::DType, Self, O>>, Error>where O: NDArray<DType = Self::DType> + Debug, Self: Sized,

Construct an operation to multiply this matrix or batch of matrices with the other.
source§

impl<T, A, O> NDArrayBoolean<O> for Awhere T: CDatatype, A: NDArray<DType = T>, O: NDArray<DType = T>,

source§

fn and( self, other: O ) -> Result<ArrayOp<ArrayBoolean<Self::DType, Self, O>>, Error>

Construct a boolean and comparison with the other array.
source§

fn or( self, other: O ) -> Result<ArrayOp<ArrayBoolean<Self::DType, Self, O>>, Error>

Construct a boolean or comparison with the other array.
source§

fn xor( self, other: O ) -> Result<ArrayOp<ArrayBoolean<Self::DType, Self, O>>, Error>

Construct a boolean xor comparison with the other array.
source§

impl<T, A> NDArrayBooleanScalar for Awhere T: CDatatype, A: NDArray<DType = T>,

source§

fn and_scalar( self, other: Self::DType ) -> Result<ArrayOp<ArrayBooleanScalar<Self, Self::DType>>, Error>

Construct a boolean and operation with the other value.
source§

fn or_scalar( self, other: Self::DType ) -> Result<ArrayOp<ArrayBooleanScalar<Self, Self::DType>>, Error>

Construct a boolean or operation with the other value.
source§

fn xor_scalar( self, other: Self::DType ) -> Result<ArrayOp<ArrayBooleanScalar<Self, Self::DType>>, Error>

Construct a boolean xor operation with the other value.
source§

impl<A> NDArrayCast for Awhere A: NDArray,

source§

fn cast<O: CDatatype>(self) -> Result<ArrayOp<ArrayCast<Self, O>>, Error>

Construct a new array cast operation.
source§

impl<A, O> NDArrayCompare<O> for Awhere A: NDArray, O: NDArray<DType = <A as NDArray>::DType> + NDArray,

source§

fn eq( self, other: O ) -> Result<ArrayOp<ArrayCompare<Self::DType, Self, O>>, Error>

Construct an equality comparison with the other array.
source§

fn gt( self, other: O ) -> Result<ArrayOp<ArrayCompare<Self::DType, Self, O>>, Error>

Construct a greater-than comparison with the other array.
source§

fn ge( self, other: O ) -> Result<ArrayOp<ArrayCompare<Self::DType, Self, O>>, Error>

Construct an equal-or-greater-than comparison with the other array.
source§

fn lt( self, other: O ) -> Result<ArrayOp<ArrayCompare<Self::DType, Self, O>>, Error>

Construct an equal-or-less-than comparison with the other array.
source§

fn le( self, other: O ) -> Result<ArrayOp<ArrayCompare<Self::DType, Self, O>>, Error>

Construct an equal-or-less-than comparison with the other array.
source§

fn ne( self, other: O ) -> Result<ArrayOp<ArrayCompare<Self::DType, Self, O>>, Error>

Construct an not-equal comparison with the other array.
source§

impl<A> NDArrayCompareScalar for Awhere A: NDArray,

source§

fn eq_scalar( self, other: Self::DType ) -> Result<ArrayOp<ArrayCompareScalar<Self::DType, Self>>, Error>

Construct an equality comparison with the other value.
source§

fn gt_scalar( self, other: Self::DType ) -> Result<ArrayOp<ArrayCompareScalar<Self::DType, Self>>, Error>

Construct a greater-than comparison with the other value.
source§

fn ge_scalar( self, other: Self::DType ) -> Result<ArrayOp<ArrayCompareScalar<Self::DType, Self>>, Error>

Construct an equal-or-greater-than comparison with the other value.
source§

fn lt_scalar( self, other: Self::DType ) -> Result<ArrayOp<ArrayCompareScalar<Self::DType, Self>>, Error>

Construct a less-than comparison with the other value.
source§

fn le_scalar( self, other: Self::DType ) -> Result<ArrayOp<ArrayCompareScalar<Self::DType, Self>>, Error>

Construct an equal-or-less-than comparison with the other value.
source§

fn ne_scalar( self, other: Self::DType ) -> Result<ArrayOp<ArrayCompareScalar<Self::DType, Self>>, Error>where Self: Sized,

Construct an not-equal comparison with the other value.
source§

impl<A> NDArrayMath for Awhere A: NDArray,

source§

fn add<O>( self, rhs: O ) -> Result<ArrayOp<ArrayDual<Self::DType, Self, O>>, Error>where O: NDArray<DType = Self::DType> + Sized,

Construct an addition operation with the given rhs.
source§

fn checked_div<O>( self, rhs: O ) -> Result<ArrayOp<ArrayDual<Self::DType, Self, O>>, Error>where O: NDArray<DType = Self::DType> + Sized,

Construct a division operation with the given rhs which will return an error if rhs contains zeros.
source§

fn div<O>( self, rhs: O ) -> Result<ArrayOp<ArrayDual<Self::DType, Self, O>>, Error>where O: NDArray<DType = Self::DType> + Sized,

Construct a division operation with the given rhs which will enter undefined behavior if rhs contains zeros.
source§

fn mul<O>( self, rhs: O ) -> Result<ArrayOp<ArrayDual<Self::DType, Self, O>>, Error>where O: NDArray<DType = Self::DType> + Sized,

Construct an array multiplication operation with the given rhs.
source§

fn rem<O>( self, rhs: O ) -> Result<ArrayOp<ArrayDual<Self::DType, Self, O>>, Error>where O: NDArray<DType = Self::DType> + Sized,

Construct an array modulo operation with the given rhs.
source§

fn sub<O>( self, rhs: O ) -> Result<ArrayOp<ArrayDual<Self::DType, Self, O>>, Error>where O: NDArray<DType = Self::DType> + Sized,

Construct an array subtraction operation with the given rhs.
source§

fn log<O>( self, base: O ) -> Result<ArrayOp<ArrayDualFloat<Self::DType, Self, O>>, Error>where O: NDArray<DType = <Self::DType as CDatatype>::Float> + Sized,

Construct an array logarithm operation with the given base.
source§

fn pow<O>( self, exp: O ) -> Result<ArrayOp<ArrayDualFloat<Self::DType, Self, O>>, Error>where O: NDArray<DType = <Self::DType as CDatatype>::Float> + Sized,

Construct an array exponentiation operation with the given power.
source§

impl<A> NDArrayMathScalar for Awhere A: NDArray,

source§

fn add_scalar( self, rhs: Self::DType ) -> Result<ArrayOp<ArrayScalar<Self::DType, Self>>, Error>

Construct a scalar addition operation.
source§

fn div_scalar( self, rhs: Self::DType ) -> Result<ArrayOp<ArrayScalar<Self::DType, Self>>, Error>

Construct a scalar division operation.
source§

fn mul_scalar( self, rhs: Self::DType ) -> Result<ArrayOp<ArrayScalar<Self::DType, Self>>, Error>

Construct a scalar multiplication operation.
source§

fn rem_scalar( self, rhs: Self::DType ) -> Result<ArrayOp<ArrayScalar<Self::DType, Self>>, Error>

Construct a scalar modulo operation.
source§

fn sub_scalar( self, rhs: Self::DType ) -> Result<ArrayOp<ArrayScalar<Self::DType, Self>>, Error>

Construct a scalar subtraction operation.
source§

fn log_scalar( self, base: <Self::DType as CDatatype>::Float ) -> Result<ArrayOp<ArrayScalarFloat<Self::DType, Self>>, Error>

Construct a scalar logarithm operation.
source§

fn pow_scalar( self, exp: <Self::DType as CDatatype>::Float ) -> Result<ArrayOp<ArrayScalarFloat<Self::DType, Self>>, Error>

Construct a scalar exponentiation operation.
source§

impl<A> NDArrayReduceAll for Awhere A: NDArrayRead,

source§

fn max_all(&self) -> Result<Self::DType, Error>

Return the maximum element in this array.
source§

fn min_all(&self) -> Result<Self::DType, Error>

Return the minimum element in this array.
source§

fn product_all(&self) -> Result<Self::DType, Error>

Return the product of all elements in this array.
source§

fn sum_all(&self) -> Result<Self::DType, Error>

Return the sum of all elements in this array.
source§

impl<A> NDArrayReduceBoolean for Awhere A: NDArrayRead,

source§

fn all(&self) -> Result<bool, Error>

Return true if this array contains only non-zero elements.
source§

fn any(&self) -> Result<bool, Error>

Return true if this array contains any non-zero elements.
source§

impl<A> NDArrayTrig for Awhere A: NDArray,

source§

fn asin( self ) -> Result<ArrayOp<ArrayUnary<Self::DType, <Self::DType as CDatatype>::Float, Self>>, Error>

Construct a new arcsine operation.
source§

fn sin( self ) -> Result<ArrayOp<ArrayUnary<Self::DType, <Self::DType as CDatatype>::Float, Self>>, Error>

Construct a new sine operation.
source§

fn sinh( self ) -> Result<ArrayOp<ArrayUnary<Self::DType, <Self::DType as CDatatype>::Float, Self>>, Error>

Construct a new hyperbolic sine operation.
source§

fn acos( self ) -> Result<ArrayOp<ArrayUnary<Self::DType, <Self::DType as CDatatype>::Float, Self>>, Error>

Construct a new arccosine operation.
source§

fn cos( self ) -> Result<ArrayOp<ArrayUnary<Self::DType, <Self::DType as CDatatype>::Float, Self>>, Error>

Construct a new cosine operation.
source§

fn cosh( self ) -> Result<ArrayOp<ArrayUnary<Self::DType, <Self::DType as CDatatype>::Float, Self>>, Error>

Construct a new hyperbolic cosine operation.
source§

fn atan( self ) -> Result<ArrayOp<ArrayUnary<Self::DType, <Self::DType as CDatatype>::Float, Self>>, Error>

Construct a new arctangent operation.
source§

fn tan( self ) -> Result<ArrayOp<ArrayUnary<Self::DType, <Self::DType as CDatatype>::Float, Self>>, Error>

Construct a new tangent operation.
source§

fn tanh( self ) -> Result<ArrayOp<ArrayUnary<Self::DType, <Self::DType as CDatatype>::Float, Self>>, Error>

Construct a new hyperbolic tangent operation.
source§

impl<A> NDArrayUnary for Awhere A: NDArray,

source§

fn abs( self ) -> Result<ArrayOp<ArrayUnary<Self::DType, Self::DType, Self>>, Error>

Construct an absolute value operation.
source§

fn exp( self ) -> Result<ArrayOp<ArrayUnary<Self::DType, Self::DType, Self>>, Error>

Construct an exponentiation operation.
source§

fn ln( self ) -> Result<ArrayOp<ArrayUnary<Self::DType, Self::DType, Self>>, Error>

Construct a natural logarithm operation.
source§

fn not(self) -> Result<ArrayOp<ArrayUnary<Self::DType, u8, Self>>, Error>

Construct a boolean not operation.
source§

fn round( self ) -> Result<ArrayOp<ArrayUnary<Self::DType, Self::DType, Self>>, Error>

Construct an integer rounding operation.
source§

impl<A> NDArrayWhere for Awhere A: NDArray<DType = u8> + Debug,

source§

fn cond<T, L, R>( self, then: L, or_else: R ) -> Result<ArrayOp<GatherCond<Self, T, L, R>>, Error>where T: CDatatype, L: NDArray<DType = T> + Debug, R: NDArray<DType = T> + Debug, Self: Sized,

Construct a boolean selection operation. The resulting array will return values from then where self is true and from or_else where self is false.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V