Skip to main content

SteerPlan

Struct SteerPlan 

Source
pub struct SteerPlan {
    pub atom: usize,
    pub atom_name: String,
    pub t_from: Vec<f64>,
    pub t_to: Vec<f64>,
    pub amplitude: f64,
    pub measured_row: usize,
    pub delta: ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>,
    pub predicted_nats: Option<f64>,
    pub validity_radius: Option<f64>,
    pub off_manifold_norm: f64,
    pub metric_provenance: MetricProvenance,
}
Expand description

The actionable output of a steering query over one atom.

Fields§

§atom: usize

Which atom was steered (index into SaeManifoldTerm::atoms).

§atom_name: String

The atom’s name (mirrors crate::manifold::SaeManifoldAtom::name).

§t_from: Vec<f64>

The source latent coordinate t_from (length = atom’s latent_dim).

§t_to: Vec<f64>

The target latent coordinate t_to (length = atom’s latent_dim).

§amplitude: f64

The amplitude a the on-manifold move was scaled by (the atom’s mean active assignment mass; 1.0 if the atom is active on no row).

§measured_row: usize

The row whose per-row output-Fisher metric the dose was measured through (the atom’s most-active row; 0 if active nowhere).

§delta: ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>

The activation-space delta: δ = a · (g_k(t_to) − g_k(t_from)), a length-p vector in the reconstruction/output space — the actual move to add to a hidden state.

§predicted_nats: Option<f64>

DOSIMETRY: predicted output effect of the move in nats of KL, integrated along the decoder curve through the output-Fisher metric. None when the metric carries no behavioral information (Euclidean provenance) — the dose is not available, not zero.

§validity_radius: Option<f64>

VALIDITY RADIUS: the latent step size (Euclidean norm of the move from t_from) at which the path-integrated dose first diverges from the straight endpoint quadratic form by more than [VALIDITY_DIVERGENCE_FRACTION]. Equals the full move length when the linearization is trusted all the way to t_to. None under a no-behavior metric (there is no dose to validate).

§off_manifold_norm: f64

OFF-MANIFOLD GUARD: the norm of δ’s component outside the span of the atom’s local decoder tangents ∂g_k/∂t at t_from. ≈ 0 by construction (the move is a chord of the curve); a large value flags a move that left the learned surface.

§metric_provenance: MetricProvenance

The provenance of the metric the dose was read through, echoed so a consumer can certify why predicted_nats is None when it is.

Trait Implementations§

Source§

impl Clone for SteerPlan

Source§

fn clone(&self) -> SteerPlan

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 SteerPlan

Source§

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

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

impl PartialEq for SteerPlan

Source§

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

Auto Trait Implementations§

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