Enum smartnoise_validator::base::Value

pub enum Value {
    Array(Array),
    Dataframe(IndexMap<IndexKey, Value>),
    Partitions(IndexMap<IndexKey, Value>),
    Jagged(Jagged),
    Function(Function),
}

The universal data representation.

Arguments to components are hash-maps of Value and the result of a component is a Value. The Value is also used in the validator for public arguments.

The Value has a one-to-one mapping to a protobuf Value.

Components unwrap arguments into more granular types, like ndarray::Array1, run a computation, and then repackage the result back into a Value.

Variants

Array(Array)

An arbitrary-dimensional homogeneously typed array

Dataframe(IndexMap<IndexKey, Value>)

An index-map, where the keys are enum-typed and the values are of type Value

Partitions(IndexMap<IndexKey, Value>)

An index-map, where the keys are enum-typed and the values are of type Value

Jagged(Jagged)

A 2D homogeneously typed matrix, where the columns may be unknown and the column lengths may be inconsistent

Function(Function)

An arbitrary function expressed in the graph language

Implementations

impl Value

pub fn array(self) -> Result<Array>

Retrieve an Array from a Value, assuming the Value contains an Array

pub fn ref_array(&self) -> Result<&Array>

pub fn jagged(self) -> Result<Jagged>

Retrieve Jagged from a Value, assuming the Value contains Jagged

pub fn ref_jagged(&self) -> Result<&Jagged>

pub fn dataframe(self) -> Result<IndexMap<IndexKey, Value>>

pub fn partitions(self) -> Result<IndexMap<IndexKey, Value>>

pub fn ref_partitions(&self) -> Result<&IndexMap<IndexKey, Value>>

pub fn function(self) -> Result<Function>

pub fn from_index_key(key: IndexKey) -> Result<Self>

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

pub 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<T> From<ArrayBase<OwnedRepr<String>, Dim<T>>> for Value where
    Dim<T>: Dimension, 

fn from(value: Array<String, Dim<T>>) -> Self

Performs the conversion.

impl<T> From<ArrayBase<OwnedRepr<bool>, Dim<T>>> for Value where
    Dim<T>: Dimension, 

fn from(value: Array<bool, Dim<T>>) -> Self

Performs the conversion.

impl<T> From<ArrayBase<OwnedRepr<f64>, Dim<T>>> for Value where
    Dim<T>: Dimension, 

fn from(value: Array<Float, Dim<T>>) -> Self

Performs the conversion.

impl<T> From<ArrayBase<OwnedRepr<i64>, Dim<T>>> for Value where
    Dim<T>: Dimension, 

fn from(value: Array<Integer, Dim<T>>) -> Self

Performs the conversion.

impl From<String> for Value

fn from(value: String) -> Self

Performs the conversion.

impl From<bool> for Value

fn from(value: bool) -> Self

Performs the conversion.

impl From<f64> for Value

fn from(value: Float) -> Self

Performs the conversion.

impl From<i64> for Value

fn from(value: Integer) -> Self

Performs the conversion.

impl PartialEq<Value> for Value

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.