Skip to main content

DampedBfgs

Struct DampedBfgs 

Source
pub struct DampedBfgs { /* private fields */ }

Implementations§

Source§

impl DampedBfgs

Source

pub fn new(n: usize) -> Self

Source

pub fn has_prev(&self) -> bool

Have we recorded a previous (x, ∇L)? false until the first call to Self::update.

Source

pub fn seed_scale(&mut self, gamma: Number)

Seed B = γI directly and mark the one-time sizing done, so the first Self::update applies its rank-2 correction on top of this scale instead of re-seeding from its own (s, y).

Used by the driver’s iteration-0 curvature probe: the internal sizing in Self::update cannot fire until a first (s, y) pair exists, i.e. not until iteration 1 — but iteration 0 already solves a QP against B, and with the identity seed that step overshoots by ~cond(∇²L) on an ill-conditioned problem. See the sizing comment in Self::update for why that is fatal.

gamma must be finite and strictly positive; anything else is ignored (leaving B = I) rather than corrupting the matrix.

Source

pub fn reset_to_scale(&mut self)

Discard the accumulated rank-2 curvature and fall back to a scaled identity γI, where γ is the current mean diagonal (a scale the accumulated matrix has already vouched for). prev_x / prev_grad_lag are retained, so the next Self::update resumes accumulating from the reset base.

Used as a recovery step when the QP subproblem fails: a quasi-Newton matrix that has drifted ill-conditioned makes the step subproblem numerically unsolvable, and that is recoverable — far better than aborting an otherwise healthy solve. Off-diagonals are zeroed; the diagonal keeps the problem’s scale.

Source

pub fn update(&mut self, x_new: &[Number], grad_lag_new: &[Number])

Apply the Powell-damped BFGS update from the previous (x_old, ∇L_old) to the supplied (x_new, ∇L_new). The first call just stores the pair; subsequent calls also modify B.

Source

pub fn update_sy(&mut self, s: &[Number], y: &[Number])

Apply the Powell-damped rank-2 update from an explicit curvature pair (s, y).

Prefer this over Self::update when the caller can form y itself: the SQP driver must difference ∇L at a single, fixed multiplier (see the note in sqp_alg.rs), which the (x, ∇L) form of Self::update cannot express because it stores the previous ∇L as evaluated at the previous multiplier.

Source

pub fn as_triplet(&self) -> Triplet

Produce the current B as a Triplet over the upper triangle (1-based), ready to feed into SqpQpData::build.

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more