Skip to main content

PersistentEstimator

Struct PersistentEstimator 

Source
pub struct PersistentEstimator { /* private fields */ }
Expand description

A reusable estimator that keeps its factorization between solves.

estimate is the one-shot entry point: it builds the state layout, the constraint set and the solver’s symbolic factorization, uses them once, and throws all three away. For a single estimate that is the whole cost of doing business; for a sequence of them — a time series, a scenario sweep, a live feed refreshing the same telemetry — it is repeated work, and measurably so. Power flow solved the identical problem with PersistentSolver; this is its counterpart.

§When a cached factorization stays valid

Four things are cached — the state layout, the constraint set, each measurement’s resolved MeasurementModel, and one symbolic factorization — and all four hold under the same condition, which is what makes it one condition to state rather than four.

The gain matrix’s sparsity pattern depends on the topology and on the measurement set’s structure — which quantities are measured where — but not on their values. So this stays valid while:

  • the network is unchanged, and
  • the same measurements exist, on the same targets, in the same order.

New readings on the existing sensors are the case this is built for and need no reset. Sigmas may change too: a weight scales G’s values, never its pattern. Adding, removing or reordering a measurement does invalidate it, as does anything that changes whether an angle is measured at all — that flips whether a reference is pinned, and with it the number of unknowns. Call reset then.

Nothing here detects a stale cache. The same is true of PersistentSolver, and for the same reason: the check would cost as much as the work it saves.

Implementations§

Source§

impl PersistentEstimator

Source

pub fn new(options: SeOptions) -> Self

Source

pub fn reset(&mut self)

Discards every cached artifact. Call after changing the network or the structure of the measurement set.

Source

pub fn estimate( &mut self, measurements: &[Measurement], buses: &mut [Bus], net: &SeNetwork, ) -> SeReport

Estimates, reusing whatever this estimator already holds.

The iterative-linear method has nothing to reuse between calls — it factorizes once per call already, and its matrix depends on the starting magnitudes, which move — so it delegates to the one-shot path. The saving here is Newton-Raphson’s, which is also the slower method and so the one that wanted it.

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<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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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