Skip to main content

RateBackend

Enum RateBackend 

Source
#[non_exhaustive]
pub enum RateBackend {
Show 13 variants RosaPlus { max_order: i64, }, Match { hash_bits: usize, min_len: usize, max_len: usize, base_mix: f64, confidence_scale: f64, }, SparseMatch { hash_bits: usize, min_len: usize, max_len: usize, gap_min: usize, gap_max: usize, base_mix: f64, confidence_scale: f64, }, Ppmd { order: usize, memory_mb: usize, }, Sequitur { context_bytes: usize, }, MambaMethod { method: MethodSpec, }, Rwkv7Method { method: MethodSpec, }, Zpaq { method: ZpaqMethodSpec, }, Mixture { spec: Arc<MixtureSpec>, }, Particle { spec: Arc<ParticleSpec>, }, Calibrated { spec: Arc<CalibratedSpec>, }, Ctw { depth: usize, }, FacCtw { base_depth: usize, num_percept_bits: usize, encoding_bits: usize, msb_first: Option<bool>, },
}
Expand description

Core predictive model class used by the library.

RateBackend is the shared model class behind entropy-rate estimation, rate-coded compression, generation, and the world-model interface used by MC-AIXI/AIQI planners.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

RosaPlus

ROSA+ suffix-automaton estimator.

max_order < 0 enables ROSA’s adaptive order selection over the full suffix automaton; max_order >= 0 caps the predictive context length.

Fields

§max_order: i64

Maximum context length used by the ROSA predictor.

< 0 means “adaptive / full SAM”; >= 0 is a fixed cap.

§

Match

Local contiguous match predictor.

Fields

§hash_bits: usize

Number of retained hash bits for suffix lookup.

§min_len: usize

Minimum repeat length required before predicting.

§max_len: usize

Maximum repeat length used for confidence scaling.

§base_mix: f64

Residual probability mass left for non-match symbols.

§confidence_scale: f64

Confidence multiplier applied to short-match tapering.

§

SparseMatch

Sparse/gapped local match predictor.

Fields

§hash_bits: usize

Number of retained hash bits for spaced-suffix lookup.

§min_len: usize

Minimum spaced repeat length required before predicting.

§max_len: usize

Maximum spaced repeat length used for confidence scaling.

§gap_min: usize

Minimum gap between matched bytes.

§gap_max: usize

Maximum gap between matched bytes.

§base_mix: f64

Residual probability mass left for non-match symbols.

§confidence_scale: f64

Confidence multiplier applied to short-match tapering.

§

Ppmd

Pure-Rust bounded-memory PPMD-style model.

Fields

§order: usize

Maximum context order.

§memory_mb: usize

Approximate memory budget in MiB.

§

Sequitur

Exact online Sequitur grammar backend with byte-level predictive readout.

Fields

§context_bytes: usize

Maximum number of terminal bytes retained per grammar-derived context.

§

MambaMethod

Typed Mamba method specification.

Fields

§method: MethodSpec

Mamba method specification.

§

Rwkv7Method

Typed RWKV7 method specification.

Fields

§method: MethodSpec

RWKV7 method specification.

§

Zpaq

ZPAQ compression-based rate model (streamable methods only).

Fields

§method: ZpaqMethodSpec

Typed ZPAQ method specification.

§

Mixture

Online mixture over RateBackend experts.

Bayes, Switching, and Convex follow “On Ensemble Techniques for AIXI Approximation”; FadingBayes, Mdl, and Neural are repository extensions.

Fields

§spec: Arc<MixtureSpec>

Mixture expert/runtime specification.

§

Particle

Particle-latent filter ensemble.

Fields

§spec: Arc<ParticleSpec>

Particle filter specification.

§

Calibrated

Calibrated wrapper over another bytewise backend.

Fields

§spec: Arc<CalibratedSpec>

Calibration specification.

§

Ctw

Action-Conditional CTW (single context tree).

Fields

§depth: usize

Context tree depth.

§

FacCtw

Factorized Action-Conditional CTW (k trees for k-bit percepts).

Fields

§base_depth: usize

Base context depth.

§num_percept_bits: usize

Planner/percept bit cardinality for AIXI-style consumers.

Rate-backend byte execution uses encoding_bits as the symbol decomposition width. num_percept_bits is retained for controller specs whose percept cardinality can differ from byte encoding width.

§encoding_bits: usize

Encoding width in bits for rate execution.

Valid compiled FAC-CTW specs require 1..=8.

§msb_first: Option<bool>

Optional bit order for decomposing symbols.

None keeps the compatibility default: 8-bit byte symbols use MSB-first ordering, while non-byte widths retain the legacy LSB-first FAC-CTW convention. Some(true) selects MSB-first explicitly; Some(false) selects legacy LSB-first explicitly.

Implementations§

Source§

impl RateBackend

Source

pub fn try_default() -> InfotheoryResult<Self>

Returns the current build’s implicit default rate backend.

Source

pub fn validate_in( &self, env: &SpecEnvironment, ) -> SpecResult<ValidatedRateBackend>

Validate and canonicalize this backend in the provided compilation environment.

Source

pub fn validate(&self) -> SpecResult<ValidatedRateBackend>

Validate and canonicalize this backend using the default environment.

Source

pub fn compile_in( &self, env: &SpecEnvironment, ) -> SpecResult<CompiledRateBackend>

Validate and compile this backend in the provided compilation environment.

Source

pub fn compile(&self) -> SpecResult<CompiledRateBackend>

Validate and compile this backend using the default environment.

Trait Implementations§

Source§

impl CanonicalJson for RateBackend

Source§

fn to_canonical_json_value(&self) -> SpecResult<Value>

Serialize this value into canonical JSON value form.
Source§

fn to_canonical_json(&self) -> SpecResult<String>

Serialize this value into deterministic canonical JSON text.
Source§

impl Clone for RateBackend

Source§

fn clone(&self) -> RateBackend

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.