Struct PcodecDeltaEncodingOrder

pub struct PcodecDeltaEncodingOrder(/* private fields */);

Available on crate feature pcodec only.

An integer from 0 to 7 controlling the delta encoding order.

It is the number of times to apply delta encoding before compressing. See https://docs.rs/pco/latest/pco/enum.DeltaSpec.html.

• 0th order takes numbers as-is. This is perfect for columnar data were the order is essentially random.
• 1st order takes consecutive differences, leaving [0, 2, 0, 2, 0, 2, 0]. This is best for continuous but noisy time series data, like stock prices or most time series data.
• 2nd order takes consecutive differences again, leaving [2, -2, 2, -2, 2, -2]. This is best for piecewise-linear or somewhat quadratic data.
• Even higher-order is best for time series that are very smooth, like temperature or light sensor readings.

Implementations

impl PcodecDeltaEncodingOrder

pub fn new<N>(delta_encoding_order: N) -> Result<PcodecDeltaEncodingOrder, N>

where N: Unsigned + PartialOrd<u8>, u8: TryFrom<N>,

Create a new delta encoding order.

Errors

Errors if delta_encoding_order is not between 0-7.

pub const fn as_usize(&self) -> usize

The underlying delta encoding order.

Trait Implementations

impl Clone for PcodecDeltaEncodingOrder

fn clone(&self) -> PcodecDeltaEncodingOrder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PcodecDeltaEncodingOrder

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PcodecDeltaEncodingOrder

fn deserialize<D>( d: D, ) -> Result<PcodecDeltaEncodingOrder, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PcodecDeltaEncodingOrder

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<u16> for PcodecDeltaEncodingOrder

type Error = u16

The type returned in the event of a conversion error.

fn try_from( level: u16, ) -> Result<PcodecDeltaEncodingOrder, <PcodecDeltaEncodingOrder as TryFrom<u16>>::Error>

Performs the conversion.

impl TryFrom<u32> for PcodecDeltaEncodingOrder

type Error = u32

The type returned in the event of a conversion error.

fn try_from( level: u32, ) -> Result<PcodecDeltaEncodingOrder, <PcodecDeltaEncodingOrder as TryFrom<u32>>::Error>

Performs the conversion.

impl TryFrom<u64> for PcodecDeltaEncodingOrder

type Error = u64

The type returned in the event of a conversion error.

fn try_from( level: u64, ) -> Result<PcodecDeltaEncodingOrder, <PcodecDeltaEncodingOrder as TryFrom<u64>>::Error>

Performs the conversion.

impl TryFrom<u8> for PcodecDeltaEncodingOrder

type Error = u8

The type returned in the event of a conversion error.

fn try_from( level: u8, ) -> Result<PcodecDeltaEncodingOrder, <PcodecDeltaEncodingOrder as TryFrom<u8>>::Error>

Performs the conversion.

impl TryFrom<usize> for PcodecDeltaEncodingOrder

type Error = usize

The type returned in the event of a conversion error.

fn try_from( level: usize, ) -> Result<PcodecDeltaEncodingOrder, <PcodecDeltaEncodingOrder as TryFrom<usize>>::Error>

Performs the conversion.

impl Copy for PcodecDeltaEncodingOrder

impl Eq for PcodecDeltaEncodingOrder

impl StructuralPartialEq for PcodecDeltaEncodingOrder