pub struct QuadraticObjective<T: Float + Debug + Send + Sync + 'static> { /* private fields */ }Expand description
An anisotropic quadratic bowl: f(x) = ½ Σᵢ cᵢ (xᵢ − x*ᵢ)².
The Hessian is diag(c), the unique minimum is at x* with f = 0, and the
condition number is max(c) / min(c) — so a family of these with different
c vectors is a controllable benchmark for whether a learned optimizer has
picked up anything about curvature.
Implementations§
Source§impl<T: Float + Debug + Send + Sync + 'static> QuadraticObjective<T>
impl<T: Float + Debug + Send + Sync + 'static> QuadraticObjective<T>
Sourcepub fn from_curvature(curvature: Vec<f64>, start_value: f64) -> Result<Self>
pub fn from_curvature(curvature: Vec<f64>, start_value: f64) -> Result<Self>
Build a bowl from an explicit per-coordinate curvature vector, with the
optimum at the origin and every start coordinate at start_value.
§Errors
Returns OptimError::InvalidConfig for an empty or non-positive
curvature vector, or a non-finite start_value.
Sourcepub fn with_optimum(self, optimum: Vec<f64>) -> Result<Self>
pub fn with_optimum(self, optimum: Vec<f64>) -> Result<Self>
Move the optimum away from the origin.
§Errors
Returns OptimError::InvalidConfig if optimum has the wrong length or
a non-finite entry.
Sourcepub fn condition_number(&self) -> f64
pub fn condition_number(&self) -> f64
max(c) / min(c), the condition number of the Hessian.
Trait Implementations§
Source§impl<T: Float + Debug + Send + Sync + 'static> MetaObjective<T> for QuadraticObjective<T>
impl<T: Float + Debug + Send + Sync + 'static> MetaObjective<T> for QuadraticObjective<T>
Source§fn initial_parameters(&self) -> Array1<T>
fn initial_parameters(&self) -> Array1<T>
The point a rollout starts from. Must have length
Self::dimension.Auto Trait Implementations§
impl<T> Freeze for QuadraticObjective<T>
impl<T> RefUnwindSafe for QuadraticObjective<T>
impl<T> Send for QuadraticObjective<T>
impl<T> Sync for QuadraticObjective<T>
impl<T> Unpin for QuadraticObjective<T>
impl<T> UnsafeUnpin for QuadraticObjective<T>
impl<T> UnwindSafe for QuadraticObjective<T>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.