Skip to main content

EcsReport

Struct EcsReport 

Source
pub struct EcsReport {
Show 16 fields pub spec_version: String, pub codec: String, pub dataset: String, pub n_files: usize, pub bit_exact: bool, pub grade: char, pub cr: f64, pub prd: f64, pub prdn: f64, pub r: f64, pub snr_db: f64, pub qs: f64, pub per_band: Vec<BandResult>, pub throughput_mibs: f64, pub peak_bytes: u64, pub violations: Vec<String>,
}
Expand description

The standard OpenECS report for one codec evaluated on one dataset.

This is the canonical, self-describing record the standard produces: every field a third party needs to reproduce, audit, or compare the claim is present. It serializes to stable JSON (the exchange format) via EcsReport::to_json and renders a human-aligned summary via EcsReport::human_table. The cross-codec comparison output is leaderboard.

Field groups:

  • identity: codec, dataset, n_files
  • verdict: bit_exact, grade
  • aggregate fidelity: cr, prd, prdn, r, snr_db, qs
  • per-band breakdown: per_band
  • resource cost: throughput_mibs, peak_bytes
  • audit trail: violations (why the next-higher tier failed)

Fields§

§spec_version: String

OpenECS spec version this report conforms to (e.g. “1.0”), so a report is self-identifying out of context. Stamped by the harness.

§codec: String

Codec name, e.g. “lamquant-lossless” or “gzip”.

§dataset: String

Dataset / holdout corpus identifier, e.g. “tuh-eeg-holdout”.

§n_files: usize

Number of files in the run.

§bit_exact: bool

True iff reconstruction was bit-exact on the integer sample domain.

§grade: char

OpenECS tier code: ‘L’, ‘C’, ‘M’, ‘A’, or ‘\0’ for below-floor.

§cr: f64

Aggregate (pooled) compression ratio (raw / compressed).

§prd: f64

Aggregate PRD in percent.

§prdn: f64

Aggregate normalized (mean-subtracted) PRD in percent.

§r: f64

Aggregate Pearson correlation R.

§snr_db: f64

Aggregate SNR in dB.

§qs: f64

Quality score CR / PRD (raw CR when lossless). Higher is better.

§per_band: Vec<BandResult>

Per-band fidelity breakdown, in canonical band order.

§throughput_mibs: f64

Encode+decode throughput in MiB/s.

§peak_bytes: u64

Peak resident memory during the run, in bytes.

§violations: Vec<String>

Why the next-higher tier failed — the climb-a-tier to-do list.

Implementations§

Source§

impl EcsReport

Source

pub fn grade_str(&self) -> String

The grade as a display string, or “” for the below-floor sentinel.

Source

pub fn passed(&self) -> bool

True iff the codec reached any compliant tier (grade != ‘\0’).

Source

pub fn to_json(&self) -> String

Serialize this report to pretty JSON — the standard exchange format.

Serialization of this plain-data struct cannot fail in practice; the expect guards a genuinely unreachable serde error.

Source

pub fn from_json(s: &str) -> Result<Self, Error>

Parse an EcsReport back from its JSON form.

Source

pub fn human_table(&self) -> String

Render an aligned, human-readable text summary of this report.

Two blocks: a header with identity + verdict + aggregate metrics, then a fixed-width per-band table. Memory is shown in MiB for readability. The exact byte / float values stay in the JSON form.

Trait Implementations§

Source§

impl Clone for EcsReport

Source§

fn clone(&self) -> EcsReport

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EcsReport

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for EcsReport

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for EcsReport

Source§

fn eq(&self, other: &EcsReport) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for EcsReport

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for EcsReport

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
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V