feat(matrix): Introduce methods for swapping specified rows and columns

[mitsuki31]

Overview

This pull request introduces several enhancements and improvements to the Matrix class, focusing on documentation updates, refactoring, and the addition of methods for swapping specified rows and columns within the matrix.

Notable Changes

• Feature Addition: Two sets of methods have been introduced to facilitate the swapping of specified rows and columns within the matrix. These methods optimize performance by either directly swapping column elements relying on arithmetic operations or utilizing System.arraycopy for row swaps.

• Documentation Enhancement: Detailed descriptions have been added to clarify the matrix definition in the Matrix class documentation. Additionally, the class version has been updated.

• Refactoring: New taglets, namely apiNote and implNote, have been incorporated. Furthermore, adjustments have been made to the configuration of the maven-compiler-plugin dependency to resolve compatibility issues with version 3.13.0.

Description

Features Addition

• Two sets of methods have been introduced to empower users with the ability to swap specified rows and columns within the matrix seamlessly.
• For column swapping, a method has been implemented that directly manipulates column elements, eliminating the need for temporary variables and enhancing efficiency through arithmetic operations.
• Alternatively, for row swapping, methods leveraging System.arraycopy have been introduced. This approach not only improves performance but also facilitates negative indexing for specifying rows, allowing for greater flexibility in matrix manipulation.

Documentation Enhancement

• The Matrix class documentation now provides a more comprehensive explanation of the matrix definition, aiding developers in better understanding its functionalities and usage.
• Version details have been updated to reflect the changes made, ensuring clarity for users regarding the current state of the class.

Refactoring

• New taglets (apiNote and implNote) have been integrated into the codebase, enriching the documentation with additional context and implementation notes.
• In response to compatibility issues with the maven-compiler-plugin version 3.13.0, <compilerVersion> has been removed from the plugin configuration, ensuring smooth integration with the latest dependency version.

Summary

This pull request enhances the Matrix class by focusing on refactoring code for better maintainability, and introducing efficient methods for swapping specified rows and columns within the matrix. These changes aim to streamline development processes, optimize performance, and enrich the overall user experience when working with matrices in the application.

[mitsuki31]

There's a bad logic inside the body insertRow method on row index checker.

jmatrix/src/main/java/com/mitsuki/jmatrix/Matrix.java

Lines 958 to 963 in ebd80dd

	} else if (row < 0 || row > mRows) { // Check for the index is out of bounds
	JMatrixUtils.raiseError(new InvalidIndexException(
	String.format("Given row index is out of range: %d",
	(row < 0) ? (row - mRows - 1) : row
	)
	));

It should be like this:

-    } else if (row < 0 || row > mRows) {  // Check for the index is out of bounds
+    } else if (row < 0 || row >= mRows) {  // Check for the index is out of bounds

Where the given row must be lower than (and not equals) to mRows (the total rows of the matrix).

[mitsuki31]

There's a bad logic inside the body insertRow method on row index checker.

jmatrix/src/main/java/com/mitsuki/jmatrix/Matrix.java

Lines 958 to 963 in ebd80dd

	} else if (row < 0 || row > mRows) { // Check for the index is out of bounds
	JMatrixUtils.raiseError(new InvalidIndexException(
	String.format("Given row index is out of range: %d",
	(row < 0) ? (row - mRows - 1) : row
	)
	));

It should be like this:

-    } else if (row < 0 || row > mRows) {  // Check for the index is out of bounds
+    } else if (row < 0 || row >= mRows) {  // Check for the index is out of bounds

Where the given row must be lower than (and not equals) to mRows (the total rows of the matrix).

This issue was moved to #110.