Struct StochasticRoundingCodec

pub struct StochasticRoundingCodec {
    pub precision: NonNegative<f64>,
    pub seed: u64,
    pub version: StaticCodecVersion<1, 0, 0>,
}

Codec that stochastically rounds the data to the nearest multiple of precision on encoding and passes through the input unchanged during decoding.

The nearest representable multiple is chosen such that the absolute difference between the original value and the rounded value do not exceed the precision. Therefore, the rounded value may have a non-zero remainder.

This codec first hashes the input array data and shape to then seed a pseudo-random number generator that is used to sample the stochasticity for rounding. Therefore, passing in the same input with the same seed will produce the same stochasticity and thus the same encoded output.

Fields

precision: NonNegative<f64>

The precision of the rounding operation

seed: u64

Seed for the random generator

version: StaticCodecVersion<1, 0, 0>

The codec’s encoding format version. Do not provide this parameter explicitly.

Trait Implementations

impl Clone for StochasticRoundingCodec

fn clone(&self) -> StochasticRoundingCodec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Codec for StochasticRoundingCodec

type Error = StochasticRoundingCodecError

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 StochasticRoundingCodec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for StochasticRoundingCodec

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 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 StochasticRoundingCodec

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 StochasticRoundingCodec

const CODEC_ID: &'static str = "stochastic-rounding.rs"

Codec identifier.

type Config<'de> = StochasticRoundingCodec

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.