Skip to content

README.md

Latest commit

 

History

History
135 lines (94 loc) · 2.95 KB

README.md

File metadata and controls

135 lines (94 loc) · 2.95 KB

Data_Structure_And_Algorithms

Sparse Matrix Operations

Overview

This project implements Sparse Matrix Operations in Python. The program supports:

  • Reading sparse matrices from text files
  • Performing addition, subtraction, and multiplication on sparse matrices
  • Storing results in an output file

The SparseMatrix class efficiently stores and manipulates matrices using a dictionary representation to save memory by only keeping track of nonzero elements.

Features

  • Sparse Matrix Representation: Stores nonzero values using a dictionary
  • Matrix Operations: Supports addition, subtraction, and multiplication
  • File Input and Output: Reads matrix data from files and saves results to files
  • Command-Line Interface: Users can interactively provide input file paths and choose operations

Project Structure

Sparse_matrix/
│── code/
│   ├── src/
│   │   ├── main.py  # Entry point of the program
│   │   ├── sparse_matrix.py  # SparseMatrix class implementation
│   │   ├── operations.py  # Matrix operations (addition, subtraction, multiplication)
│── sample_inputs/
│   ├── matrixfile1.txt  # Sample input matrix
│   ├── easy_sample_04_1.txt  # Another sample input matrix
│── output/
│   ├── result.txt  # File where the output matrix is stored
│── README.md  # Project documentation

Installation & Requirements

This project requires Python 3.7+.

1️⃣ Clone the Repository

git clone https://github.com/your-username/sparse-matrix.git
cd sparse-matrix/code/src

2️⃣ Run the Program

python main.py

How to Use the Program

  1. **Run **`` and enter the file paths for two matrices.
  2. Choose an operation:
    • 1 for addition
    • 2 for subtraction
    • 3 for multiplication
  3. View the result on the console or in the output file.

Example input files (e.g., matrixfile1.txt):

rows=3
cols=3
(0,0,5)
(1,1,8)
(2,2,3)

Implementation Details

SparseMatrix Class

  • Stores elements in a dictionary {(row, col): value}
  • Handles file input/output with save_to_file() and _load_from_file()

Operations Implemented in operations.py

  • add_matrices(mat1, mat2): Adds two matrices
  • subtract_matrices(mat1, mat2): Subtracts two matrices
  • multiply_matrices(mat1, mat2): Multiplies two matrices

Example Output

Sparse Matrix Operations
Enter path for first matrix file: sample_inputs/matrixfile1.txt
Enter path for second matrix file: sample_inputs/easy_sample_04_1.txt
Choose operation:
1. Addition
2. Subtraction
3. Multiplication
Enter your choice (1/2/3): 1
✅ Output saved to output/result.txt

Contents of output/result.txt:

rows=3
cols=3
(0,0,10)
(1,1,16)
(2,2,6)

Contributing

Feel free to submit issues or pull requests for improvements.

License

This project is licensed under the MIT License.