add some describe

Author: Certseeds

README.md

@@ -8,10 +8,16 @@
 CS205_C_CPP_2020S_project_matrix  
 details look at project-matrix.md  
 1. All code(in this project,include *.c,*.cpp,*.h,*.hpp,CMakeLists.txt,etc) based on AGPL3.0(or any later version).
+
 2. All *.md files are based on CC-BY-NC-SA-4.0(or any later version).
+
 3. 确保文件夹所在目录下存在`catch.hpp` `catch_main.cpp`(只需要两行,`#define CATCH_CONFIG_MAIN  #include  "./catch.hpp"`).
 然后添加到`CS205_project_2020S/src`到Cmakelist.txt中即可.
 
+4. 
+  + 单元测试: test_matrix_1.cpp
+  + 整体测试: test_matrix_2.cpp
+
 [![AGPL3.0 Licence](https://img.shields.io/badge/License-AGPL_V3-orange)][agpl_3_0]
 
 [![AGPL_V3](https://www.gnu.org/graphics/agplv3-with-text-162x68.png)][agpl_3_0]

src/CMakeLists.txt

@@ -9,7 +9,7 @@ message(STATUS "    libraries: ${OpenCV_LIBS}")
 message(STATUS "    include path: ${OpenCV_INCLUDE_DIRS}")
 
 set(CMAKE_CXX_STANDARD 17)
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O0")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3")
 
 include_directories(
         ${PROJECT_SOURCE_DIR}
@@ -18,9 +18,12 @@ include_directories(
 
 add_executable(${PROJECT_NAME}
         ./../../catch_main.cpp
+        #./test_matrix_2.cpp
         ./test_matrix_1.cpp
         ./Matrix.hpp
         )
+# test_matrix_1 for unit test
+# test_matrix_2 for demo.
 target_link_libraries(${PROJECT_NAME} ${OpenCV_LIBS})
 
 add_executable(${PROJECT_NAME}_test_opencv ./opencv_matrix.cpp)

src/Matrix.hpp

@@ -36,7 +36,6 @@
 #include <cmath>
 #include "./template_helper.h"
 
-const double_t eps = std::pow(10, -5);
 
 namespace Mat_pro {
     using cv::Mat;
@@ -45,6 +44,8 @@ namespace Mat_pro {
     using std::vector;
     using std::pow;
 
+    const double_t eps = std::pow(10, -5);
+
     struct Matrix_Shape_Not_Match_Exception : public std::exception {
         char will_return[300] = "\0";
 
@@ -1012,7 +1013,7 @@ namespace Mat_pro {
             type = 6;
         }
         if (matrix.cols() % demen != 0) {
-            // TODO
+            throw std::invalid_argument("demension not match matrix size");
         }
         Mat will_return(matrix.rows(), matrix.cols() / demen, type + (demen - 1) * 7);
         vector<Mat> mats;
@@ -1062,7 +1063,7 @@ namespace Mat_pro {
     Matrix<double_t> Matrix<T>::Hessenberg() const {
         if (!this->is_square()) {
             throw std::invalid_argument("Need to ensure matrix is sequre");
-            return Matrix<double_t>::eye_value(this->rows(), 0);
+            //return Matrix<double_t>::eye_value(this->rows(), 0);
         }
         Matrix<double_t> left_H = Matrix<double_t>::eye(this->rows());
         Matrix<double_t> right_H = Matrix<double_t>::eye(this->rows());

src/test_matrix_2.cpp

@@ -22,27 +22,17 @@
  */
 #include <complex>
 #include <iostream>
-#include <random>
-#include <string>
-#include <vector>
 
 #include "./../../catch.hpp"
 #include "./Matrix.hpp"
 
-#include <iostream>
-#include <string>
-#include <unistd.h>
-
 using namespace Mat_pro;
 using Catch::Matchers::Equals;
 using std::cout;
 using std::endl;
 using std::string;
 
-string getCwd();
-
 TEST_CASE("test 0", "[end test]") {
-    // CS205_C_CPP\cmake-build-debug\CS205_project_2020S\src\CS205_project_2020S
     Mat img = cv::imread("./3c011ba75965bcfc.jpg");
     if (img.empty()) {
         std::cout << "can not load image " << endl;
@@ -53,16 +43,14 @@ TEST_CASE("test 0", "[end test]") {
     auto matrix_pic1 = cv_to_mat<uint16_t>(img);
     cout << matrix_pic1.rows() << "\n";
     cout << matrix_pic1.cols() << "\n";
-    Matrix<uint16_t> m2 = {{1, 1, 1},
-                           {1, 0, 1},
-                           {1, 1, 1}};
+    auto m2 = Matrix<uint16_t>::values(5, 5, 1);
     Matrix<uint16_t> m3 = {1};
-    auto result = matrix_pic1.convolution_mul(m2, 0, 1, 3);
-    result = result / static_cast<uint16_t>(8);
+    auto result = matrix_pic1.convolution_mul(m2, 4, 1, 3);
+    result = result / static_cast<uint16_t>(25);
     cout << result.rows() << " " << result.cols() << " \n";
     cv::imwrite("store.png", img);
-    cv::imwrite("store2.jpg", mat_to_cv(matrix_pic1, 3));
-    cv::imwrite("store3.jpg", mat_to_cv(result, 3));
+    cv::imwrite("store_origin.jpg", mat_to_cv(matrix_pic1, 3));
+    cv::imwrite("store_mask.jpg", mat_to_cv(result, 3));
     cv::waitKey(0);
 
     Mat green = cv::imread("./green.jpg");
@@ -73,7 +61,7 @@ TEST_CASE("test 0", "[end test]") {
     auto green_matrix = cv_to_mat<uint16_t>(green);
     auto red_matrix = cv_to_mat<uint16_t>(red2);
     auto result2 = green_matrix + red_matrix - 255;
-    cv::imwrite("result2.jpg", mat_to_cv(result2, 3));
+    cv::imwrite("store_add_result.jpg", mat_to_cv(result2, 3));
 }
 //
 //string getCwd() {