MATRIX

A Linear Algebra Practice Projects I created to practice common matrix algorithms.

Built with the following language:

🔗 Table of Contents

• 📍 Overview
• 👾 Features
• 📁 Project Structure
  • 📂 Project Index
• 🚀 Getting Started
  • ☑️ Prerequisites
  • ⚙️ Installation
  • 🤖 Usage
  • 🧪 Testing
• 📌 Project Roadmap
• 🔰 Contributing
• 🎗 License
• 🙌 Acknowledgments

---

📍 Overview

This project provides the classes to implement Matrices, as well as perform several operations on them. This can be used to perform computations, store data, and more!

---

👾 Features

There are two matrix classes, Matrix and Simplematrix. The difference is that the parameter type of Matrix must extend the Linear class, whereas SimpleMatrix does not have this restrition. This allows Matrix to support more mathematical operations whereas SimpleMatrix is simply a grid that stores data.

There are currently 4 Linear classes that may be used interchangably:
LinearInteger, an integer wrapper
LinearDouble, a double wrapper
LinearNaturalNumber, a wrapper of a custom Ohio State java component that represents the mathematical natural number set (see below on dependency)
and LinearVariable, a custom class meant to represent basic equations, still a wip

With these, the Matrix class supports a suite of operations, such as:
Addition
Subtraction
Augmenting
Transposing
Determinant
... and more!

Feel free to check it out!

---

📁 Project Structure

└── Matrix/
    ├── CoolGridProject
    │   ├── .checkstyle
    │   ├── .classpath
    │   ├── .project
    │   ├── .settings
    │   │   └── org.eclipse.core.resources.prefs
    │   ├── bin
    │   │   └── .gitignore
    │   └── src
    │       └── CoolGridProject.java
    ├── Matrix
    │   ├── .checkstyle
    │   ├── .classpath
    │   ├── .project
    │   ├── .settings
    │   │   └── org.eclipse.core.resources.prefs
    │   ├── bin
    │   │   ├── .gitignore
    │   │   ├── CoolGridProject.class
    │   │   ├── Determinant.class
    │   │   ├── Matrix1LTest.class
    │   │   ├── Matrix2Test.class
    │   │   ├── MatrixHelper.class
    │   │   ├── MatrixIndex$Kind.class
    │   │   ├── MatrixIndex.class
    │   │   ├── MatrixTest.class
    │   │   ├── SystemOfEquationSolver.class
    │   │   ├── UserMatrix.class
    │   │   ├── VariableParser
    │   │   ├── VariableParserTest.class
    │   │   └── components
    │   ├── data
    │   │   └── saveTest
    │   ├── img
    │   │   ├── Checker_Black.png
    │   │   ├── Checker_Black_King.png
    │   │   ├── Checker_Red.png
    │   │   └── Checker_Red_King.png
    │   ├── src
    │   │   ├── Checkers
    │   │   ├── CoolGridProject.java
    │   │   ├── Determinant.java
    │   │   ├── MatrixHelper.java
    │   │   ├── MatrixIndex.java
    │   │   ├── SystemOfEquationSolver.java
    │   │   ├── UserMatrix.java
    │   │   ├── VariableParser
    │   │   └── components
    │   └── test
    │       ├── Matrix1LTest.java
    │       ├── Matrix2Test.java
    │       ├── MatrixTest.java
    │       ├── VariableParserTest.java
    │       └── components
    └── readme.md

📂 Project Index

MATRIX/

CoolGridProject

src

CoolGridProject.java

Simple project made in one day, utilizing SimpleMatrix to represent a coordinate plane, with shape plotting

Matrix

src

Determinant.java	Code to develop and test Determinant algoritm. Works but not thoroughly tested.
SystemOfEquationSolver.java	Uses row reduction and Matrix to solve a system of equations.
MatrixIndex.java	Helper class to store matrices created at runtime.
UserMatrix.java	Methods to help create matrices from user input.
MatrixHelper.java	Matrix helper methods.
CoolGridProject.java	Simple project made in one day, utilizing SimpleMatrix to represent a coordinate plane, with shape plotting

VariableParser

VariableParser.java

Methods to generate a LinearVariable object from user String input.

components

matrix

Matrix2.java	Implementation of Matrix using the _UPDATE_ interface.
MatrixSecondary.java	Secondary methods for the Matrix interface.
MatrixKernel.java	Kernel methods for the Matrix interface.
Matrix1L.java	Implementation of Matrix using the _UPDATE_ interface.
SimpleMatrix.java	Implementation of SimpleMatrix using the _UPDATE_.
SimpleMatrix1L.java	Implementation of SimpleMatrix using the _UPDATE_.
Matrix.java	Implementation of Matrix using the _UPDATE_.
SimpleMatrixSecondary.java	Secondary methods for SimpleMatrix.

linear

LinearInteger.java	Linear class implementation on int
Linear.java	Linear interface.
LinearVariable.java	Linear class implementation on mathematical equations.
LinearDouble.java	Linear class implementation on double
LinearNaturalNumber.java	Linear class implementation on NaturalNumber
LinearSecondary.java	Secondary Linear Methods

Checkers

CheckersController.java	Controller for the Checkers game.
Checkers.java	Checker board object code.
CheckersModel1.java	Model implementation for the Checkers game.
CheckersController1.java	Controller implementation for the Checkers game.
Piece.java	Checker piece object code.
CheckersView1.java	View implementation for the Checkers game.
CheckersView.java	View for the Checkers game.
CheckersModel.java	Model for the Checkers game.

test

Matrix2Test.java	Tests for Matrix2.
VariableParserTest.java	Tests for VariableParser.
MatrixTest.java	Tests for Matrix.
Matrix1LTest.java	Tests for Matrix1L.

components

linear

LinearNaturalNumberTest.java	Tests for LinearNaturalNumber.
LinearIntegerTest.java	Tests for LinearInteger.
LinearVariableTest.java	Tests for LinerVariable.
LinearDoubleTest.java	Tests for LinearDouble.

---

🚀 Getting Started

☑️ Prerequisites

Before getting started with Matrix, ensure your runtime environment meets the following requirements:

• Programming Language: Java

You will need the Ohio State Java components in order for parts of this project to work, such as LinearNaturalNumber, however they are not needed for any of the 1L implementations.

I will post instructions on how to install these in the future. In the meantime, enjoy playing with the other parts of this project!

⚙️ Installation

Install Matrix using one of the following methods:

I suggest importing this project into Eclipse, as it was used in the development of the project.

🤖 Usage

Run Matrix inside of Eclipse.

🧪 Testing

Testing is done through JUnit, which may be done by running the test cases inside of the JUnit tab in Eclipse.

---

📌 Project Roadmap

• Task 1: Update Documentation.
• Task 2: Test LinearVariable.
• Task 3: Complete Determinant Algorithm.

---

🔰 Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the Matrix project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/WesleyKamau/Matrix

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

🎗 License

This project is protected under the MIT License. For more details, refer to the LICENSE file.

---

🙌 Acknowledgments

• Shout out to my Linear Algebra professor!

---