Struct FixedShapeTensorMetadata

pub struct FixedShapeTensorMetadata {
    shape: Vec<usize>,
    dim_names: Option<Vec<String>>,
    permutations: Option<Vec<usize>>,
}

Extension type metadata for FixedShapeTensor.

Fields

shape: Vec<usize>

The physical shape of the contained tensors.

dim_names: Option<Vec<String>>

Explicit names to tensor dimensions.

permutations: Option<Vec<usize>>

Indices of the desired ordering of the original dimensions.

Implementations

impl FixedShapeTensorMetadata

pub fn try_new( shape: impl IntoIterator<Item = usize>, dimension_names: Option<Vec<String>>, permutations: Option<Vec<usize>>, ) -> Result<Self, ArrowError>

Returns metadata for a fixed shape tensor extension type.

Error

Return an error if the provided dimension names or permutations are invalid.

pub fn list_size(&self) -> usize

Returns the product of all the elements in tensor shape.

pub fn dimensions(&self) -> usize

Returns the number of dimensions in this fixed shape tensor.

pub fn dimension_names(&self) -> Option<&[String]>

Returns the names of the dimensions in this fixed shape tensor, if set.

pub fn permutations(&self) -> Option<&[usize]>

Returns the indices of the desired ordering of the original dimensions, if set.

Trait Implementations

impl Clone for FixedShapeTensorMetadata

fn clone(&self) -> FixedShapeTensorMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FixedShapeTensorMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FixedShapeTensorMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FixedShapeTensorMetadata

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FixedShapeTensorMetadata