Struct ComplexMatrix

pub struct ComplexMatrix<T: Float> { /* private fields */ }

The complex matrix struct

Implementations

impl<T: Float> ComplexMatrix<T>

pub fn new() -> Self

Create a new, initially empty ComplexMatrix

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

pub fn with_capacity(capacity: usize) -> Self

Create a new, initially empty ComplexMatrix with a given capacity

 use sparse_complex::ComplexMatrix;
 let mut m = ComplexMatrix::<f64>::with_capacity(5);

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

Create a new ComplexMatrix from a vector of (row, col, Complex<T>) entries.

 use sparse_complex::ComplexMatrix;
 use num::Complex;
 let entries = vec![(0, 0, Complex::new(1., 1.)), (1, 1, Complex::new(1., 1.))];
 let mut m = ComplexMatrix::<f64>::from_entries(entries);

pub fn add_element(&mut self, row: usize, col: usize, value: Complex<T>)

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

 use sparse_complex::ComplexMatrix;
 use num::Complex;
 
 let Z1: Complex<f64> = Complex { re: 1., im: -1. };
 let Z2: Complex<f64> = Complex { re: -1., im: 1. };
 
 let mut m = ComplexMatrix::new();
 m.add_element(0, 0, Z1);
 m.add_element(1, 1, Z2);
 
 assert_eq!(m.get(0, 0), Some(&Z1));
 assert_eq!(m.get(1, 1), Some(&Z2));

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

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

 use sparse_complex::ComplexMatrix;
 use num::Complex;
 
 let Z1: Complex<f64> = Complex { re: 1., im: -1. };
 let Z2: Complex<f64> = Complex { re: -1., im: 1. };
 
 let mut m = ComplexMatrix::new();
 m.add_element(0, 0, Z1);
 m.add_element(1, 1, Z2);
 
 assert_eq!(m.get(0, 0), Some(&Z1));
 assert_eq!(m.get(1, 1), Some(&Z2));

impl ComplexMatrix<f64>

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

Solve the system Ax=b, where:

• A is a complex matrix
• b is a complex vector

Returns a Result. Ok(()) if the system was solved successfully, Err(String) if not. The result is stored in b.

The solution use the Eigen::SparseLU.

 use sparse_complex::ComplexMatrix;
 use num::Complex;
 
 let Z1: Complex<f64> = Complex { re: 1., im: -1. };
 let Z2: Complex<f64> = Complex { re: -1., im: 1. };
 
 let mut m = ComplexMatrix::new();
 m.add_element(0, 0, Z1);
 m.add_element(1, 1, Z2);
 
 let mut b = vec![Complex::new(1., 0.), Complex::new(0., 1.)];
 m.solve(&mut b).unwrap();
 
 let expected = vec![Complex::new(0.5, 0.5), Complex::new(0.5, -0.5)];
 assert_eq!(b, expected);

impl ComplexMatrix<f32>

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

Solve the system Ax=b, where:

• A is a complex matrix
• b is a complex vector

Returns a Result. Ok(()) if the system was solved successfully, Err(String) if not. The result is stored in b.

This solution use the Eigen::SparseLU.

 use sparse_complex::ComplexMatrix;
 use num::Complex;
 
 let Z1: Complex<f32> = Complex { re: 1., im: -1. };
 let Z2: Complex<f32> = Complex { re: -1., im: 1. };
 
 let mut m = ComplexMatrix::new();
 m.add_element(0, 0, Z1);
 m.add_element(1, 1, Z2);
 
 let mut b = vec![Complex::new(1., 0.), Complex::new(0., 1.)];
 m.solve(&mut b).unwrap();
 
 let expected = vec![Complex::new(0.5, 0.5), Complex::new(0.5, -0.5)];
 assert_eq!(b, expected);

Trait Implementations

impl<T: Clone + Float> Clone for ComplexMatrix<T>

fn clone(&self) -> ComplexMatrix<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Float + Display> Debug for ComplexMatrix<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + Float> PartialEq for ComplexMatrix<T>

fn eq(&self, other: &ComplexMatrix<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Float> StructuralPartialEq for ComplexMatrix<T>