Struct LinearProblem
pub struct LinearProblem<'a, S = f64> { /* private fields */ }Description
One validated host-local linear problem.
Implementations§
§impl<'a, S> LinearProblem<'a, S>where
S: Scalar + ComplexFloat<Real = f64> + Sync,
impl<'a, S> LinearProblem<'a, S>where
S: Scalar + ComplexFloat<Real = f64> + Sync,
pub fn new(
operator: &'a dyn LinearOperator<Scalar = S>,
right_hand_side: &'a [S],
properties: LinearOperatorProperties,
) -> Result<LinearProblem<'a, S>, Diagnostic>
pub fn new( operator: &'a dyn LinearOperator<Scalar = S>, right_hand_side: &'a [S], properties: LinearOperatorProperties, ) -> Result<LinearProblem<'a, S>, Diagnostic>
Construct a square problem with an implicit zero initial guess.
§Errors
Returns EQ0802 for empty/non-square shape, right-hand-side mismatch,
or non-finite data.
pub fn with_initial_guess(
self,
initial_guess: &'a [S],
) -> Result<LinearProblem<'a, S>, Diagnostic>
pub fn with_initial_guess( self, initial_guess: &'a [S], ) -> Result<LinearProblem<'a, S>, Diagnostic>
pub const fn operator(&self) -> &'a dyn LinearOperator<Scalar = S>
pub const fn operator(&self) -> &'a dyn LinearOperator<Scalar = S>
Operator action.
pub const fn right_hand_side(&self) -> &'a [S]
pub const fn right_hand_side(&self) -> &'a [S]
Right-hand-side values.
pub const fn initial_guess(&self) -> Option<&'a [S]>
pub const fn initial_guess(&self) -> Option<&'a [S]>
Explicit initial guess, or None for the zero vector.
pub const fn scalar_domain(&self) -> ScalarDomain
pub const fn scalar_domain(&self) -> ScalarDomain
Mathematical scalar domain retained by the typed problem.
pub const fn scalar_type(&self) -> ScalarType
pub const fn scalar_type(&self) -> ScalarType
Storage precision of each real component.
pub const fn properties(&self) -> LinearOperatorProperties
pub const fn properties(&self) -> LinearOperatorProperties
Asserted mathematical properties.
pub const fn canonical_csr_system(
&self,
) -> Option<&'a CanonicalCsrSystemView<S>>
pub const fn canonical_csr_system( &self, ) -> Option<&'a CanonicalCsrSystemView<S>>
Exact captured CSR coefficient source associated with this problem.
The problem right-hand side may be derivative-specific and therefore
differ from the source’s captured primal right-hand side. Hand-built
problems return None; a backend requiring materialized sparse storage
must fail closed in that case.
Trait Implementations§
Auto Trait Implementations§
impl<'a, S> Freeze for LinearProblem<'a, S>
impl<'a, S = f64> !RefUnwindSafe for LinearProblem<'a, S>
impl<'a, S> Send for LinearProblem<'a, S>where
S: Sync,
impl<'a, S> Sync for LinearProblem<'a, S>where
S: Sync,
impl<'a, S> Unpin for LinearProblem<'a, S>
impl<'a, S> UnsafeUnpin for LinearProblem<'a, S>
impl<'a, S = f64> !UnwindSafe for LinearProblem<'a, S>
Blanket Implementations§
Source§impl<T> Any for Twhere
T: 'static + ?Sized,
impl<T> Any for Twhere
T: 'static + ?Sized,
§impl<Src, Scheme> ApproxFrom<Src, Scheme> for Srcwhere
Scheme: ApproxScheme,
impl<Src, Scheme> ApproxFrom<Src, Scheme> for Srcwhere
Scheme: ApproxScheme,
Signature links:§
§fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>
fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>
Convert the given value into an approximately equivalent representation.
§impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Srcwhere
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,
impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Srcwhere
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,
Signature links:§
§type Err = <Dst as ApproxFrom<Src, Scheme>>::Err
type Err = <Dst as ApproxFrom<Src, Scheme>>::Err
Signature links:§
The error type produced by a failed conversion.
§fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>
fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>
Convert the subject into an approximately equivalent representation.
Source§impl<T> Borrow<T> for Twhere
T: ?Sized,
impl<T> Borrow<T> for Twhere
T: ?Sized,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T, Dst> ConvAsUtil<Dst> for T
impl<T, Dst> ConvAsUtil<Dst> for T
Signature links:§
§fn approx(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst>,
fn approx(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst>,
Approximate the subject with the default scheme.
§impl<T> ConvUtil for T
impl<T> ConvUtil for T
Signature links:§
§fn approx_as<Dst>(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst>,
fn approx_as<Dst>(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst>,
Approximate the subject to a given type with the default scheme.
§fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,
fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,
Approximate the subject to a given type with a specific scheme.
§fn into_as<Dst>(self) -> Dstwhere
Self: Sized + Into<Dst>,
fn into_as<Dst>(self) -> Dstwhere
Self: Sized + Into<Dst>,
Convert the subject to a given type.
§fn try_as<Dst>(self) -> Result<Dst, Self::Err>where
Self: Sized + TryInto<Dst>,
fn try_as<Dst>(self) -> Result<Dst, Self::Err>where
Self: Sized + TryInto<Dst>,
Attempt to convert the subject to a given type.
§impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> Twhere
Self: Distribution<T>,
Source§impl<T> From<T> for T
impl<T> From<T> for T
§impl<T> Instrument for T
impl<T> Instrument for T
Signature links:§
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Signature links:§
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Signature links:§
Source§impl<T, U> Into<U> for Twhere
U: From<T>,
impl<T, U> Into<U> for Twhere
U: From<T>,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where
F: FnOnce(&Self) -> bool,
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§impl<T> Pointable for T
impl<T> Pointable for T
Signature links:§
Source§impl<T> Same for T
impl<T> Same for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Signature links:§
§fn to_subset(&self) -> Option<SS>
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
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
fn to_subset_unchecked(&self) -> SS
Signature links:§
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.§impl<Src> TryFrom<Src> for Src
impl<Src> TryFrom<Src> for Src
Signature links:§
Source§impl<T, U> TryFrom<U> for Twhere
U: Into<T>,
impl<T, U> TryFrom<U> for Twhere
U: Into<T>,
§impl<Src, Dst> TryInto<Dst> for Srcwhere
Dst: TryFrom<Src>,
impl<Src, Dst> TryInto<Dst> for Srcwhere
Dst: TryFrom<Src>,
Signature links:§
Source§impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,
impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,
§impl<Src> ValueFrom<Src> for Src
impl<Src> ValueFrom<Src> for Src
Signature links:§
§fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>
fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>
Convert the given value into an exactly equivalent representation.
§impl<Src, Dst> ValueInto<Dst> for Srcwhere
Dst: ValueFrom<Src>,
impl<Src, Dst> ValueInto<Dst> for Srcwhere
Dst: ValueFrom<Src>,
Signature links:§
§type Err = <Dst as ValueFrom<Src>>::Err
type Err = <Dst as ValueFrom<Src>>::Err
Signature links:§
The error type produced by a failed conversion.
§fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>
fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>
Convert the subject into an exactly equivalent representation.
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
Signature links:§
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Signature links:§