Struct Array

#[repr(C)]
pub struct Array<T> { /* private fields */ }

Uiua’s array type

Implementations

impl<T: ArrayValue> Array<T>

pub fn fill_to_shape(&mut self, shape: &[usize], fill_value: T)

Fill the array with the given value so it matches the given shape

impl<T: ArrayValue> Array<T>

pub fn join(self, other: Self, allow_ext: bool, env: &Uiua) -> UiuaResult<Self>

join the array with another

pub fn join_infallible(self, other: Self, allow_ext: bool) -> Self

join the array with another

Panics

Panics if the arrays have incompatible shapes

impl<T: ArrayValue> Array<T>

pub fn couple( self, other: Self, allow_ext: bool, env: &Uiua, ) -> UiuaResult<Self>

couple the array with another

pub fn couple_infallible(self, other: Self, allow_ext: bool) -> Self

couple the array with another

Panics

Panics if the arrays have incompatible shapes

pub fn uncouple(self, env: &Uiua) -> UiuaResult<(Self, Self)>

Uncouple the array into two arrays

impl<T: ArrayValue> Array<T>

pub fn from_row_arrays<V>(values: V, env: &Uiua) -> UiuaResult<Self>

where V: IntoIterator<Item = Self>, V::IntoIter: ExactSizeIterator,

Create an array from row arrays

pub fn from_row_arrays_infallible<V>(values: V) -> Self

where V: IntoIterator<Item = Self>, V::IntoIter: ExactSizeIterator,

Create an array from row arrays

Panics

Panics if the row arrays have incompatible shapes

impl<T: ArrayValue> Array<T>

pub fn member(&self, of: &Self, env: &Uiua) -> UiuaResult<Array<u8>>

Check which rows of this array are members of another

impl<T: ArrayValue> Array<T>

pub fn index_of( &self, haystack: &Array<T>, env: &Uiua, ) -> UiuaResult<Array<f64>>

Get the index of the rows of this array in another

impl<T: ArrayValue> Array<T>

pub fn find(&self, haystack: &Self, env: &Uiua) -> UiuaResult<Array<u8>>

Try to find this array in another

pub fn mask(&self, haystack: &Self, env: &Uiua) -> UiuaResult<Value>

Try to mask this array in another

impl<T: ArrayValue> Array<T>

pub fn take(self, index: &[Result<isize, bool>], env: &Uiua) -> UiuaResult<Self>

take from this array

pub fn drop(self, index: &[Result<isize, bool>], env: &Uiua) -> UiuaResult<Self>

drop from this array

impl<T: Clone> Array<T>

pub fn reshape_scalar( &mut self, count: Result<isize, bool>, env: &Uiua, ) -> UiuaResult

reshape this array by replicating it as the rows of a new array

impl<T: ArrayValue> Array<T>

pub fn reshape( &mut self, dims: &[Result<isize, bool>], env: &Uiua, ) -> UiuaResult

reshape the array

impl<T: Clone + Send + Sync> Array<T>

pub fn keep_scalar_integer(self, count: usize, env: &Uiua) -> UiuaResult<Self>

keep this array by replicating it as the rows of a new array

impl<T: ArrayValue> Array<T>

pub fn keep_scalar_real(self, count: f64, env: &Uiua) -> UiuaResult<Self>

keep this array with a real-valued scalar

pub fn keep_list(self, counts: &[f64], env: &Uiua) -> UiuaResult<Self>

keep this array with some counts

impl<T: ArrayValue> Array<T>

pub fn rotate(&mut self, by: Array<isize>, env: &Uiua) -> UiuaResult

rotate this array by the given amount

impl<T: ArrayValue> Array<T>

pub fn windows(&self, isize_spec: &[isize], env: &Uiua) -> UiuaResult<Self>

Get the windows of this array

impl<T: ArrayValue> Array<T>

pub fn chunks(self, isize_spec: &[isize], env: &Uiua) -> UiuaResult<Self>

Get chunks of this array

impl<T: ArrayValue> Array<T>

pub fn is_map(&self) -> bool

Check if the array is a map

pub fn map_kv(&self) -> impl Iterator<Item = (Value, Array<T>)>

Get the keys and values of a map array

pub fn map<C: ErrorContext>( &mut self, keys: Value, ctx: &C, ) -> Result<(), C::Error>

Create a map array

impl<T: ArrayValue> Array<T>

pub fn deshape(&mut self)

Make the array 1-dimensional

pub fn fix(&mut self)

Add a 1-length dimension to the front of the array’s shape

pub fn unfix(&mut self, env: &Uiua) -> UiuaResult

Remove a 1-length dimension from the front of the array’s shape

pub fn undo_fix(&mut self)

Collapse the top two dimensions of the array’s shape

impl<T: ArrayValue> Array<T>

pub fn first(self, env: &Uiua) -> UiuaResult<Self>

Get the first row of the array

pub fn last(self, env: &Uiua) -> UiuaResult<Self>

Get the last row of the array

impl<T: Clone> Array<T>

pub fn reverse(&mut self)

Reverse the rows of the array

impl<T: ArrayValue> Array<T>

pub fn transpose(&mut self)

Transpose the array

impl<T: ArrayValue> Array<T>

pub fn rise(&self) -> Array<f64>

Get the rise of the array

pub fn fall(&self) -> Array<f64>

Get the fall of the array

pub fn sort_up(&mut self)

Sort an array ascending

pub fn sort_down(&mut self)

Sort an array descending

pub fn classify(&self) -> Vec<usize>

classify the rows of the array

pub fn deduplicate(&mut self, env: &Uiua) -> UiuaResult

deduplicate the rows of the array

pub fn unique(&self) -> Array<u8>

Mask the unique rows of the array

pub fn count_unique(&self) -> usize

Count the number of unique rows in the array

impl<T: RealArrayValue> Array<T>

pub fn bits(&self, env: &Uiua) -> UiuaResult<Value>

Encode the bits of the array

impl<T> Array<T>

where T: RealArrayValue, Array<T>: Into<Value>,

pub fn un_bits(&self, env: &Uiua) -> UiuaResult<Value>

Decode the bits of the array

impl<T> Array<T>

pub fn new(shape: impl Into<Shape>, data: impl Into<CowSlice<T>>) -> Self

Create an array from a shape and data

Panics

Panics in debug mode if the shape does not match the data length

pub fn row_count(&self) -> usize

Get the number of rows in the array

pub fn element_count(&self) -> usize

Get the number of elements in the array

pub fn row_len(&self) -> usize

Get the number of elements in a row

pub fn rank(&self) -> usize

Get the rank of the array

pub fn shape(&self) -> &Shape

Get the shape of the array

pub fn shape_mut(&mut self) -> &mut Shape

Get a mutable reference to the shape of the array

pub fn elements(&self) -> impl ExactDoubleIterator<Item = &T>

Iterate over the elements of the array

pub fn meta(&self) -> &ArrayMeta

Get the metadata of the array

pub fn get_meta_mut(&mut self) -> Option<&mut ArrayMeta>

Get a mutable reference to the metadata of the array if it exists

pub fn meta_mut(&mut self) -> &mut ArrayMeta

Get a mutable reference to the metadata of the array

pub fn take_label(&mut self) -> Option<EcoString>

Take the label from the metadata

pub fn take_map_keys(&mut self) -> Option<MapKeys>

Take the map keys from the metadata

pub fn take_per_meta(&mut self) -> PersistentMeta

The the persistent metadata of the array

pub fn set_per_meta(&mut self, per_meta: PersistentMeta)

Set the map keys in the metadata

pub fn map_keys(&self) -> Option<&MapKeys>

Get a reference to the map keys

pub fn map_keys_mut(&mut self) -> Option<&mut MapKeys>

Get a mutable reference to the map keys

pub fn reset_meta_flags(&mut self)

Reset all metadata flags

pub fn row_slices( &self, ) -> impl ExactSizeIterator<Item = &[T]> + DoubleEndedIterator + Clone + Send + Sync

where T: Send + Sync,

Get an iterator over the row slices of the array

pub fn row_slice(&self, row: usize) -> &[T]

Get a slice of a row

pub fn combine_meta(&mut self, other: &ArrayMeta)

Combine the metadata of two arrays

This combines:

• flags
• map keys
• handle kind

Notably, this does not combine the label, as label combination should be more nuanced.

impl<T: ArrayValue> Array<T>

pub fn scalar(data: T) -> Self

Create a scalar array

pub fn into_scalar(self) -> Result<T, Self>

Attempt to convert the array into a scalar

pub fn as_scalar(&self) -> Option<&T>

Attempt to get a reference to the scalar value

pub fn as_scalar_mut(&mut self) -> Option<&mut T>

Attempt to get a mutable reference to the scalar value

pub fn rows( &self, ) -> impl ExactSizeIterator<Item = Self> + DoubleEndedIterator + '_

Get an iterator over the row arrays of the array

pub fn row_shaped_slices( &self, row_shape: Shape, ) -> impl ExactSizeIterator<Item = Self> + DoubleEndedIterator + '_

Get an iterator over the row arrays of the array that have the given shape

pub fn into_row_shaped_slices( self, row_shape: Shape, ) -> impl DoubleEndedIterator<Item = Self>

Get an iterator over the row arrays of the array that have the given shape

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

Get a row array

pub fn slice_rows(&self, start: usize, end: usize) -> Self

Create an array that is a slice of this array’s rows

Generally doesn’t allocate

• start must be <= end
• start must be < self.row_count()
• end must be <= self.row_count()

pub fn into_rows( self, ) -> impl ExactSizeIterator<Item = Self> + DoubleEndedIterator

Consume the array and get an iterator over its rows

pub fn show(&self) -> String

Get a pretty-printed string representing the array

This is what is printed by the &s function

pub fn row_slice_mut(&mut self, row: usize) -> &mut [T]

Get a mutable slice of a row

impl<T: Clone> Array<T>

pub fn convert<U>(self) -> Array<U>

where T: Into<U> + 'static, U: Clone + 'static,

Convert the elements of the array

pub fn convert_with<U: Clone>(self, f: impl FnMut(T) -> U) -> Array<U>

Convert the elements of the array with a function

pub fn try_convert_with<U: Clone, E>( self, f: impl FnMut(T) -> Result<U, E>, ) -> Result<Array<U>, E>

Convert the elements of the array with a fallible function

pub fn convert_ref<U>(&self) -> Array<U>

where T: Into<U>, U: Clone,

Convert the elements of the array without consuming it

pub fn convert_ref_with<U: Clone>(&self, f: impl FnMut(T) -> U) -> Array<U>

Convert the elements of the array with a function without consuming it

impl Array<Boxed>

pub fn into_unboxed(self) -> Result<Value, Self>

Attempt to unbox a scalar box array

pub fn as_unboxed(&self) -> Option<&Value>

Attempt to unbox a scalar box array

pub fn as_unboxed_mut(&mut self) -> Option<&mut Value>

Attempt to unbox a scalar box array

impl<T: ArrayValue> Array<T>

pub fn shape_string(&self) -> String

Get a string representation of the shape of the array

Trait Implementations

impl<T: Clone> Clone for Array<T>

fn clone(&self) -> Array<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

where Array<T>: GridFmt,

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

Formats the value using the given formatter.

impl<T: ArrayValue> Default for Array<T>

fn default() -> Self

Returns the “default value” for a type.

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

where T: ArrayValueSer + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: ArrayValue> Display for Array<T>

where Array<T>: GridFmt,

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

Formats the value using the given formatter.

impl<'a, T: ArrayValue> From<&'a [T]> for Array<T>

fn from(data: &'a [T]) -> Self

Converts to this type from the input type.

impl From<Array<Boxed>> for Value

fn from(array: Array<Boxed>) -> Self

Converts to this type from the input type.

impl From<Array<Complex>> for Value

fn from(array: Array<Complex>) -> Self

Converts to this type from the input type.

impl From<Array<char>> for Value

fn from(array: Array<char>) -> Self

Converts to this type from the input type.

impl From<Array<f64>> for Value

fn from(array: Array<f64>) -> Self

Converts to this type from the input type.

impl From<Array<u8>> for Value

fn from(array: Array<u8>) -> Self

Converts to this type from the input type.

impl<T: ArrayValue> From<EcoVec<T>> for Array<T>

fn from(data: EcoVec<T>) -> Self

Converts to this type from the input type.

impl From<String> for Array<char>

fn from(s: String) -> Self

Converts to this type from the input type.

impl<T: ArrayValue> From<T> for Array<T>

fn from(data: T) -> Self

Converts to this type from the input type.

impl From<Vec<bool>> for Array<u8>

fn from(data: Vec<bool>) -> Self

Converts to this type from the input type.

impl From<Vec<usize>> for Array<f64>

fn from(data: Vec<usize>) -> Self

Converts to this type from the input type.

impl From<bool> for Array<u8>

fn from(data: bool) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<&'a str> for Array<Boxed>

fn from_iter<I: IntoIterator<Item = &'a str>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<String> for Array<Boxed>

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

Creates a value from an iterator.

impl<T: ArrayValue> FromIterator<T> for Array<T>

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

Creates a value from an iterator.

impl<T: ArrayValue> Hash for Array<T>

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: ArrayValue> Ord for Array<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: ArrayValue + ArrayCmp<U>, U: ArrayValue> PartialEq<Array<U>> for Array<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: ArrayValue + ArrayCmp<U>, U: ArrayValue> PartialOrd<Array<U>> for Array<T>

fn partial_cmp(&self, other: &Array<U>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for Array<T>

where T: ArrayValueSer + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: ArrayValue> Eq for Array<T>