Cynopolis/Vector3D
1
0
Fork 0
Code Issues 3 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Got the matrix library compiling in the tests

Browse Source
This commit is contained in:
Quinn Henthorne
2024-12-10 16:56:57 -05:00
parent ebdf279a5e
commit 1ef741ea93
6 changed files with 403 additions and 26277 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
CMakeLists.txt
View File

@@ -29,6 +29,7 @@ set_target_properties(Matrix
LINKER_LANGUAGE CXX LINKER_LANGUAGE CXX
) )
target_include_directories(Matrix PUBLIC target_include_directories(Matrix
include PUBLIC
.
) )

118
Matrix.hpp
View File

@@ -1,12 +1,13 @@
#pragma once #pragma once
#include <cstdint>
#include <array> #include <array>
#include <type_traits> #include <cmath>
#include <cstdint>
#include <cstdlib> #include <cstdlib>
#include <type_traits>
template <uint8_t rows, uint8_t columns>
class Matrix{ template <uint8_t rows, uint8_t columns> class Matrix {
public: public:
Matrix(); Matrix();
@@ -18,7 +19,8 @@ class Matrix{
* @param result A buffer to store the result into * @param result A buffer to store the result into
* @note there is no problem if result == this * @note there is no problem if result == this
*/ */
void Add(const Matrix<rows, columns> & other, Matrix<rows, columns> & result) const; void Add(const Matrix<rows, columns> &other,
Matrix<rows, columns> &result) const;
/** /**
* @brief Element-wise subtract matrix * @brief Element-wise subtract matrix
@@ -26,7 +28,8 @@ class Matrix{
* @param result A buffer to store the result into * @param result A buffer to store the result into
* @note there is no problem if result == this * @note there is no problem if result == this
*/ */
void Subtract(const Matrix<rows, columns> & other, Matrix<rows, columns> & result) const; void Subtract(const Matrix<rows, columns> &other,
Matrix<rows, columns> &result) const;
/** /**
* @brief Matrix multiply the two matrices * @brief Matrix multiply the two matrices
@@ -34,7 +37,8 @@ class Matrix{
* @param result A buffer to store the result into * @param result A buffer to store the result into
*/ */
template <uint8_t other_columns> template <uint8_t other_columns>
void Multiply(const Matrix<rows, columns> & other, Matrix<columns, other_columns> & result) const; void Multiply(const Matrix<rows, columns> &other,
Matrix<columns, other_columns> &result) const;
/** /**
* @brief Multiply the matrix by a scalar * @brief Multiply the matrix by a scalar
@@ -80,7 +84,8 @@ class Matrix{
* @param result A buffer to store the result into * @param result A buffer to store the result into
* @note there is no problem if result == this * @note there is no problem if result == this
*/ */
void ElementMultiply(const Matrix<rows, columns> & other, Matrix<rows, columns> & result) const; void ElementMultiply(const Matrix<rows, columns> &other,
Matrix<rows, columns> &result) const;
/** /**
* @brief Element-wise divide the two matrices * @brief Element-wise divide the two matrices
@@ -88,7 +93,8 @@ class Matrix{
* @param result A buffer to store the result into * @param result A buffer to store the result into
* @note there is no problem if result == this * @note there is no problem if result == this
*/ */
void ElementDivide(const Matrix<rows, columns> & other, Matrix<rows, columns> & result) const; void ElementDivide(const Matrix<rows, columns> &other,
Matrix<rows, columns> &result) const;
/** /**
* @brief Get an element from the matrix * @brief Get an element from the matrix
@@ -99,7 +105,8 @@ class Matrix{
float &Get(uint8_t row_index, uint8_t column_index) const; float &Get(uint8_t row_index, uint8_t column_index) const;
/** /**
* @brief get the specified row of the matrix returned as a reference to the internal array * @brief get the specified row of the matrix returned as a reference to the
* internal array
*/ */
std::array<float, columns> &operator[](uint8_t row_index) const; std::array<float, columns> &operator[](uint8_t row_index) const;
@@ -134,7 +141,8 @@ class Matrix{
* @brief take the dot product of the two vectors * @brief take the dot product of the two vectors
*/ */
template <uint8_t vector_size> template <uint8_t vector_size>
float dotProduct(const Matrix<vector_size, 1> & vec1, const Matrix<vector_size, 1> & vec2); float dotProduct(const Matrix<vector_size, 1> &vec1,
const Matrix<vector_size, 1> &vec2);
/** /**
* @brief Set all elements in this matrix to zero * @brief Set all elements in this matrix to zero
@@ -143,7 +151,8 @@ class Matrix{
void matrixOfMinors(Matrix<rows, columns> &result) const; void matrixOfMinors(Matrix<rows, columns> &result) const;
void minorMatrix(Matrix<rows-1, columns-1> & result, uint8_t row_idx, uint8_t column_idx) const; void minorMatrix(Matrix<rows - 1, columns - 1> &result, uint8_t row_idx,
uint8_t column_idx) const;
void adjugate(Matrix<rows, columns> &result) const; void adjugate(Matrix<rows, columns> &result) const;
@@ -157,8 +166,7 @@ class Matrix{
std::array<std::array<float, columns>, rows> matrix; std::array<std::array<float, columns>, rows> matrix;
}; };
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns> Matrix<rows, columns>::Matrix() {
Matrix<rows, columns>::Matrix(){
this->zeroMatrix(); this->zeroMatrix();
} }
@@ -166,11 +174,11 @@ template <uint8_t rows, uint8_t columns>
Matrix<rows, columns>::Matrix(const std::array<float, columns> &array) { Matrix<rows, columns>::Matrix(const std::array<float, columns> &array) {
for (uint8_t row_idx{0}; row_idx < rows; row_idx++) { for (uint8_t row_idx{0}; row_idx < rows; row_idx++) {
for (uint8_t column_idx{0}; column_idx < columns; column_idx++) { for (uint8_t column_idx{0}; column_idx < columns; column_idx++) {
uint16_t i = static_cast<uint16_t>(row_idx) + static_cast<uint16_t>(column_idx); uint16_t i =
static_cast<uint16_t>(row_idx) + static_cast<uint16_t>(column_idx);
if (i < array.size()) { if (i < array.size()) {
this->Get(row_idx, column_idx) = array[i]; this->Get(row_idx, column_idx) = array[i];
} } else {
else{
this->Get(row_idx, column_idx) = 0; this->Get(row_idx, column_idx) = 0;
} }
} }
@@ -178,7 +186,8 @@ Matrix<rows, columns>::Matrix(const std::array<float, columns> & array){
} }
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
void Matrix<rows, columns>::Add(const Matrix<rows, columns> & other, Matrix<rows, columns> & result) const{ void Matrix<rows, columns>::Add(const Matrix<rows, columns> &other,
Matrix<rows, columns> &result) const {
for (uint8_t row{0}; row < rows; row++) { for (uint8_t row{0}; row < rows; row++) {
for (uint8_t column{0}; column < columns; column++) { for (uint8_t column{0}; column < columns; column++) {
result.Get(row, column) = this->Get(row, column) + other.Get(row, column); result.Get(row, column) = this->Get(row, column) + other.Get(row, column);
@@ -187,7 +196,8 @@ void Matrix<rows, columns>::Add(const Matrix<rows, columns> & other, Matrix<rows
} }
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
void Matrix<rows, columns>::Subtract(const Matrix<rows, columns> & other, Matrix<rows, columns> & result) const{ void Matrix<rows, columns>::Subtract(const Matrix<rows, columns> &other,
Matrix<rows, columns> &result) const {
for (uint8_t row{0}; row < rows; row++) { for (uint8_t row{0}; row < rows; row++) {
for (uint8_t column{0}; column < columns; column++) { for (uint8_t column{0}; column < columns; column++) {
result.Get(row, column) = this->Get(row, column) - other.Get(row, column); result.Get(row, column) = this->Get(row, column) - other.Get(row, column);
@@ -197,7 +207,9 @@ void Matrix<rows, columns>::Subtract(const Matrix<rows, columns> & other, Matrix
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
template <uint8_t other_columns> template <uint8_t other_columns>
void Matrix<rows, columns>::Multiply(const Matrix<rows, columns> & other, Matrix<columns, other_columns> & result) const{ void Matrix<rows, columns>::Multiply(
const Matrix<rows, columns> &other,
Matrix<columns, other_columns> &result) const {
for (uint8_t row_idx{0}; row_idx < rows; row_idx++) { for (uint8_t row_idx{0}; row_idx < rows; row_idx++) {
for (uint8_t column_idx{0}; column_idx < columns; column_idx++) { for (uint8_t column_idx{0}; column_idx < columns; column_idx++) {
// get our row // get our row
@@ -211,13 +223,15 @@ void Matrix<rows, columns>::Multiply(const Matrix<rows, columns> & other, Matrix
other_column.Transpose(other_column_t); other_column.Transpose(other_column_t);
// the result's index is equal to the dot product of these two vectors // the result's index is equal to the dot product of these two vectors
result.Get(row_idx, column_idx) = this->dotProduct(this_row, other_column_t); result.Get(row_idx, column_idx) =
this->dotProduct(this_row, other_column_t);
} }
} }
} }
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
void Matrix<rows, columns>::Multiply(float scalar, Matrix<rows, columns> & result) const{ void Matrix<rows, columns>::Multiply(float scalar,
Matrix<rows, columns> &result) const {
for (uint8_t row_idx{0}; row_idx < rows; row_idx++) { for (uint8_t row_idx{0}; row_idx < rows; row_idx++) {
for (uint8_t column_idx{0}; column_idx < columns; column_idx++) { for (uint8_t column_idx{0}; column_idx < columns; column_idx++) {
result.Get(row_idx, column_idx) = this->Get(row_idx, column_idx) * scalar; result.Get(row_idx, column_idx) = this->Get(row_idx, column_idx) * scalar;
@@ -227,18 +241,22 @@ void Matrix<rows, columns>::Multiply(float scalar, Matrix<rows, columns> & resul
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
void Matrix<rows, columns>::Invert(Matrix<rows, columns> &result) const { void Matrix<rows, columns>::Invert(Matrix<rows, columns> &result) const {
// since all matrix sizes have to be statically specified at compile time we can do this // since all matrix sizes have to be statically specified at compile time we
static_assert(rows == columns, "Your matrix isn't square and can't be inverted"); // can do this
static_assert(rows == columns,
"Your matrix isn't square and can't be inverted");
// unfortunately we can't calculate this at compile time so we'll just reurn zeros // unfortunately we can't calculate this at compile time so we'll just reurn
// zeros
if (this->Det() < 0) { if (this->Det() < 0) {
// you can't invert a matrix with a negative determinant // you can't invert a matrix with a negative determinant
result.zeroMatrix(); result.zeroMatrix();
return; return;
} }
// TODO: This algorithm is really inneficient because of the matrix of minors. We should make a different algorithm // TODO: This algorithm is really inneficient because of the matrix of minors.
// how to calculate the inverse: https://www.mathsisfun.com/algebra/matrix-inverse-minors-cofactors-adjugate.html // We should make a different algorithm how to calculate the inverse:
// https://www.mathsisfun.com/algebra/matrix-inverse-minors-cofactors-adjugate.html
// calculate the matrix of minors // calculate the matrix of minors
Matrix<rows, columns> minors{}; Matrix<rows, columns> minors{};
@@ -270,7 +288,8 @@ void Matrix<rows, columns>::Square(Matrix<rows, columns> & result) const{
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
float Matrix<rows, columns>::Det() const { float Matrix<rows, columns>::Det() const {
static_assert(this->isSquare(), "You can't take the determinant of a non-square matrix."); static_assert(this->isSquare(),
"You can't take the determinant of a non-square matrix.");
Matrix<1, columns> eigenValues{}; Matrix<1, columns> eigenValues{};
this->EigenValues(eigenValues); this->EigenValues(eigenValues);
@@ -284,8 +303,10 @@ float Matrix<rows, columns>::Det() const{
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
void Matrix<rows, columns>::EigenValues(Matrix<rows, 1> &eigenvalues) const { void Matrix<rows, columns>::EigenValues(Matrix<rows, 1> &eigenvalues) const {
static_assert(rows == columns, "Eigenvalues can only be computed for square matrices."); static_assert(rows == columns,
// I got this code from: https://www.quora.com/What-is-the-C-code-for-finding-eigenvalues "Eigenvalues can only be computed for square matrices.");
// I got this code from:
// https://www.quora.com/What-is-the-C-code-for-finding-eigenvalues
Matrix<rows, 1> v{}; Matrix<rows, 1> v{};
Matrix<rows, 1> Av{}; Matrix<rows, 1> Av{};
Matrix<rows, 1> z{}; Matrix<rows, 1> z{};
@@ -335,35 +356,42 @@ void Matrix<rows, columns>::EigenValues(Matrix<rows, 1> & eigenvalues) const{
} }
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
void Matrix<rows, columns>::ElementMultiply(const Matrix<rows, columns> & other, Matrix<rows, columns> & result) const{ void Matrix<rows, columns>::ElementMultiply(
const Matrix<rows, columns> &other, Matrix<rows, columns> &result) const {
for (uint8_t row_idx{0}; row_idx < rows; row_idx++) { for (uint8_t row_idx{0}; row_idx < rows; row_idx++) {
for (uint8_t column_idx{0}; column_idx < columns; column_idx++) { for (uint8_t column_idx{0}; column_idx < columns; column_idx++) {
result.Get(row_idx, column_idx) = this->Get(row_idx, column_idx) * other.Get(row_idx, column_idx); result.Get(row_idx, column_idx) =
this->Get(row_idx, column_idx) * other.Get(row_idx, column_idx);
} }
} }
} }
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
void Matrix<rows, columns>::ElementDivide(const Matrix<rows, columns> & other, Matrix<rows, columns> & result) const{ void Matrix<rows, columns>::ElementDivide(const Matrix<rows, columns> &other,
Matrix<rows, columns> &result) const {
for (uint8_t row_idx{0}; row_idx < rows; row_idx++) { for (uint8_t row_idx{0}; row_idx < rows; row_idx++) {
for (uint8_t column_idx{0}; column_idx < columns; column_idx++) { for (uint8_t column_idx{0}; column_idx < columns; column_idx++) {
result.Get(row_idx, column_idx) = this->Get(row_idx, column_idx) / other.Get(row_idx, column_idx); result.Get(row_idx, column_idx) =
this->Get(row_idx, column_idx) / other.Get(row_idx, column_idx);
} }
} }
} }
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
float & Matrix<rows, columns>::Get(uint8_t row_index, uint8_t column_index) const{ float &Matrix<rows, columns>::Get(uint8_t row_index,
uint8_t column_index) const {
return this->matrix[row_index][column_index]; return this->matrix[row_index][column_index];
} }
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
void Matrix<rows, columns>::GetRow(uint8_t row_index, Matrix<1, columns> & row) const{ void Matrix<rows, columns>::GetRow(uint8_t row_index,
Matrix<1, columns> &row) const {
row = Matrix<1, columns>(this->matrix[row_index]); row = Matrix<1, columns>(this->matrix[row_index]);
} }
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
void Matrix<rows, columns>::GetColumn(uint8_t column_index, Matrix<rows, 1> & column) const{ void Matrix<rows, columns>::GetColumn(uint8_t column_index,
Matrix<rows, 1> &column) const {
for (uint8_t row_idx{0}; row_idx < rows; row_idx++) { for (uint8_t row_idx{0}; row_idx < rows; row_idx++) {
column.Get(0, column_index) = this->Get(row_idx, column_index); column.Get(0, column_index) = this->Get(row_idx, column_index);
} }
@@ -371,7 +399,8 @@ void Matrix<rows, columns>::GetColumn(uint8_t column_index, Matrix<rows, 1> & co
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
template <uint8_t vector_size> template <uint8_t vector_size>
float Matrix<rows, columns>::dotProduct(const Matrix<vector_size, 1> & vec1, const Matrix<vector_size, 1> & vec2){ float Matrix<rows, columns>::dotProduct(const Matrix<vector_size, 1> &vec1,
const Matrix<vector_size, 1> &vec2) {
float sum{0}; float sum{0};
for (uint8_t i{0}; i < vector_size; i++) { for (uint8_t i{0}; i < vector_size; i++) {
sum += vec1.Get(i, 0) * vec2.Get(i, 0); sum += vec1.Get(i, 0) * vec2.Get(i, 0);
@@ -390,7 +419,8 @@ void Matrix<rows, columns>::zeroMatrix(){
} }
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
void Matrix<rows, columns>::matrixOfMinors(Matrix<rows, columns> & result) const{ void Matrix<rows, columns>::matrixOfMinors(
Matrix<rows, columns> &result) const {
Matrix<rows - 1, columns - 1> minorMatrix{}; Matrix<rows - 1, columns - 1> minorMatrix{};
for (uint8_t row_idx{0}; row_idx < rows; row_idx++) { for (uint8_t row_idx{0}; row_idx < rows; row_idx++) {
@@ -402,12 +432,15 @@ void Matrix<rows, columns>::matrixOfMinors(Matrix<rows, columns> & result) const
} }
template <uint8_t rows, uint8_t columns> template <uint8_t rows, uint8_t columns>
void Matrix<rows, columns>::minorMatrix(Matrix<rows-1, columns-1> & result, uint8_t row_idx, uint8_t column_idx) const{ void Matrix<rows, columns>::minorMatrix(Matrix<rows - 1, columns - 1> &result,
uint8_t row_idx,
uint8_t column_idx) const {
std::array<float, (rows - 1) * (columns - 1)> subArray{}; std::array<float, (rows - 1) * (columns - 1)> subArray{};
for (uint8_t row_iter{0}; row_iter < rows; row_iter++) { for (uint8_t row_iter{0}; row_iter < rows; row_iter++) {
for (uint8_t column_iter{0}; column_iter < columns; column_iter++) { for (uint8_t column_iter{0}; column_iter < columns; column_iter++) {
uint16_t i = static_cast<uint16_t>(row_iter) + static_cast<uint16_t>(column_iter); uint16_t i =
static_cast<uint16_t>(row_iter) + static_cast<uint16_t>(column_iter);
if (row_iter == row_idx || column_iter == column_idx) { if (row_iter == row_idx || column_iter == column_idx) {
continue; continue;
} }
@@ -424,7 +457,8 @@ void Matrix<rows, columns>::adjugate(Matrix<rows, columns> & result) const{
for (uint8_t column_iter{0}; column_iter < columns; column_iter++) { for (uint8_t column_iter{0}; column_iter < columns; column_iter++) {
float sign = ((row_iter + 1) % 2) ? -1 : 1; float sign = ((row_iter + 1) % 2) ? -1 : 1;
sign *= ((column_iter + 1) % 2) ? -1 : 1; sign *= ((column_iter + 1) % 2) ? -1 : 1;
result.Get(row_iter, column_iter) = this->Get(row_iter, column_iter) * sign; result.Get(row_iter, column_iter) =
this->Get(row_iter, column_iter) * sign;
} }
} }
} }

8
unit-tests/CMakeLists.txt
View File

@@ -12,6 +12,10 @@ FetchContent_Declare(
FetchContent_MakeAvailable(Catch2) FetchContent_MakeAvailable(Catch2)
add_executable(tests matrix-tests.cpp) add_executable(matrix-tests matrix-tests.cpp)
target_link_libraries(tests PRIVATE Catch2::Catch2WithMain) target_link_libraries(matrix-tests
PRIVATE
Matrix
Catch2::Catch2WithMain
)

11811
unit-tests/catch_amalgamated.cpp
View File

File diff suppressed because it is too large Load Diff

14106
unit-tests/catch_amalgamated.hpp
View File

File diff suppressed because it is too large Load Diff

4
unit-tests/matrix-tests.cpp
View File

@@ -1,5 +1,9 @@
// include the unit test framework first
#include <catch2/catch_test_macros.hpp> #include <catch2/catch_test_macros.hpp>
// include the module you're going to test next
#include "Matrix.hpp"
unsigned int Factorial(unsigned int number) { unsigned int Factorial(unsigned int number) {
return number <= 1 ? number : Factorial(number - 1) * number; return number <= 1 ? number : Factorial(number - 1) * number;
} }