Showcase project enhancements for GitHub publication: Updated project…

… demonstration and documentation to highlight features and usability improvements.
timhwang777 · Feb 19, 2024 · a1ddffe · a1ddffe
commit a1ddffe
Show file tree

Hide file tree

Showing 46 changed files with 1,812 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,35 @@
+# Arnoldi with MATLAB
+![matlab-badge](https://img.shields.io/badge/MATLAB-Solutions-blue
+)
+
+## Table of Contents
+ - [About the Project](#about-the-project)
+    - [Key Features](#key-features)
+ - [Environment Setup](#environment-setup)
+ - [Author](#author)
+
+## About the project
+This project introduces two MATLAB functions designed to extract a few eigenpairs from large-scale matrices, focusing on efficiency and accuracy. The functions are:
+
+`myarnoldi.m`: Implements the Arnoldi method for eigenvalue computation.\
+`myarnoldiro.m`: Enhances the Arnoldi method by incorporating reorthogonalization to improve numerical stability and accuracy.
+
+### Key Features
+- __Sparse Matrix Support:__ Utilizes MATLAB's sparse matrix capabilities to efficiently handle large-scale problems.
+- __Demonstration with west0479 Matrix:__ The correctness of the implemented methods is verified using west0479, a MATLAB sparse demonstration matrix, showcasing the functions' ability to accurately compute eigenvalues and eigenvectors.
+- __Residuals Computation:__ Calculates residuals to ensure the accuracy of the computed eigenpairs, with expectations of achieving machine precision for small iteration counts (e.g., 20, 40).
+- __Ritz Values Computation:__ Involves computing and plotting Ritz values against the exact eigenvalues of the matrix to visually verify the effectiveness of the Arnoldi processes.
+- __Error Analysis:__ Employs relative error analysis for the top three largest eigenvalues, illustrating the convergence behavior and the benefits of reorthogonalization through iteration-based plots.
+- __Large Matrix Testing:__ Extends the validation to large matrices from the "SuiteSparse Matrix Collection," demonstrating the methods' scalability and efficiency on real-world datasets.
+Shift-and-Invert Spectral Transformation: Incorporates a shift-and-invert strategy in the reorthogonalized Arnoldi method to target eigenvalues near a specified value, enhancing the method's utility for specific applications.
+
+## Environment Setup
+To successfully run the provided MATLAB functions and test the algorithms with your matrices, follow these setup instructions carefully. This guide assumes you have MATLAB installed. If not, please visit the official MATLAB website to download and install MATLAB before proceeding.
+
+The project uses west0479, a sparse demonstration matrix included in MATLAB, as a primary example for testing. To load this matrix into your workspace, execute the following commands in the MATLAB Command Window:
+```matlab
+load west0479;
+A = west0479;
+```
+## Author
+Timothy Hwang
diff --git a/figure/arnoldi1.png b/figure/arnoldi1.png
diff --git a/figure/arnoldi2.png b/figure/arnoldi2.png
diff --git a/figure/arnoldi3.png b/figure/arnoldi3.png
diff --git a/figure/arnoldi4.png b/figure/arnoldi4.png
diff --git a/figure/relerr_compare.png b/figure/relerr_compare.png
diff --git a/figure/task61fig.png b/figure/task61fig.png
diff --git a/figure/task62fig.png b/figure/task62fig.png
diff --git a/figure/task71.png b/figure/task71.png
diff --git a/figure/task71relerr.png b/figure/task71relerr.png
diff --git a/figure/task72.png b/figure/task72.png
diff --git a/figure/task72relerr.png b/figure/task72relerr.png
diff --git a/figure/task73.png b/figure/task73.png
diff --git a/figure/task73c.png b/figure/task73c.png
diff --git a/figure/task73relerr.png b/figure/task73relerr.png
diff --git a/figure/task811resi.png b/figure/task811resi.png
diff --git a/figure/task81resi.png b/figure/task81resi.png
diff --git a/figure/task822resi.png b/figure/task822resi.png
diff --git a/figure/task82resi.png b/figure/task82resi.png
diff --git a/report/report.pdf b/report/report.pdf