diff --git a/README.md b/README.md index 42163d9..68665b2 100644 --- a/README.md +++ b/README.md @@ -11,30 +11,35 @@ The implementation to be tested is a matrix multiplication function made available as a compiled object code. The function has the following signature: -void multiplyMatrices(const std::vector\\>& A, -const std::vector\\>& B, -std::vector\\>& C, int rowsA, int colsA, int colsB); +```cpp +void multiplyMatrices( + const std::vector>& A, + const std::vector>& B, + std::vector>& C, + int rowsA, int colsA, int colsB +); +``` Use the template available here to create your own github repository. The project includes: - The matrix multiplication object code in the library - libmatrix_multiplication.a under the lib folder. + `libmatrix_multiplication_with_errors.a` under the lib folder. - The header defining the matrix multiplication signature under the include folder. -- The file test_matrix_multiplication.cpp under folder test that +- The file `test_matrix_multiplication.cpp` under folder test that contains a simple example of test case. - The makefile you can use for building the software. -- The file matrix_mult.cpp under folder src that includes a correct +- The file `matrix_mult.cpp` under folder src that includes a correct implementation of the matrix multiplication you can use as a reference -Your task is extending the file test_matrix_multiplication.cpp with your +Your task is extending the file `test_matrix_multiplication.cpp` with your test cases. Please insert proper comments in the code to explain why you have selected that specific test case and the behaviour you expect from it. Push the result of your work in your repo. If your local environment