Remove DBC macro set and rewrite assertions in usual way using standard library.

Author: Gluttton

Diff for: CMakeLists.txt

@@ -9,11 +9,6 @@ set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra")
 set (CMAKE_CXX_FLAGS_DEBUG   "${CMAKE_CXX_FLAGS} -O0 -ggdb3 -DDEBUG")
 set (CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS} -O3")
 
-# Set custom macro for provide Design By Contract (by default is disabled).
-if (DEFINED DBC_MODE)
-    add_definitions (-DDEBUG_WITH_DBC=${DBC_MODE})
-endif ()
-
 include_directories (${PROJECT_SOURCE_DIR}/src)
 
 # Sources (nothing).

Diff for: README.md

@@ -63,14 +63,14 @@ Briefly, to solve the problem you need:
 Thats all! Solution of the problem is stored by into input matrix.
 
 ```
-    #include <munkres-cpp/munkres.h>
-    ...
-    munkres_cpp::Matrix<int> data {
-        {1, 3}
-       ,{5, 9} };
+#include <munkres-cpp/munkres.h>
+...
+munkres_cpp::Matrix<int> data {
+    {1, 3}
+   ,{5, 9} };
 
-    munkres_cpp::Munkres<int> solver;
-    solver.solve (data);
+munkres_cpp::Munkres<int> solver;
+solver.solve (data);
 ```
 
 Examples subfolder contains set of examples which step-by-step show usage of the library.
@@ -83,10 +83,6 @@ Development
 For development purpose in the project implemented a variety of build targets.
 All of them help to continuously check correctness of algorithm implementation, performance, memory management, etc.
 To configure project in development mode ```-DMUNKRESCPP_DEVEL_MODE=ON``` option must be passed to CMake.
-Also for debug purpose defined macro which in primitive way provides basic concepts
-of [Design By Contract](https://en.wikipedia.org/wiki/Design_by_contract). By default the macro is disabled and
-assertions are not checked. The macro can be enabled in one of modes: if assertion is failed only printing debug message (1),
-or throwing exception (2). To configure the mode ```-DDBC_MODE=X``` option must be passed to CMake.
 
 Launch of unit tests.
 The project contains unit tests to build and launch it performs the following steps:

Diff for: src/munkres-cpp/matrix.h

@@ -74,7 +74,7 @@ Matrix<T>::Matrix ()
     , m_rows {0}
     , m_columns {0}
 {
-    ENSURE (!(m_matrix && m_rows && m_columns), "Inconsistent value after initialization.");
+    assert (!(m_matrix && m_rows && m_columns) );
 }
 
 
@@ -95,7 +95,7 @@ Matrix<T>::Matrix (const std::initializer_list<std::initializer_list<T>> & init)
 
     size_t i = 0, j;
     for (auto row = init.begin (); row != init.end (); ++row, ++i) {
-        REQUIRE (row->size () == m_columns, "All rows must have the same number of columns.");
+        assert (row->size () == m_columns);
         j = 0;
         for (auto value = row->begin (); value != row->end (); ++value, ++j) {
             m_matrix[i][j] = *value;
@@ -177,16 +177,16 @@ Matrix<T>::~Matrix ()
     }
     m_matrix = nullptr;
 
-    ENSURE (m_matrix == nullptr, "Dangling pointer.");
+    assert (m_matrix == nullptr);
 }
 
 
 
 template<class T>
 void Matrix<T>::resize (const size_t rows, const size_t columns, const T default_value)
 {
-    REQUIRE (rows > 0,    "Rows must exist.");
-    REQUIRE (columns > 0, "Columns must exist.");
+    assert (rows > 0);
+    assert (columns > 0);
 
     if (m_matrix == nullptr) {
         // Alloc arrays.
@@ -239,7 +239,7 @@ void Matrix<T>::resize (const size_t rows, const size_t columns, const T default
 template<class T>
 void Matrix<T>::clear ()
 {
-    REQUIRE (m_matrix != nullptr, "Attempt to clear empty matrix.");
+    assert (m_matrix != nullptr);
 
     for (size_t i = 0; i < m_rows; i++) {
         for (size_t j = 0; j < m_columns; j++) {
@@ -253,9 +253,9 @@ void Matrix<T>::clear ()
 template<class T>
 inline T & Matrix<T>::operator () (const size_t x, const size_t y)
 {
-    REQUIRE (x < m_rows,          "Row number out of bounds.");
-    REQUIRE (y < m_columns,       "Column number out of bounds.");
-    REQUIRE (m_matrix != nullptr, "Request value from empty matrix.");
+    assert (x < m_rows);
+    assert (y < m_columns);
+    assert (m_matrix != nullptr);
 
     return m_matrix[x][y];
 }
@@ -265,9 +265,9 @@ inline T & Matrix<T>::operator () (const size_t x, const size_t y)
 template<class T>
 inline const T & Matrix<T>::operator () (const size_t x, const size_t y) const
 {
-    REQUIRE (x < m_rows,          "Row number out of bounds.");
-    REQUIRE (y < m_columns,       "Column number out of bounds.");
-    REQUIRE (m_matrix != nullptr, "Request value from empty matrix.");
+    assert (x < m_rows);
+    assert (y < m_columns);
+    assert (m_matrix != nullptr);
 
     return m_matrix [x][y];
 }
@@ -277,7 +277,7 @@ inline const T & Matrix<T>::operator () (const size_t x, const size_t y) const
 template<class T>
 T Matrix<T>::min () const
 {
-    REQUIRE (m_matrix && m_rows && m_columns, "Attempt to find max value in empty matrix.");
+    assert (m_matrix && m_rows && m_columns);
 
     T min = m_matrix [0][0];
 
@@ -295,7 +295,7 @@ T Matrix<T>::min () const
 template<class T>
 T Matrix<T>::max () const
 {
-    REQUIRE (m_matrix && m_rows && m_columns, "Attempt to find max value in empty matrix.");
+    assert (m_matrix && m_rows && m_columns);
 
     T max = m_matrix [0][0];
 

Diff for: src/munkres-cpp/utils.h

@@ -2,6 +2,7 @@
 #define __MUNKRES_CPP_UTILS_H__
 
 #include <cmath>
+#include <cassert>
 #include "munkres-cpp/matrix_base.h"
 
 
@@ -87,104 +88,6 @@ bool is_data_valid (matrix_base<T> & matrix)
     return true;
 }
 
-
-
-// Macro for trivial support of Design By Contract.
-#define DBC_MODE_NONE       0
-#define DBC_MODE_MESSAGE    1
-#define DBC_MODE_ASSERT     2
-
-#ifndef DEBUG_WITH_DBC
-#define DEBUG_WITH_DBC DBC_MODE_NONE
-#endif//DEBUG_WITH_DBC
-
-#ifdef  DEBUG_WITH_DBC
-
-#ifdef  STRINGIFICATION
-#error  STRINGIFICATION macro already defined!
-#endif//STRINGIFICATION
-#define STRINGIFICATION(x) #x
-
-#if DEBUG_WITH_DBC == DBC_MODE_ASSERT
-    #define REQUIRE(CONDITION, MESSAGE) \
-    do { \
-        if (!(CONDITION) ) { \
-            throw std::runtime_error ( \
-                      "Precondition error: " \
-                      + std::string (STRINGIFICATION (CONDITION) ) + " at " \
-                      + std::string (__FILE__) + ":" + std::to_string (__LINE__) + ". " \
-                      + std::string (MESSAGE) ); \
-        } \
-    } while (0);
-
-    #define ENSURE(CONDITION, MESSAGE) \
-    do { \
-        if (!(CONDITION) ) { \
-            throw std::runtime_error ( \
-                      "Postcondition error: " \
-                      + std::string (STRINGIFICATION (CONDITION) ) + " at " \
-                      + std::string (__FILE__) + ":" + std::to_string (__LINE__) + ". " \
-                      + std::string (MESSAGE) ); \
-        } \
-    } while (0);
-
-    #define INVARIANT(CONDITION, MESSAGE) \
-    do { \
-        if (!(CONDITION) ) { \
-            throw std::runtime_error ( \
-                      "Invariant error: " \
-                      + std::string (STRINGIFICATION (CONDITION) ) + " at " \
-                      + std::string (__FILE__) + ":" + std::to_string (__LINE__) + ". " \
-                      + std::string (MESSAGE) ); \
-        } \
-    } while (0);
-
-#elif DEBUG_WITH_DBC == DBC_MODE_MESSAGE
-    #define STRINGIFICATION(x) #x
-    #define REQUIRE(CONDITION, MESSAGE) \
-    do { \
-        if (!(CONDITION) ) { \
-            std::cout \
-                << "Precondition error: " \
-                << std::string (STRINGIFICATION (CONDITION) ) + " at " \
-                << std::string (__FILE__) << ":" << std::to_string (__LINE__) << ". " \
-                << std::string (MESSAGE) \
-                << std::endl; \
-        } \
-    } while (0);
-
-    #define ENSURE(CONDITION, MESSAGE) \
-    do { \
-        if (!(CONDITION) ) { \
-            std::cout \
-                << "Postcondition error: " \
-                << std::string (STRINGIFICATION (CONDITION) ) + " at " \
-                << std::string (__FILE__) << ":" << std::to_string (__LINE__) << ". " \
-                << std::string (MESSAGE) \
-                << std::endl; \
-        } \
-    } while (0);
-
-    #define INVARIANT(CONDITION, MESSAGE) \
-    do { \
-        if (!(CONDITION) ) { \
-            std::cout \
-                << "Invariant error: " \
-                << std::string (STRINGIFICATION (CONDITION) ) + " at " \
-                << std::string (__FILE__) << ":" << std::to_string (__LINE__) << ". " \
-                << std::string (MESSAGE) \
-                << std::endl; \
-        } \
-    } while (0);
-
-#else //DEBUG_WITH_DBC || DEBUG_WITH_DBC_ASSERT
-    #define REQUIRE(CONDITION, MESSAGE);
-    #define ENSURE(CONDITION, MESSAGE);
-    #define INVARIANT(CONDITION, MESSAGE);
-#endif//DEBUG_WITH_DBC || DEBUG_WITH_DBC_ASSERT
-
-#endif//DEBUG_WITH_DBC
-
 }// namespace munkres_cpp
 
 #endif /* !defined(__MUNKRES_CPP_UTILS_H__) */