Struct numcodecs_swizzle_reshape::SwizzleReshapeCodec

pub struct SwizzleReshapeCodec {
    pub axes: Vec<AxisGroup>,
}

Codec to swizzle/swap the axes of an array and reshape it.

This codec does not store metadata about the original shape of the array. Since axes that have been combined during encoding cannot be split without further information, decoding may fail if an output array is not provided.

Swizzling axes is always supported since no additional information about the array’s shape is required to reconstruct it.

Fields

axes: Vec<AxisGroup>

The permutation of the axes that is applied on encoding.

The permutation is given as a list of axis groups, where each group corresponds to one encoded output axis that may consist of several decoded input axes. For instance, [[0], [1, 2]] flattens a three- dimensional array into a two-dimensional one by combining the second and third axes.

The permutation also allows specifying a special catch-all remaining axes marker:

• [[0], {}] moves the second axis to be the first and appends all other axes afterwards, i.e. the encoded array has the same number of axes as the input array
• [[0], [{}]] in contrast collapses all other axes into one, i.e. the encoded array is two-dimensional

Trait Implementations

impl Clone for SwizzleReshapeCodec

fn clone(&self) -> SwizzleReshapeCodec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Codec for SwizzleReshapeCodec

type Error = SwizzleReshapeCodecError

Error type that may be returned during encodeing and decodeing.

fn encode(&self, data: AnyCowArray<'_>) -> Result<AnyArray, Self::Error>

Encodes the data and returns the result.

fn decode(&self, encoded: AnyCowArray<'_>) -> Result<AnyArray, Self::Error>

Decodes the encoded data and returns the result.

fn decode_into( &self, encoded: AnyArrayView<'_>, decoded: AnyArrayViewMut<'_>, ) -> Result<(), Self::Error>

Decodes the encoded data and writes the result into the provided decoded output.

impl<'de> Deserialize<'de> for SwizzleReshapeCodec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SwizzleReshapeCodec

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn always_inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for SwizzleReshapeCodec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticCodec for SwizzleReshapeCodec

const CODEC_ID: &'static str = "swizzle-reshape"

Codec identifier.

type Config<'de> = SwizzleReshapeCodec

Configuration type, from which the codec can be created infallibly.

fn from_config(config: Self::Config<'_>) -> Self

Instantiate a codec from its configuration.

fn get_config(&self) -> StaticCodecConfig<'_, Self>

Get the configuration for this codec.