Enum uiua::Value

#[repr(C)]
pub enum Value {
    Num(Array<f64>),
    Byte(Array<u8>),
    Complex(Array<Complex>),
    Char(Array<char>),
    Box(Array<Boxed>),
}

A generic array value

This enum is used to represent all possible array types.

Variants

Num(Array<f64>)

Common number array

Byte(Array<u8>)

Byte array used for some boolean operations and for I/O

Complex(Array<Complex>)

Complex number array

Char(Array<char>)

Common character array

Box(Array<Boxed>)

Common box array

Implementations

impl Value

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

join the array with another

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

join the array with another

Panics

Panics if the arrays have incompatible shapes

impl Value

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

couple the value with another

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

couple the value with another

Panics

Panics if the values have incompatible shapes

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

Uncouple the value into two values

impl Value

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

where V: IntoIterator, V::Item: Into<Value>, V::IntoIter: ExactSizeIterator,

Create a value from row values

Panics

Panics if the row values have incompatible shapes

pub fn from_row_values<V, C>(values: V, ctx: &C) -> Result<Self, C::Error>

where V: IntoIterator<Item = Value>, V::IntoIter: ExactSizeIterator, C: FillContext,

Create a value from row values

impl Value

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

Use this array as an index to pick from another

impl Value

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

Use this value to take from another

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

Use this value to drop from another

impl Value

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

Use this value to select from another

impl Value

pub fn reshape(&mut self, shape: &Self, env: &Uiua) -> UiuaResult

reshape this value with another

impl Value

pub fn rerank(&mut self, rank: &Self, env: &Uiua) -> UiuaResult

rerank this value with another

impl Value

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

Use this value as counts to keep another

impl Value

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

Use this value to rotate another

impl Value

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

Use this array to windows another

impl Value

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

Try to find this value in another

impl Value

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

Check which rows of this value are members of another

impl Value

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

Get the index of the rows of this value in another

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

Get the progressive index of the rows of this value in another

impl Value

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

Create a map array

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

Turn a map array into its keys and values

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

Get a value from a map array

pub fn has_key(&self, key: &Value, env: &Uiua) -> UiuaResult<bool>

Check if a map array contains a key

pub fn insert(&mut self, key: Value, value: Value, env: &Uiua) -> UiuaResult

Insert a key-value pair into a map array

pub fn remove(&mut self, key: Value, env: &Uiua) -> UiuaResult

Remove a key-value pair from a map array

impl Value

pub fn deshape(&mut self)

Make the value 1-dimensional

pub fn fix(&mut self)

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

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

Attempt to parse the value into a number

pub fn representation(&self) -> Self

Convert value into a string that can be understood by the interpreter

impl Value

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

Create a range array

impl Value

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

Get the first row of the value

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

Get the last row of the value

impl Value

pub fn reverse(&mut self)

Reverse the rows of the value

impl Value

pub fn transpose(&mut self)

Transpose the value

impl Value

pub fn rise(&self, env: &Uiua) -> UiuaResult<Vec<usize>>

Get the rise of the value

pub fn fall(&self, env: &Uiua) -> UiuaResult<Vec<usize>>

Get the fall of the value

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

Sort the value ascending

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

Sort the value descending

pub fn classify(&self) -> Self

classify the rows of the value

pub fn deduplicate(&mut self)

deduplicate the rows of the value

pub fn unique(&self) -> Self

Mask the unique rows of the value

impl Value

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

Encode the bits of the value

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

Decode the bits of the value

impl Value

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

Get the indices where the value is nonzero

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

Get the first index where the value is nonzero

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

un where

impl Value

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

Convert a string value to a list of UTF-8 bytes

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

Convert a list of UTF-8 bytes to a string value

impl Value

pub fn as_num_array(&self) -> Option<&Array<f64>>

Get a reference to a possible number array

pub fn as_byte_array(&self) -> Option<&Array<u8>>

Get a reference to a possible byte array

pub fn as_char_array(&self) -> Option<&Array<char>>

Get a reference to a possible character array

pub fn as_box_array(&self) -> Option<&Array<Boxed>>

Get a reference to a possible box array

pub fn as_box(&self) -> Option<&Boxed>

Get a reference to a possible scalar box

pub fn rows(&self) -> Box<dyn ExactSizeIterator<Item = Self> + '_>

Get an iterator over the rows of the value

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

Get an iterator over the rows of the value that have the given shape

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

Get an iterator over the rows of the value that have the given shape

pub fn into_rows(self) -> Box<dyn ExactDoubleIterator<Item = Self>>

Consume the value and get an iterator over its rows

pub fn into_elements(self) -> Box<dyn Iterator<Item = Self>>

Cosume the value and get an iterator over its elements

pub fn type_name(&self) -> &'static str

Get the value’s type name

pub fn type_name_plural(&self) -> &'static str

Get a plural form of the value’s type name

pub fn row_count(&self) -> usize

Get the number of rows

pub fn row_len(&self) -> usize

Get the number of element in each row

pub fn rank(&self) -> usize

Get the rank

impl Value

pub fn shape(&self) -> &Shape

Get the shape of the value

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

Get a mutable reference to the shape

pub fn element_count(&self) -> usize

Get the number of elements

pub fn meta(&self) -> &ArrayMeta

Get the value’s metadata

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

Get a mutable reference to the value’s metadata

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

Take the label from the value

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

Combine this value’s metadata with another

pub fn reset_meta(&mut self)

Reset this value’s metadata

pub fn reset_meta_flags(&mut self)

Reset this value’s metadata flags

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

Get the row at the given index

pub fn show(&self) -> String

Get the pretty-printed string representation of the value that appears in output

pub fn format(&self) -> String

Get the pretty-printed string representation of the value that appears when formatted

pub fn as_ints( &self, env: &Uiua, requirement: &'static str ) -> UiuaResult<Vec<isize>>

Attempt to convert the array to a list of integers

The requirement parameter is used in error messages.

pub fn as_bool(&self, env: &Uiua, requirement: &'static str) -> UiuaResult<bool>

Attempt to convert the array to a single boolean

The requirement parameter is used in error messages.

pub fn as_nat(&self, env: &Uiua, requirement: &'static str) -> UiuaResult<usize>

Attempt to convert the array to a single natural number

The requirement parameter is used in error messages.

pub fn as_int(&self, env: &Uiua, requirement: &'static str) -> UiuaResult<isize>

Attempt to convert the array to a single integer

The requirement parameter is used in error messages.

pub fn as_num(&self, env: &Uiua, requirement: &'static str) -> UiuaResult<f64>

Attempt to convert the array to a single number

The requirement parameter is used in error messages.

pub fn as_nums( &self, env: &Uiua, requirement: &'static str ) -> UiuaResult<Vec<f64>>

Attempt to convert the array to a list of numbers

The requirement parameter is used in error messages.

pub fn as_nats( &self, env: &Uiua, requirement: &'static str ) -> UiuaResult<Vec<usize>>

Attempt to convert the array to a list of natural numbers

The requirement parameter is used in error messages.

pub fn as_bytes( &self, env: &Uiua, requirement: &'static str ) -> UiuaResult<Vec<u8>>

Attempt to convert the array to a list of bytes

The requirement parameter is used in error messages.

pub fn as_rank_list( &self, env: &Uiua, requirement: &'static str ) -> UiuaResult<Vec<Option<isize>>>

Attempt to convert the array to a list of integers or infinity

None represents infinity.

The requirement parameter is used in error messages.

pub fn as_string( &self, env: &Uiua, requirement: &'static str ) -> UiuaResult<String>

Attempt to convert the array to a string

The requirement parameter is used in error messages.

pub fn into_bytes( self, env: &Uiua, requirement: &'static str ) -> UiuaResult<Vec<u8>>

Attempt to convert the array to a list of bytes

The requirement parameter is used in error messages.

pub fn unpack(&mut self)

Remove all top-level layers of boxing

pub fn unpacked(self) -> Self

Remove all top-level layers of boxing

pub fn map_boxed(self, f: impl FnOnce(Self) -> Self) -> Self

Apply a function to the highest-level unboxed value

pub fn try_map_boxed( self, f: impl FnOnce(Self) -> UiuaResult<Self> ) -> UiuaResult<Self>

Apply a function to the highest-level unboxed value

pub fn unbox(&mut self)

Remove a single layer of boxing

pub fn unboxed(self) -> Self

Remove a single layer of boxing

pub fn box_if_not(&mut self)

Turn the value into a scalar box if it is not one already

pub fn boxed_if_not(self) -> Boxed

Turn the value into a scalar box if it is not one already

pub fn compress(&mut self)

Turn a number array into a byte array if no information is lost.

Does nothing without the bytes feature enabled.

pub fn coerce_to_boxes(self) -> Array<Boxed>

Convert to a box array by boxing every element

pub fn coerce_as_boxes(&self) -> Cow<'_, Array<Boxed>>

Convert to a box array by boxing every element

pub fn keep_label( self, f: impl FnOnce(Self) -> UiuaResult<Self> ) -> UiuaResult<Self>

Propogate a value’s label accross an operation

pub fn keep_labels( self, other: Self, f: impl FnOnce(Self, Self) -> UiuaResult<Self> ) -> UiuaResult<Self>

Propogate values’ labels accross an operation

Trait Implementations

impl AsMut<Value> for Boxed

fn as_mut(&mut self) -> &mut Value

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Value> for Boxed

fn as_ref(&self) -> &Value

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<Value> for Boxed

fn borrow(&self) -> &Value

Immutably borrows from an owned value.

impl BorrowMut<Value> for Boxed

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

Mutably borrows from an owned value.

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Value

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Value

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for Value

fn from(s: &'a str) -> Self

Converts to this type from the input type.

impl From<(Shape, CowSlice<Boxed>)> for Value

fn from((shape, data): (Shape, CowSlice<Boxed>)) -> Self

Converts to this type from the input type.

impl From<(Shape, CowSlice<Complex>)> for Value

fn from((shape, data): (Shape, CowSlice<Complex>)) -> Self

Converts to this type from the input type.

impl From<(Shape, CowSlice<char>)> for Value

fn from((shape, data): (Shape, CowSlice<char>)) -> Self

Converts to this type from the input type.

impl From<(Shape, CowSlice<f64>)> for Value

fn from((shape, data): (Shape, CowSlice<f64>)) -> Self

Converts to this type from the input type.

impl From<(Shape, CowSlice<u8>)> for Value

fn from((shape, data): (Shape, CowSlice<u8>)) -> Self

Converts to this type from the input type.

impl From<(Shape, EcoVec<Boxed>)> for Value

fn from((shape, data): (Shape, EcoVec<Boxed>)) -> Self

Converts to this type from the input type.

impl From<(Shape, EcoVec<Complex>)> for Value

fn from((shape, data): (Shape, EcoVec<Complex>)) -> Self

Converts to this type from the input type.

impl From<(Shape, EcoVec<char>)> for Value

fn from((shape, data): (Shape, EcoVec<char>)) -> Self

Converts to this type from the input type.

impl From<(Shape, EcoVec<f64>)> for Value

fn from((shape, data): (Shape, EcoVec<f64>)) -> Self

Converts to this type from the input type.

impl From<(Shape, EcoVec<u8>)> for Value

fn from((shape, data): (Shape, EcoVec<u8>)) -> 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 From<Boxed> for Value

fn from(item: Boxed) -> Self

Converts to this type from the input type.

impl From<Complex> for Value

fn from(item: Complex) -> Self

Converts to this type from the input type.

impl From<EcoVec<Boxed>> for Value

fn from(vec: EcoVec<Boxed>) -> Self

Converts to this type from the input type.

impl From<EcoVec<Complex>> for Value

fn from(vec: EcoVec<Complex>) -> Self

Converts to this type from the input type.

impl From<EcoVec<char>> for Value

fn from(vec: EcoVec<char>) -> Self

Converts to this type from the input type.

impl From<EcoVec<f64>> for Value

fn from(vec: EcoVec<f64>) -> Self

Converts to this type from the input type.

impl From<EcoVec<u8>> for Value

fn from(vec: EcoVec<u8>) -> Self

Converts to this type from the input type.

impl From<Handle> for Value

fn from(handle: Handle) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Value> for Boxed

fn from(v: Value) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<char> for Value

fn from(item: char) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(item: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(i: i32) -> Self

Converts to this type from the input type.

impl From<u8> for Value

fn from(item: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Value

fn from(i: usize) -> Self

Converts to this type from the input type.

impl FromIterator<Boxed> for Value

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

Creates a value from an iterator.

impl FromIterator<Complex> for Value

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

Creates a value from an iterator.

impl FromIterator<char> for Value

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

Creates a value from an iterator.

impl FromIterator<f64> for Value

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

Creates a value from an iterator.

impl FromIterator<u8> for Value

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

Creates a value from an iterator.

impl FromIterator<usize> for Value

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

Creates a value from an iterator.

impl Hash for Value

fn hash<H: Hasher>(&self, state: &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 Ord for Value

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Value

fn eq(&self, other: &Self) -> 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 PartialOrd for Value

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Value

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Value