Struct LinearSystem

Source
pub struct LinearSystem { /* private fields */ }
Expand description

A linear system Ax = b with a matrix A and a right-hand side vector b.

Implementations§

Source§

impl LinearSystem

Source

pub fn new(mat: DMatrix<f64>, rhs: DVector<f64>) -> IterSolverResult<Self>

Create a new LinearSystem with a matrix A and a right-hand side vector b.

§Arguments
  • mat - The matrix A.
  • rhs - The right-hand side vector b.
§Errors

Returns an error if the matrix is not square or if the matrix and the right-hand side vector do not match.

§Examples
use nalgebra::{DMatrix, DVector};
use iterative_solvers::LinearProblem;

let mat = DMatrix::from_row_slice(2, 2, &[4.0, 1.0, 1.0, 3.0]);
let rhs = DVector::from_vec(vec![1.0, 2.0]);
let problem = LinearProblem::new(mat, rhs).unwrap();
Source

pub fn solve( &self, solver: impl IterativeSolver, ) -> IterSolverResult<DVector<f64>>

Solve the linear problem Ax = b using the given solver.

§Arguments
  • solver - The solver to use.
§Errors

Returns an error if the solver fails to solve the linear problem.

§Examples
use nalgebra::{DMatrix, DVector};
use iterative_solvers::{LinearProblem, CG};

let mat = DMatrix::from_row_slice(2, 2, &[4.0, 1.0, 1.0, 3.0]);
let rhs = DVector::from_vec(vec![1.0, 2.0]);
let problem = LinearProblem::new(mat, rhs).unwrap();
let solver = CG::new(&mat, &rhs, 1e-6).unwrap();
let solution = problem.solve(solver).unwrap();

Auto Trait Implementations§

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