Enum afarray::Array

pub enum Array {
    Bool(ArrayExt<bool>),
    C32(ArrayExt<Complex<f32>>),
    C64(ArrayExt<Complex<f64>>),
    F32(ArrayExt<f32>),
    F64(ArrayExt<f64>),
    I16(ArrayExt<i16>),
    I32(ArrayExt<i32>),
    I64(ArrayExt<i64>),
    U8(ArrayExt<u8>),
    U16(ArrayExt<u16>),
    U32(ArrayExt<u32>),
    U64(ArrayExt<u64>),
}

A generic one-dimensional array which supports all variants of NumberType.

Variants

Bool(ArrayExt<bool>)

C32(ArrayExt<Complex<f32>>)

C64(ArrayExt<Complex<f64>>)

F32(ArrayExt<f32>)

F64(ArrayExt<f64>)

I16(ArrayExt<i16>)

I32(ArrayExt<i32>)

I64(ArrayExt<i64>)

U8(ArrayExt<u8>)

U16(ArrayExt<u16>)

U32(ArrayExt<u32>)

U64(ArrayExt<u64>)

Implementations

impl Array

pub fn type_cast<T: HasAfEnum>(&self) -> ArrayExt<T>

Cast the values of this array into an ArrayExt<T>.

pub fn concatenate(left: &Array, right: &Array) -> Array

Concatenate two Arrays.

pub fn constant(value: Number, length: usize) -> Array

Construct a new Array with the given constant value and length.

pub fn random_normal(dtype: FloatType, length: usize) -> Array

Construct a new Array with a random normal distribution.

pub fn random_uniform(dtype: FloatType, length: usize) -> Array

Construct a new Array with a uniform random distribution.

pub fn dtype(&self) -> NumberType

The NumberType of this Array.

pub fn cast_into(&self, dtype: NumberType) -> Array

Cast into an Array of a different NumberType.

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

Copy the contents of this Array into a new Vec.

pub fn abs(&self) -> Array

Calculate the element-wise absolute value.

pub fn all(&self) -> bool

Returns true if all elements of this Array are nonzero.

pub fn any(&self) -> bool

Returns true if any element of this Array is nonzero.

pub fn and(&self, other: &Array) -> Array

Element-wise logical and.

pub fn and_const(&self, other: Number) -> Array

Element-wise logical and, relative to a constant other.

pub fn argmax(&self) -> (usize, Number)

Find the maximum value in this Array and its offset.

pub fn eq(&self, other: &Array) -> Array

Element-wise equality comparison.

pub fn eq_const(&self, other: Number) -> Array

Element-wise equality comparison.

pub fn exp(&self) -> Array

Raise e to the power of self.

pub fn gt(&self, other: &Array) -> Array

Element-wise greater-than comparison.

pub fn gt_const(&self, other: Number) -> Array

Element-wise greater-than comparison.

pub fn gte(&self, other: &Array) -> Array

Element-wise greater-or-equal comparison.

pub fn gte_const(&self, other: Number) -> Array

Element-wise greater-than-or-equal comparison.

pub fn is_infinite(&self) -> Array

Element-wise check for infinite values.

pub fn is_nan(&self) -> Array

Element-wise check for non-numeric (NaN) values.

pub fn ln(&self) -> Array

Compute the natural log of this Array.

pub fn log(&self, base: &Array) -> Array

Compute the logarithm of this Array with respect to the given base.

pub fn log_const(&self, base: Number) -> Array

Compute the logarithm of this Array with respect to the given constant base.

pub fn lt(&self, other: &Array) -> Array

Element-wise less-than comparison.

pub fn lt_const(&self, other: Number) -> Array

Element-wise less-than comparison.

pub fn lte(&self, other: &Array) -> Array

Element-wise less-or-equal comparison.

pub fn lte_const(&self, other: Number) -> Array

Element-wise less-than-or-equal comparison.

pub fn ne(&self, other: &Array) -> Array

Element-wise inequality comparison.

pub fn ne_const(&self, other: Number) -> Array

Element-wise not-equal comparison.

pub fn not(&self) -> Array

Element-wise logical not.

pub fn or(&self, other: &Array) -> Array

Element-wise logical or.

pub fn or_const(&self, other: Number) -> Array

Element-wise logical or, relative to a constant other.

pub fn reduce_max(&self, stride: u64) -> Result<Array>

Find the maximum value of each stride of this Array

pub fn reduce_min(&self, stride: u64) -> Result<Array>

Find the maximum value of each stride of this Array

pub fn reduce_product(&self, stride: u64) -> Result<Array>

Compute the product of each stride of this Array

pub fn reduce_sum(&self, stride: u64) -> Result<Array>

Compute the sum of each stride of a single block

pub fn max(&self) -> Number

Find the maximum element in this Array.

pub fn min(&self) -> Number

Find the maximum element in this Array.

pub fn product(&self) -> Number

Calculate the cumulative product of this Array.

pub fn sum(&self) -> Number

Calculate the cumulative sum of this Array.

pub fn len(&self) -> usize

The number of elements in this Array.

pub fn get_value(&self, index: usize) -> Number

Get the value at the specified index.

pub fn get(&self, index: &ArrayExt<u64>) -> Self

Get the values at the specified coordinates.

pub fn pow(&self, other: &Self) -> Self

Return this Array raised to the power of other.

pub fn pow_const(&self, other: Number) -> Self

Return this Array raised to the power of other.

pub fn round(&self) -> Self

Round this Array to the nearest integer, element-wise

pub fn set(&mut self, index: &ArrayExt<u64>, other: &Array) -> Result<()>

Set the values at the specified coordinates to the corresponding values in other.

pub fn set_value(&mut self, offset: usize, value: Number) -> Result<()>

Set the value at the specified coordinate to value.

pub fn slice(&self, start: usize, end: usize) -> Result<Self>

Return a slice of this Array.

pub fn argsort(&self, ascending: bool) -> Result<(Self, ArrayExt<u64>)>

Compute the indices needed to sort this Array.

pub fn sort(&mut self, ascending: bool) -> Result<()>

Sort this Array in-place.

pub fn split(&self, at: usize) -> Result<(Array, Array)>

Split this Array into two new instances at the given pivot.

pub fn sin(&self) -> Array

pub fn asin(&self) -> Array

pub fn sinh(&self) -> Array

pub fn asinh(&self) -> Array

pub fn cos(&self) -> Array

pub fn acos(&self) -> Array

pub fn cosh(&self) -> Array

pub fn acosh(&self) -> Array

pub fn tan(&self) -> Array

pub fn atan(&self) -> Array

pub fn tanh(&self) -> Array

pub fn atanh(&self) -> Array

pub fn xor(&self, other: &Array) -> Array

Element-wise logical xor.

pub fn xor_const(&self, other: Number) -> Array

Element-wise logical xor, relative to a constant other.

Trait Implementations

impl Add<&Array> for &Array

type Output = Array

The resulting type after applying the + operator.

fn add(self, other: &Array) -> Self::Output

Performs the + operation.

impl Add<Number> for &Array

type Output = Array

The resulting type after applying the + operator.

fn add(self, rhs: Number) -> Self::Output

Performs the + operation.

impl AddAssign<&Array> for Array

fn add_assign(&mut self, other: &Array)

Performs the += operation.

impl AddAssign<Number> for Array

fn add_assign(&mut self, rhs: Number)

Performs the += operation.

impl AsType<ArrayExt<Complex<f32>>> for Array

fn as_type(&self) -> Option<&ArrayExt<Complex<f32>>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut ArrayExt<Complex<f32>>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<ArrayExt<Complex<f32>>>

Convert this instance into an instance of T if possible.

impl AsType<ArrayExt<Complex<f64>>> for Array

fn as_type(&self) -> Option<&ArrayExt<Complex<f64>>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut ArrayExt<Complex<f64>>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<ArrayExt<Complex<f64>>>

Convert this instance into an instance of T if possible.

impl AsType<ArrayExt<bool>> for Array

fn as_type(&self) -> Option<&ArrayExt<bool>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut ArrayExt<bool>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<ArrayExt<bool>>

Convert this instance into an instance of T if possible.

impl AsType<ArrayExt<f32>> for Array

fn as_type(&self) -> Option<&ArrayExt<f32>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut ArrayExt<f32>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<ArrayExt<f32>>

Convert this instance into an instance of T if possible.

impl AsType<ArrayExt<f64>> for Array

fn as_type(&self) -> Option<&ArrayExt<f64>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut ArrayExt<f64>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<ArrayExt<f64>>

Convert this instance into an instance of T if possible.

impl AsType<ArrayExt<i16>> for Array

fn as_type(&self) -> Option<&ArrayExt<i16>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut ArrayExt<i16>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<ArrayExt<i16>>

Convert this instance into an instance of T if possible.

impl AsType<ArrayExt<i32>> for Array

fn as_type(&self) -> Option<&ArrayExt<i32>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut ArrayExt<i32>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<ArrayExt<i32>>

Convert this instance into an instance of T if possible.

impl AsType<ArrayExt<i64>> for Array

fn as_type(&self) -> Option<&ArrayExt<i64>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut ArrayExt<i64>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<ArrayExt<i64>>

Convert this instance into an instance of T if possible.

impl AsType<ArrayExt<u16>> for Array

fn as_type(&self) -> Option<&ArrayExt<u16>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut ArrayExt<u16>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<ArrayExt<u16>>

Convert this instance into an instance of T if possible.

impl AsType<ArrayExt<u32>> for Array

fn as_type(&self) -> Option<&ArrayExt<u32>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut ArrayExt<u32>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<ArrayExt<u32>>

Convert this instance into an instance of T if possible.

impl AsType<ArrayExt<u64>> for Array

fn as_type(&self) -> Option<&ArrayExt<u64>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut ArrayExt<u64>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<ArrayExt<u64>>

Convert this instance into an instance of T if possible.

impl AsType<ArrayExt<u8>> for Array

fn as_type(&self) -> Option<&ArrayExt<u8>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut ArrayExt<u8>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<ArrayExt<u8>>

Convert this instance into an instance of T if possible.

impl<T: HasAfEnum> CastFrom<Array> for ArrayExt<T>

fn cast_from(array: Array) -> ArrayExt<T>

Cast an instance of T into an instance of Self.

impl Clone for Array

fn clone(&self) -> Array

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Array

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Array

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Array

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

Formats the value using the given formatter.

impl Div<&Array> for &Array

type Output = Array

The resulting type after applying the / operator.

fn div(self, other: &Array) -> Self::Output

Performs the / operation.

impl Div<Number> for &Array

type Output = Array

The resulting type after applying the / operator.

fn div(self, rhs: Number) -> Self::Output

Performs the / operation.

impl DivAssign<&Array> for Array

fn div_assign(&mut self, other: &Array)

Performs the /= operation.

impl DivAssign<Number> for Array

fn div_assign(&mut self, rhs: Number)

Performs the /= operation.

impl<T: HasAfEnum> From<&[T]> for Arraywhere
    Array: From<ArrayExt<T>>,

fn from(values: &[T]) -> Self

Converts to this type from the input type.

impl From<ArrayExt<Complex<f32>>> for Array

fn from(t: ArrayExt<Complex<f32>>) -> Self

Converts to this type from the input type.

impl From<ArrayExt<Complex<f64>>> for Array

fn from(t: ArrayExt<Complex<f64>>) -> Self

Converts to this type from the input type.

impl From<ArrayExt<bool>> for Array

fn from(t: ArrayExt<bool>) -> Self

Converts to this type from the input type.

impl From<ArrayExt<f32>> for Array

fn from(t: ArrayExt<f32>) -> Self

Converts to this type from the input type.

impl From<ArrayExt<f64>> for Array

fn from(t: ArrayExt<f64>) -> Self

Converts to this type from the input type.

impl From<ArrayExt<i16>> for Array

fn from(t: ArrayExt<i16>) -> Self

Converts to this type from the input type.

impl From<ArrayExt<i32>> for Array

fn from(t: ArrayExt<i32>) -> Self

Converts to this type from the input type.

impl From<ArrayExt<i64>> for Array

fn from(t: ArrayExt<i64>) -> Self

Converts to this type from the input type.

impl From<ArrayExt<u16>> for Array

fn from(t: ArrayExt<u16>) -> Self

Converts to this type from the input type.

impl From<ArrayExt<u32>> for Array

fn from(t: ArrayExt<u32>) -> Self

Converts to this type from the input type.

impl From<ArrayExt<u64>> for Array

fn from(t: ArrayExt<u64>) -> Self

Converts to this type from the input type.

impl From<ArrayExt<u8>> for Array

fn from(t: ArrayExt<u8>) -> Self

Converts to this type from the input type.

impl From<Vec<Number, Global>> for Array

fn from(elements: Vec<Number>) -> Self

Converts to this type from the input type.

impl<T: HasAfEnum> From<Vec<T, Global>> for Arraywhere
    Array: From<ArrayExt<T>>,

fn from(values: Vec<T>) -> Self

Converts to this type from the input type.

impl<T: HasAfEnum> FromIterator<T> for Arraywhere
    Array: From<ArrayExt<T>>,

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl FromStream for Array

type Context = ()

The decoding context of this type, useful in situations where the stream to be decoded may be too large to hold in main memory.

fn from_stream<'life0, 'async_trait, D>(
    __arg0: (),
    decoder: &'life0 mut D
) -> Pin<Box<dyn Future<Output = Result<Self, D::Error>> + Send + 'async_trait>>where
    D: 'async_trait + Decoder,
    Self: 'async_trait,
    'life0: 'async_trait,

Parse this value using the given Decoder.

impl GetSize for Array

fn get_size(&self) -> usize

Determines the total size of the object.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

impl<'en> IntoStream<'en> for Array

fn into_stream<E: Encoder<'en>>(self, encoder: E) -> Result<E::Ok, E::Error>

Take ownership of this value and serialize it into the given encoder.

impl Mul<&Array> for &Array

type Output = Array

The resulting type after applying the * operator.

fn mul(self, other: &Array) -> Self::Output

Performs the * operation.

impl Mul<Number> for &Array

type Output = Array

The resulting type after applying the * operator.

fn mul(self, rhs: Number) -> Self::Output

Performs the * operation.

impl MulAssign<&Array> for Array

fn mul_assign(&mut self, other: &Array)

Performs the *= operation.

impl MulAssign<Number> for Array

fn mul_assign(&mut self, rhs: Number)

Performs the *= operation.

impl PartialEq<Array> for Array

fn eq(&self, other: &Array) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Array

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Sub<&Array> for &Array

type Output = Array

The resulting type after applying the - operator.

fn sub(self, other: &Array) -> Self::Output

Performs the - operation.

impl Sub<Number> for &Array

type Output = Array

The resulting type after applying the - operator.

fn sub(self, rhs: Number) -> Self::Output

Performs the - operation.

impl SubAssign<&Array> for Array

fn sub_assign(&mut self, other: &Array)

Performs the -= operation.

impl SubAssign<Number> for Array

fn sub_assign(&mut self, rhs: Number)

Performs the -= operation.

impl<'en> ToStream<'en> for Array

fn to_stream<E: Encoder<'en>>(&'en self, encoder: E) -> Result<E::Ok, E::Error>

Serialize this value into the given encoder.