Struct newton_rootfinder::solver::JacobianMatrix

source · [−]

pub struct JacobianMatrix<D>where
    D: DimMin<D, Output = D>,
    DefaultAllocator: Allocator<f64, D, D>,
    DefaultAllocator: Allocator<(usize, usize), D>,{ /* private fields */ }

Implementations

source

impl<D> JacobianMatrix<D>where
 D: DimMin<D, Output = D>,
 DefaultAllocator: Allocator<f64, D, D>,
 DefaultAllocator: Allocator<(usize, usize), D>,

source

pub fn update_jacobian_with_exact_value(
&mut self,
matrix: OMatrix<f64, D, D>
) -> Result<(), NonInvertibleJacobian>

source

pub fn update_jacobian_with_approximated_value(
&mut self,
matrix: OMatrix<f64, D, D>
) -> Result<(), NonInvertibleJacobian>

source

pub fn update_inverse(&mut self, inverse: OMatrix<f64, D, D>)

When updating the inverse, the jacobian does not have to be recomputed but becomes invalid

source

pub fn get_inverse(&self) -> &Option<OMatrix<f64, D, D>>

Need to have Some and None for the inverse ? it is always valid !

source

pub fn get_jacobian(&self) -> &Option<OMatrix<f64, D, D>>

source

pub fn invalidate_jacobian(&mut self)

Invalidate a jacobian For example, if there is an error computing it

Trait Implementations

source

impl<D> Debug for JacobianMatrix<D>where
 D: DimMin<D, Output = D>,
 DefaultAllocator: Allocator<f64, D, D>,
 DefaultAllocator: Allocator<(usize, usize), D>,

source

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

Formats the value using the given formatter. Read more

source

impl<D> Default for JacobianMatrix<D>where
 D: DimMin<D, Output = D>,
 DefaultAllocator: Allocator<f64, D, D>,
 DefaultAllocator: Allocator<(usize, usize), D>,

source

fn default() -> Self

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

source

impl<D> Display for JacobianMatrix<D>where
 D: DimMin<D, Output = D>,
 DefaultAllocator: Allocator<f64, D, D>,
 DefaultAllocator: Allocator<(usize, usize), D>,

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<D> !RefUnwindSafe for JacobianMatrix<D>

impl<D> !Send for JacobianMatrix<D>

impl<D> !Sync for JacobianMatrix<D>

impl<D> !Unpin for JacobianMatrix<D>

impl<D> !UnwindSafe for JacobianMatrix<D>

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · 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> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToString for Twhere
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct newton_rootfinder::solver::JacobianMatrix

Implementations

impl<D> JacobianMatrix<D>where D: DimMin<D, Output = D>, DefaultAllocator: Allocator<f64, D, D>, DefaultAllocator: Allocator<(usize, usize), D>,

pub fn new() -> Self

pub fn force_jacobian_computation(&mut self)

pub fn compute_jacobian(&self) -> bool

pub fn is_jacobian_approximated(&self) -> bool

pub fn update_jacobian_with_exact_value( &mut self, matrix: OMatrix<f64, D, D>) -> Result<(), NonInvertibleJacobian>

pub fn update_jacobian_with_approximated_value( &mut self, matrix: OMatrix<f64, D, D>) -> Result<(), NonInvertibleJacobian>

pub fn update_inverse(&mut self, inverse: OMatrix<f64, D, D>)

pub fn get_inverse(&self) -> &Option<OMatrix<f64, D, D>>

pub fn get_jacobian(&self) -> &Option<OMatrix<f64, D, D>>

pub fn invalidate_jacobian(&mut self)

Trait Implementations

impl<D> Debug for JacobianMatrix<D>where D: DimMin<D, Output = D>, DefaultAllocator: Allocator<f64, D, D>, DefaultAllocator: Allocator<(usize, usize), D>,

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

impl<D> Default for JacobianMatrix<D>where D: DimMin<D, Output = D>, DefaultAllocator: Allocator<f64, D, D>, DefaultAllocator: Allocator<(usize, usize), D>,

fn default() -> Self

impl<D> Display for JacobianMatrix<D>where D: DimMin<D, Output = D>, DefaultAllocator: Allocator<f64, D, D>, DefaultAllocator: Allocator<(usize, usize), D>,

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

Auto Trait Implementations

impl<D> !RefUnwindSafe for JacobianMatrix<D>

impl<D> !Send for JacobianMatrix<D>

impl<D> !Sync for JacobianMatrix<D>

impl<D> !Unpin for JacobianMatrix<D>

impl<D> !UnwindSafe for JacobianMatrix<D>

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T> ToString for Twhere T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<D> JacobianMatrix<D>where
D: DimMin<D, Output = D>,
DefaultAllocator: Allocator<f64, D, D>,
DefaultAllocator: Allocator<(usize, usize), D>,

pub fn update_jacobian_with_exact_value(
&mut self,
matrix: OMatrix<f64, D, D>
) -> Result<(), NonInvertibleJacobian>

pub fn update_jacobian_with_approximated_value(
&mut self,
matrix: OMatrix<f64, D, D>
) -> Result<(), NonInvertibleJacobian>

impl<D> Debug for JacobianMatrix<D>where
D: DimMin<D, Output = D>,
DefaultAllocator: Allocator<f64, D, D>,
DefaultAllocator: Allocator<(usize, usize), D>,

impl<D> Default for JacobianMatrix<D>where
D: DimMin<D, Output = D>,
DefaultAllocator: Allocator<f64, D, D>,
DefaultAllocator: Allocator<(usize, usize), D>,

impl<D> Display for JacobianMatrix<D>where
D: DimMin<D, Output = D>,
DefaultAllocator: Allocator<f64, D, D>,
DefaultAllocator: Allocator<(usize, usize), D>,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,

impl<T> ToString for Twhere
T: Display + ?Sized,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,