Skip to main content

EncodeObjective

Struct EncodeObjective 

Source
pub struct EncodeObjective<'a> {
    pub metric_factor: Option<ArrayView2<'a, f64>>,
    pub prior_alpha: Option<&'a [f64]>,
    pub metric_norm_bound: f64,
}
Expand description

The TRUE per-row encode objective’s non-Euclidean ingredients (F3), so the Kantorovich certificate certifies the SAME functional the fit optimized t against — not a bare Euclidean stand-in.

The fit’s per-row data loss is generalized least squares ½ rᵀ M_n r (r = m(t) − x) under a per-row output metric M_n = U_n U_nᵀ (gam_problem::RowMetric), plus a per-axis latent coordinate prior Σ_a ArdAxisPrior(α_a, t_a) (the ARD Gaussian / von-Mises energy the fit placed on the coordinate). The metric-free encode drops BOTH, so its certified root solves a different problem whenever a non-identity metric or an active prior is present. EncodeObjective threads them back in:

  • metric_factor — the per-row factor U_n ∈ ℝ^{p×rank}; NoneM = I. Whitening reduces to M r = U(Uᵀr) and Jᵀ M J = (UᵀJ)ᵀ(UᵀJ).
  • prior_alpha — per-axis ARD precision α_a (the caller folds in any row weight); None/0 ⇒ no prior on that axis. The period is read from the atom’s basis kind so a periodic axis uses the von-Mises energy.
  • metric_norm_bound — a GLOBAL upper bound max_n ‖M_n‖ used to scale the offline chart Lipschitz (the per-row M_n enters β, η online; the certificate needs a valid L upper bound, and L_data scales by ‖M‖).

EncodeObjective::euclidean (all None, bound 1) reproduces the metric- free field bit-for-bit, so every existing caller is unchanged.

Fields§

§metric_factor: Option<ArrayView2<'a, f64>>

Per-row output-metric factor U ∈ ℝ^{p×rank} (M = U Uᵀ). NoneI.

§prior_alpha: Option<&'a [f64]>

Per-axis ARD precision α_a (row weight folded in). None ⇒ no prior.

§metric_norm_bound: f64

Global bound max_n ‖M_n‖ scaling the offline chart Lipschitz. 1.0 for the Euclidean objective.

Implementations§

Source§

impl<'a> EncodeObjective<'a>

Source

pub fn euclidean() -> Self

The bare Euclidean, prior-free objective — every code path is bit-identical to the metric-free encode under this value.

Trait Implementations§

Source§

impl<'a> Clone for EncodeObjective<'a>

Source§

fn clone(&self) -> EncodeObjective<'a>

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<'a> Copy for EncodeObjective<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for EncodeObjective<'a>

§

impl<'a> RefUnwindSafe for EncodeObjective<'a>

§

impl<'a> Send for EncodeObjective<'a>

§

impl<'a> Sync for EncodeObjective<'a>

§

impl<'a> Unpin for EncodeObjective<'a>

§

impl<'a> UnsafeUnpin for EncodeObjective<'a>

§

impl<'a> UnwindSafe for EncodeObjective<'a>

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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