Skip to main content

InfotheoryCtx

Struct InfotheoryCtx 

Source
pub struct InfotheoryCtx {
    pub rate_backend: CompiledRateBackend,
    pub compression_backend: CompiledCompressionBackend,
}
Expand description

Reusable execution context holding default rate and compression backends.

Fields§

§rate_backend: CompiledRateBackend

Default rate backend for entropy/rate metrics.

§compression_backend: CompiledCompressionBackend

Default compression backend for NCD/compression primitives.

Implementations§

Source§

impl InfotheoryCtx

Source

pub fn try_default() -> InfotheoryResult<Self>

Create the current build’s implicit default context.

Source

pub fn new( rate_backend: CompiledRateBackend, compression_backend: CompiledCompressionBackend, ) -> Self

Create a context from explicit rate and compression backends.

Source

pub fn from_specs( rate_backend: RateBackend, compression_backend: CompressionBackend, ) -> InfotheoryResult<Self>

Create a context from wrapper backend specs.

Source

pub fn try_with_zpaq( method: impl Into<ZpaqMethodSpec>, ) -> InfotheoryResult<Self>

Create a context with adaptive ROSA+ rate backend and ZPAQ compression backend.

Source

pub fn try_compress_size(&self, data: &[u8]) -> InfotheoryResult<u64>

Compressed length of one byte slice under this context’s compressor.

Source

pub fn try_compress_size_chain(&self, parts: &[&[u8]]) -> InfotheoryResult<u64>

Compressed length of chained slices under one stream.

Source

pub fn rate_backend_session( &self, total_symbols: Option<u64>, ) -> InfotheoryResult<RateBackendSession>

Create a stateful session for the active rate backend.

Source

pub fn rate_backend_bit_session( &self, total_bits: Option<u64>, semantics: BitStreamSemantics, ) -> InfotheoryResult<RateBackendBitSession>

Create a stateful bit-level session for the active rate backend.

Source

pub fn try_entropy_rate_bytes(&self, data: &[u8]) -> InfotheoryResult<f64>

Fallible entropy-rate estimate for data under this context’s rate backend.

Source

pub fn try_biased_entropy_rate_bytes( &self, data: &[u8], ) -> InfotheoryResult<f64>

Fallible biased entropy-rate estimate (plugin variant) for data.

Source

pub fn try_cross_entropy_rate_bytes( &self, test_data: &[u8], train_data: &[u8], ) -> InfotheoryResult<f64>

Fallible cross entropy of test_data under model trained on train_data.

Source

pub fn try_cross_entropy_bytes( &self, test_data: &[u8], train_data: &[u8], ) -> InfotheoryResult<f64>

Cross entropy under the active rate backend.

Source

pub fn try_joint_entropy_rate_bytes( &self, x: &[u8], y: &[u8], ) -> InfotheoryResult<f64>

Fallible joint entropy-rate estimate H(X,Y) under aligned-prefix semantics.

Source

pub fn try_conditional_entropy_rate_bytes( &self, x: &[u8], y: &[u8], ) -> InfotheoryResult<f64>

Fallible conditional entropy-rate estimate H(X|Y).

Source

pub fn try_cross_entropy_conditional_chain( &self, prefix_parts: &[&[u8]], data: &[u8], ) -> InfotheoryResult<f64>

Fallible H(data | prefix_parts) by conditioning the active rate backend on an explicit prefix chain.

Source

pub fn try_generate_bytes( &self, prompt: &[u8], bytes: usize, ) -> InfotheoryResult<Vec<u8>>

Generate a continuation from prompt with GenerationConfig::default().

Source

pub fn try_generate_bytes_with_config( &self, prompt: &[u8], bytes: usize, config: GenerationConfig, ) -> InfotheoryResult<Vec<u8>>

Fallible continuation generation from prompt using an explicit config.

Source

pub fn try_generate_bytes_conditional_chain( &self, prefix_parts: &[&[u8]], bytes: usize, ) -> InfotheoryResult<Vec<u8>>

Generate a continuation after conditioning on an explicit chain of prefix parts.

Source

pub fn try_generate_bytes_conditional_chain_with_config( &self, prefix_parts: &[&[u8]], bytes: usize, config: GenerationConfig, ) -> InfotheoryResult<Vec<u8>>

Fallible continuation generation after conditioning on an explicit chain of prefix parts.

Source

pub fn try_ncd_bytes( &self, x: &[u8], y: &[u8], variant: NcdVariant, ) -> InfotheoryResult<f64>

NCD between byte slices using this context’s compression backend.

Source

pub fn try_mutual_information_rate_bytes( &self, x: &[u8], y: &[u8], ) -> InfotheoryResult<f64>

Rate-backend mutual information estimate.

Source

pub fn try_mutual_information_bytes( &self, x: &[u8], y: &[u8], ) -> InfotheoryResult<f64>

Mutual information under the active rate backend.

Source

pub fn try_conditional_entropy_bytes( &self, x: &[u8], y: &[u8], ) -> InfotheoryResult<f64>

Conditional entropy H(X|Y) under the active rate backend.

Source

pub fn try_ned_bytes(&self, x: &[u8], y: &[u8]) -> InfotheoryResult<f64>

Normalized entropy distance (NED) under this context’s rate backend.

Source

pub fn try_ned_cons_bytes(&self, x: &[u8], y: &[u8]) -> InfotheoryResult<f64>

Conservative NED normalization variant under this context’s rate backend.

Source

pub fn try_nte_bytes(&self, x: &[u8], y: &[u8]) -> InfotheoryResult<f64>

Normalized transform effort (NTE) under this context’s rate backend.

Source

pub fn try_intrinsic_dependence_bytes( &self, data: &[u8], ) -> InfotheoryResult<f64>

Intrinsic dependence score in [0,1] driven by (H₀(X) - Ĥ(X)) / H₀(X), where H₀ is the order-0 / empirical entropy and Ĥ is the entropy rate produced by this context’s rate backend.

Source

pub fn try_resistance_to_transformation_bytes( &self, x: &[u8], tx: &[u8], ) -> InfotheoryResult<f64>

Resistance-to-transformation ratio I(X;T(X))/H(X) in [0,1] under this context’s rate backend.

Trait Implementations§

Source§

impl Clone for InfotheoryCtx

Source§

fn clone(&self) -> InfotheoryCtx

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> AsAny for T
where T: Any,

§

fn as_any(&self) -> &(dyn Any + 'static)

Return the immutable any encapsulated object.
§

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

Return the mutable encapsulated any object.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.