Comment rewrite

src/tensor/matrix.cpp

@@ -36,24 +36,20 @@
 // INCLUDE DESCRIPTION
 //---------------------------------------------------------------------------------------------------------------------------
 #include <tensor/matrix.hpp>
+#include <config/types.hpp> // panic::uint_t, panic::int_t, and panic::real_t
 #include <config/omp.hpp>
 
 //---------------------------------------------------------------------------------------------------------------------------
-// DEFINE DESCRIPTION
-//---------------------------------------------------------------------------------------------------------------------------
-
-//---------------------------------------------------------------------------------------------------------------------------
-// TYPE DESCRIPTION
-//---------------------------------------------------------------------------------------------------------------------------
-
-//---------------------------------------------------------------------------------------------------------------------------
-// VARIABLE DESCRIPTION
+// PRIVATE CONSTANTS
 //---------------------------------------------------------------------------------------------------------------------------
+/**
+ * @brief Minimum number of element operations before using the OpenMP-enabled loop.
+ *
+ * Small vectors and matrices are kept serial because the overhead of starting
+ * worker threads can be larger than the work itself.
+ */
 static const panic::types::uint_t matrix_omp_min_size = 10000;
 
-//---------------------------------------------------------------------------------------------------------------------------
-// FUNCTION PROTOTYPE
-//---------------------------------------------------------------------------------------------------------------------------
 namespace panic{
 	namespace tensor{
 
@@ -127,9 +123,7 @@ matrix<T>::matrix(panic::types::uint_t rows, panic::types::uint_t cols, T value)
 // Constructor Name : panic::tensor::matrix::matrix
 //
 // Description:
-//		Copy-contructor, makes a deep copy of another matrix like this:
-//		matrix A(3);
-// 		matrix B = A;
+//		Copy-contructor, makes a deep copy of another matrix
 //--------------------------------------------------------------------------------------------------------------------------
 template <typename T>
 matrix<T>::matrix(const matrix& other){
@@ -170,10 +164,7 @@ matrix<T>::~matrix(){
 // Function Name : panic::tensor::matrix::operator=
 //
 // Description:
-//		Copy-assignment. Copies from another matrix like this:
-//		matrix A(5);
-//		matrix B(3);
-//		B = A;
+//		Copy-assignment. Copies from another matrix.
 //--------------------------------------------------------------------------------------------------------------------------
 template <typename T>
 matrix<T>& matrix<T>::operator=(const matrix& other){