Struct sparse_complex::ComplexMatrix

pub struct ComplexMatrix { /* fields omitted */ }

The complex matrix struct

Implementations

impl ComplexMatrix

pub fn new() -> Self

Create a new, initially empty ComplexMatrix

 use sparse_complex::ComplexMatrix;
 let mut m = ComplexMatrix::new();

pub fn from_entries(entries: Vec<(usize, usize, (f64, f64))>) -> Self

Create a new ComplexMatrix from a vector of (row, col, (real, imag)) entries.

 use sparse_complex::ComplexMatrix;
 let entries = vec![(0, 0, (1., 1.)), (1, 1, (1., 1.))];
 let mut m = ComplexMatrix::from_entries(entries);

pub fn add_element(&mut self, row: usize, col: usize, value: (f64, f64))

Add or set an element at location (row, col) with value (real, imag).

pub fn add_elements(&mut self, entries: Vec<(usize, usize, (f64, f64))>)

Add elements correspoding to each triplet (row, col, (real, imag)).

pub fn get(&self, row: usize, col: usize) -> Option<(f64, f64)>

Returns the Element-value at (row, col) if present, or None if not.

 use sparse_complex::ComplexMatrix;
 let entries = vec![(0, 0, (1., -1.)), (1, 1, (-1., 1.))];
 let mut m = ComplexMatrix::from_entries(entries);
 assert_eq!(m.get(2,1), None);
 assert_eq!(m.get(0,0), Some((1., -1.)));
 assert_eq!(m.get(1,1), Some((-1., 1.)));

pub fn solve(
    &mut self,
    b: &[(f64, f64)]
) -> Result<Vec<(f64, f64)>, &'static str>

Solve the system Ax=b, where:

• A is a complex matrix
• b is a complex vector
• x is the return value.

Returns a Result containing the vector with (real, imag) solutions. Returns an Err if unsuccessful.

This solution use the LU factorization implemented by sparse21.

     use sparse_complex::ComplexMatrix;

     let mut A = ComplexMatrix::new();
     A.add_element(0, 0, (1., 1.));
     A.add_element(1, 1, (1., 1.));

     let b = [(1., 0.), (0., 1.)];

     let solution = A.solve(&b);
     assert_eq!(solution.unwrap(), vec![(0.5, -0.5), (0.5, 0.5)]);

Trait Implementations

impl Clone for ComplexMatrix

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ComplexMatrix

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

Formats the value using the given formatter.

impl Default for ComplexMatrix

fn default() -> Self

Returns a 2x2 identity matrix

impl PartialEq<ComplexMatrix> for ComplexMatrix

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.