Struct AsinhCodec

pub struct AsinhCodec {
    pub linear_width: f64,
    pub version: StaticCodecVersion<1, 0, 0>,
}

Asinh codec, which applies a quasi-logarithmic transformation on encoding.

For values close to zero that are within the codec’s linear_width, the transform is close to linear. For values of larger magnitudes, the transform is asymptotically logarithmic. Unlike a logarithmic transform, this codec supports all finite values, including negative values and zero.

In detail, the codec calculates $c = w \cdot \text{asinh}\left( \frac{x}{w} \right)$ on encoding and $d = w \cdot \text{sinh}\left( \frac{c}{w} \right)$ on decoding, where $w$ is the codec’s linear_width.

The codec only supports finite floating point numbers.

Fields

linear_width: f64

The width of the close-to-zero input value range where the transform is nearly linear

version: StaticCodecVersion<1, 0, 0>

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

Trait Implementations

impl Clone for AsinhCodec

fn clone(&self) -> AsinhCodec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Codec for AsinhCodec

type Error = AsinhCodecError

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 AsinhCodec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for AsinhCodec

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 AsinhCodec

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 AsinhCodec

const CODEC_ID: &'static str = "asinh.rs"

Codec identifier.

type Config<'de> = AsinhCodec

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.