Skip to main content

Options

scirs2_optimize::unconstrained

Struct Options 

Source 
pub struct Options {
Show 18 fields
    pub max_iter: usize,
    pub max_fev: Option<usize>,
    pub ftol: f64,
    pub xtol: f64,
    pub gtol: f64,
    pub initial_step: Option<f64>,
    pub maxstep: Option<f64>,
    pub finite_diff: bool,
    pub eps: f64,
    pub trust_radius: Option<f64>,
    pub max_trust_radius: Option<f64>,
    pub min_trust_radius: Option<f64>,
    pub trust_tol: Option<f64>,
    pub trust_max_iter: Option<usize>,
    pub trust_eta: Option<f64>,
    pub bounds: Option<Bounds>,
    pub use_gpu: bool,
    pub gpu_threshold_override: Option<usize>,

}
Expand description

Options for optimization algorithms

Fields§

§max_iter: usize

Maximum number of iterations

§max_fev: Option<usize>

Maximum number of function evaluations

§ftol: f64

Function tolerance for convergence

§xtol: f64

Change tolerance for convergence

§gtol: f64

Gradient tolerance for convergence

§initial_step: Option<f64>

Initial step size

§maxstep: Option<f64>

Maximum step size for line search

§finite_diff: bool

Whether to use finite differences for gradient

§eps: f64

Finite difference step size

§trust_radius: Option<f64>

Initial trust-region radius for trust-region methods

§max_trust_radius: Option<f64>

Maximum trust-region radius for trust-region methods

§min_trust_radius: Option<f64>

Minimum trust-region radius for trust-region methods

§trust_tol: Option<f64>

Tolerance for the trust-region subproblem

§trust_max_iter: Option<usize>

Maximum iterations for trust-region subproblem

§trust_eta: Option<f64>

Threshold for accepting a step in the trust-region method

§bounds: Option<Bounds>

Bounds constraints for variables

§use_gpu: bool

Enable GPU acceleration in L-BFGS, Conjugate Gradient, and Newton-CG when n_params >= threshold and a wgpu adapter is present. Per-method thresholds: L-BFGS: 4096 (GPU_LBFGS_THRESHOLD), CG: 4096 (GPU_CG_THRESHOLD), Newton-CG: 4096 (GPU_NEWTON_THRESHOLD).

Requires the gpu feature. Defaults to true (auto-detect). Set to false to force the CPU path regardless of hardware.

§gpu_threshold_override: Option<usize>

Override the GPU threshold for testing purposes. When Some(n), GPU dispatch is attempted if n_params >= n (and use_gpu is true and an adapter is present). None uses the per-method default threshold (4096 for L-BFGS, CG, and Newton-CG).

Trait Implementations§

Source§

impl Clone for Options

Source§

fn clone(&self) -> Options

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 Options

Source§

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

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

impl Default for Options

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Ungil for T
where T: Send,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

Source§

impl<T> WasmNotSync for T
where T: Sync,