Home

🎉 Welcome to JMatrix wikis!

This documentation aims to provide you with the necessary information to use and build the project effectively. In this JMatrix wikis, it also provides about matrix and some basic matrix operations.

🪐 About JMatrix

JMatrix is a lightweight Java library that provides essential matrix operations like addition, subtraction, multiplication, and determinant calculation. Designed with simplicity in mind, it is perfect for educational purposes and small-scale projects involving linear algebra. The library also supports custom matrix sizes and efficient handling of matrix operations for both square and rectangular matrices.

$$\begin{matrix} % ::: Title \mathbf{Example \; Matrix} \\\ % ::: Matrix \begin{matrix} \\ m_1 \\ m_2 \\ m_3 \\ m_4 \\ \vdots \\ m_\infty \end{matrix} \hspace{-0.2em} \begin{matrix} \\ \left [ \begin{matrix} \\ \\ \\ \\ \\ \\ \\ \end{matrix} \right . \end{matrix} \begin{matrix} n_1 & n_2 & n_3 & n_4 & \cdots & n_\infty \\ \hline a_{1,1} & a_{1,2} & a_{1,3} & a_{1,4} & \cdots & a_{1,n} \\\ a_{2,1} & a_{2,2} & a_{2,3} & a_{2,4} & \cdots & a_{2,n} \\\ a_{3,1} & a_{3,2} & a_{3,3} & a_{3,4} & \cdots & a_{3,n} \\\ a_{4,1} & a_{4,2} & a_{4,3} & a_{4,4} & \cdots &a_{4,n} \\\ \vdots & \vdots & \vdots & \vdots & \ddots & \vdots \\\ a_{m,1} & a_{m,2} & a_{m,3} & a_{m,4} & \cdots & a_{m,n} \end{matrix} \begin{matrix} \\ \left. \begin{matrix} \\ \\ \\ \\ \\ \\ \\ \end{matrix} \right ]_{m \times n} \end{matrix} \end{matrix}$$

With JMatrix, users can create matrices of various dimensions, initialize them with values, and perform basic matrix operations. It supports both square and rectangular matrices, allowing users to explore various scenarios and understand the properties of different matrix types.

$$% ::: Square Matrix \begin{matrix} \mathbf{Square \; Matrix} \\ \left [ \begin{matrix} a_{1,1} & a_{1,2} & a_{1,3} \\\ a_{2,1} & a_{2,2} & a_{2,3} \\\ a_{3,1} & a_{3,2} & a_{3,3} \end{matrix} \right ]_{3 \times 3} \\ \\ \\\ \end{matrix} \hspace{25pt} % ::: Rectangular Matrix \begin{matrix} \mathbf{Rectangular \; Matrix} \\ \left [ \begin{matrix} a_{1,1} & a_{1,2} \\\ a_{2,1} & a_{2,2} \\\ a_{3,1} & a_{3,2} \\\ a_{4,1} & a_{4,2} \\\ a_{5,1} & a_{5,2} \end{matrix} \right ]_{5 \times 2} \end{matrix}$$

The library is meant to be user-friendly, making it accessible to students or users with varying levels of programming experience. It is designed to be a valuable resource for learning and practicing basic matrix operations.

More details about matrix you can refer to "Introduction to Matrix" page, or if you want to know about basic matrix operations you can refer to "Matrix Operations" page.

🎲 Features

JMatrix provides the following basic matrix operations:

In addition to the fundamental matrix operations, JMatrix also includes matrix type checkers, allowing students or users to identify certain characteristics of matrices:

isDiagonal - Check whether the matrix is diagonal.
isSquare - Check whether the matrix is square.
isLowerTriangular - Check whether the matrix is lower triangular.
isUpperTriangular - Check whether the matrix is upper triangular.
isPermutationMatrix - Check whether the matrix is permutation matrix.

🚨 Important Note

Please keep in mind that JMatrix is primarily intended for educational purposes. While it offers valuable learning opportunities for everyone exploring linear algebra and matrix operations, it may not be suitable for large-scale projects.

We hope that JMatrix will serve as a valuable resource for anyone exploring the fascinating world of linear algebra and matrix operations.

🔌 Installation

If you are interested in obtaining the latest stable version of the JMatrix project, we highly recommend downloading and using the latest version. This ensures better stability and usability, providing you with an improved experience.

For users who wish to customize JMatrix to support different Java versions, you have the option to build the project yourself. Building the project is straightforward and can be done using either Maven or Make.

Note

If you choose to build using Make, please ensure that you have the following programs installed:

Java (minimum version 11, recommended 17)
Python (minimum version 3.7, recommended 3.11)
Make (latest version when possible)

Currently we're having a problem with pre-build processes on Windows systems. It is recommended to use Maven instead if you're using Windows to build the project, ensuring better functionality.

For more detailed instructions on building the project, you can refer to the "Build the Project" section in the wiki page.