ConjugateGradient

fenris_sparse::cg

Struct ConjugateGradient 

Source 
pub struct ConjugateGradient<'a, T, A, P, Criterion>
where
    T: Scalar,
{ /* private fields */ }

Implementations§

Source§

impl<'a, T: Scalar + Zero> ConjugateGradient<'a, T, (), IdentityOperator, ()>

Source

pub fn new() -> Self

Source§

impl<'a, T: Scalar> ConjugateGradient<'a, T, (), IdentityOperator, ()>

Source

pub fn with_workspace(workspace: &'a mut CgWorkspace<T>) -> Self

Source§

impl<'a, T: Scalar, P, Criterion> ConjugateGradient<'a, T, (), P, Criterion>

Source

pub fn with_operator<A>( self, operator: A, ) -> ConjugateGradient<'a, T, A, P, Criterion>

Source§

impl<'a, T: Scalar, A, P, Criterion> ConjugateGradient<'a, T, A, P, Criterion>

Source

pub fn with_preconditioner<P2>( self, preconditioner: P2, ) -> ConjugateGradient<'a, T, A, P2, Criterion>

Source

pub fn with_max_iter(self, max_iter: usize) -> Self

Source§

impl<'a, T: Scalar, A, P> ConjugateGradient<'a, T, A, P, ()>

Source

pub fn with_stopping_criterion<Criterion>( self, stopping_criterion: Criterion, ) -> ConjugateGradient<'a, T, A, P, Criterion>

Source§

impl<'a, T, A, P, Criterion> ConjugateGradient<'a, T, A, P, Criterion>
where T: Real, A: LinearOperator<T>, P: LinearOperator<T>, Criterion: CgStoppingCriterion<T>,

Source

pub fn solve_with_guess<'b>( &mut self, b: impl Into<DVectorView<'b, T>>, x: impl Into<DVectorViewMut<'b, T>>, ) -> Result<CgOutput<T>, SolveError<T>>

Trait Implementations§

Source§

impl<'a, T, A: Debug, P: Debug, Criterion: Debug> Debug for ConjugateGradient<'a, T, A, P, Criterion>
where T: Scalar + Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, T, A, P, Criterion> Freeze for ConjugateGradient<'a, T, A, P, Criterion>
where A: Freeze, P: Freeze, Criterion: Freeze,

§

impl<'a, T, A, P, Criterion> RefUnwindSafe for ConjugateGradient<'a, T, A, P, Criterion>
where A: RefUnwindSafe, P: RefUnwindSafe, Criterion: RefUnwindSafe, T: RefUnwindSafe,

§

impl<'a, T, A, P, Criterion> Send for ConjugateGradient<'a, T, A, P, Criterion>
where A: Send, P: Send, Criterion: Send, T: Send,

§

impl<'a, T, A, P, Criterion> Sync for ConjugateGradient<'a, T, A, P, Criterion>
where A: Sync, P: Sync, Criterion: Sync, T: Sync,

§

impl<'a, T, A, P, Criterion> Unpin for ConjugateGradient<'a, T, A, P, Criterion>
where A: Unpin, P: Unpin, Criterion: Unpin, T: Unpin,

§

impl<'a, T, A, P, Criterion> !UnwindSafe for ConjugateGradient<'a, T, A, P, Criterion>

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