Struct TensorDimension

pub struct TensorDimension {
    pub size: u64,
    pub name: Option<String>,
}

Flattened Tensor data payload

Examples

assert_eq!(
    TensorDimension::data_type(),
    DataType::Struct(vec![
        Field::new("size", DataType::UInt64, false),
        Field::new("name", DataType::Utf8, true),
    ])
);

Fields

size: u64

Number of elements on this dimension. I.e. size-1 is the maximum allowed index.

name: Option<String>

Optional name of the dimension, e.g. “color” or “width”

Implementations

impl TensorDimension

pub fn height(size: u64) -> Self

pub fn width(size: u64) -> Self

pub fn depth(size: u64) -> Self

pub fn named(size: u64, name: String) -> Self

pub fn unnamed(size: u64) -> Self

Trait Implementations

impl ArrowDeserialize for TensorDimension

type ArrayType = TensorDimensionArray

The arrow2::Array type corresponding to this field

fn arrow_deserialize<'a>(v: Option<Self>) -> Option<Self>

Deserialize this field from arrow

impl ArrowField for TensorDimension

type Type = TensorDimension

This should be Self except when implementing large offset and fixed placeholder types. For the later, it should refer to the actual type. For example when the placeholder type is LargeString, this should be String.

fn data_type() -> DataType

The DataType

impl ArrowSerialize for TensorDimension

type MutableArrayType = MutableTensorDimensionArray

The arrow2::array::MutableArray that holds this value

fn new_array() -> Self::MutableArrayType

Create a new mutable array

fn arrow_serialize(v: &Self, array: &mut Self::MutableArrayType) -> Result<()>

Serialize this field to arrow

impl Clone for TensorDimension

fn clone(&self) -> TensorDimension

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TensorDimension

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TensorDimension

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TensorDimension

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

Formats the value using the given formatter.

impl PartialEq for TensorDimension

fn eq(&self, other: &TensorDimension) -> 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 Serialize for TensorDimension

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 TensorDimension

impl StructuralPartialEq for TensorDimension