Skip to main content

OptimResult

numra_optim::types

Struct OptimResult 

Source 
pub struct OptimResult<S: Scalar> {
Show 17 fields
    pub x: Vec<S>,
    pub f: S,
    pub grad: Vec<S>,
    pub iterations: usize,
    pub n_feval: usize,
    pub n_geval: usize,
    pub converged: bool,
    pub message: String,
    pub status: OptimStatus,
    pub history: Vec<IterationRecord<S>>,
    pub lambda_eq: Vec<S>,
    pub lambda_ineq: Vec<S>,
    pub active_bounds: Vec<usize>,
    pub constraint_violation: S,
    pub wall_time_secs: f64,
    pub pareto: Option<ParetoResult<S>>,
    pub sensitivity: Option<ParamSensitivity<S>>,

}
Expand description

Result of an optimization.

Fields§

§x: Vec<S>§f: S§grad: Vec<S>§iterations: usize§n_feval: usize§n_geval: usize§converged: bool§message: String§status: OptimStatus§history: Vec<IterationRecord<S>>§lambda_eq: Vec<S>§lambda_ineq: Vec<S>§active_bounds: Vec<usize>§constraint_violation: S§wall_time_secs: f64§pareto: Option<ParetoResult<S>>§sensitivity: Option<ParamSensitivity<S>>

Implementations§

Source§

impl<S: Scalar> OptimResult<S>

Source

pub fn unconstrained( x: Vec<S>, f: S, grad: Vec<S>, iterations: usize, n_feval: usize, n_geval: usize, converged: bool, message: String, status: OptimStatus, ) -> Self

Construct a result for an unconstrained optimization, filling constrained fields with defaults.

Trait Implementations§

Source§

impl<S: Clone + Scalar> Clone for OptimResult<S>

Source§

fn clone(&self) -> OptimResult<S>

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<S: Debug + Scalar> Debug for OptimResult<S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S> Freeze for OptimResult<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for OptimResult<S>
where S: RefUnwindSafe,

§

impl<S> Send for OptimResult<S>

§

impl<S> Sync for OptimResult<S>

§

impl<S> Unpin for OptimResult<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for OptimResult<S>
where S: UnsafeUnpin,

§

impl<S> UnwindSafe for OptimResult<S>
where S: UnwindSafe,

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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