Skip to main content

OptResult

cartan_optim::result

Struct OptResult 

Source 
pub struct OptResult<P> {
    pub point: P,
    pub value: Real,
    pub grad_norm: Real,
    pub iterations: usize,
    pub converged: bool,
}
Expand description

The outcome of a Riemannian optimization run.

Returned by all optimizers. Contains the final iterate, convergence info, and per-iteration diagnostics.

Fields§

§point: P

The final iterate (best point found).

§value: Real

Cost function value at the final iterate.

§grad_norm: Real

Riemannian gradient norm at the final iterate.

§iterations: usize

Total number of iterations executed.

§converged: bool

Whether the optimizer reached the gradient tolerance.

false means max iterations were hit without converging.

Trait Implementations§

Source§

impl<P: Clone> Clone for OptResult<P>

Source§

fn clone(&self) -> OptResult<P>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<P: Debug> Debug for OptResult<P>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<P> Freeze for OptResult<P>
where P: Freeze,

§

impl<P> RefUnwindSafe for OptResult<P>
where P: RefUnwindSafe,

§

impl<P> Send for OptResult<P>
where P: Send,

§

impl<P> Sync for OptResult<P>
where P: Sync,

§

impl<P> Unpin for OptResult<P>
where P: Unpin,

§

impl<P> UnsafeUnpin for OptResult<P>
where P: UnsafeUnpin,

§

impl<P> UnwindSafe for OptResult<P>
where P: 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> 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.