Struct TurboCode 

pub struct TurboCode {
    pub polar_code: PolarCode,
    pub residual_sketch: QjlSketch,
}

A TurboQuant-compressed vector: polar code plus a QJL residual sketch.

Fields

polar_code: PolarCode

PolarQuant code capturing the main signal.

residual_sketch: QjlSketch

QJL sketch of the reconstruction residual (1 bit per projection).

Implementations

impl TurboCode

pub fn encoded_bytes(&self) -> usize

Total serialized payload bytes used by this code.

pub fn compression_ratio(&self) -> f32

Compression ratio relative to f32 storage of the original vector.

pub fn validate_for( &self, dim: usize, bits: u8, projections: usize, mode: TurboMode, ) -> Result<()>

Validate this code against an expected TurboQuant profile.

Trait Implementations

impl Clone for TurboCode

fn clone(&self) -> TurboCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TurboCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TurboCode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for TurboCode

fn schema_name() -> String

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 is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for TurboCode

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TurboCode