Enum numcodecs_zfp::ZfpCompressionMode

pub enum ZfpCompressionMode {
    Expert {
        min_bits: u32,
        max_bits: u32,
        max_prec: u32,
        min_exp: i32,
    },
    FixedRate {
        rate: f64,
    },
    FixedPrecision {
        precision: u32,
    },
    FixedAccuracy {
        tolerance: f64,
    },
    Reversible,
}

ZFP compression mode

Variants

Expert

The most general mode, which can describe all four other modes

Fields

min_bits: u32

Minimum number of compressed bits used to represent a block

max_bits: u32

Maximum number of bits used to represent a block

max_prec: u32

Maximum number of bit planes encoded

min_exp: i32

Smallest absolute bit plane number encoded.

This parameter applies to floating-point data only and is ignored for integer data.

FixedRate

In fixed-rate mode, each d-dimensional compressed block of 4^d values is stored using a fixed number of bits. This number of compressed bits per block is amortized over the 4^d values to give a rate of rate = max_bits / 4^d in bits per value.

Fields

rate: f64

Rate in bits per value

FixedPrecision

In fixed-precision mode, the number of bits used to encode a block may vary, but the number of bit planes (the precision) encoded for the transform coefficients is fixed.

Fields

precision: u32

Number of bit planes encoded

FixedAccuracy

In fixed-accuracy mode, all transform coefficient bit planes up to a minimum bit plane number are encoded. The smallest absolute bit plane number is chosen such that minexp = floor(log2(tolerance)).

Fields

tolerance: f64

Absolute error tolerance

Reversible

Lossless per-block compression that preserves integer and floating point bit patterns.

Trait Implementations

impl Clone for ZfpCompressionMode

fn clone(&self) -> ZfpCompressionMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZfpCompressionMode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ZfpCompressionMode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ZfpCompressionMode

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 ZfpCompressionMode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.