Use more efficient colmatrix-based reduction
[libstick.git] / include / libstick-0.1 / booleanmatrix.h
index ab368d2309bb5461970f6ad20ab2de62cccb6d3b..2b64a4ecb79bcd4200e3e26ab3c16bfa2fd10025 100644 (file)
 namespace libstick {
 
 
-/** The base class of BooleanColMatrix and BooleanColRowMatrix which implements
+template<class T>
+std::ostream& operator<<(std::ostream &, const std::vector<T> &);
+
+
+/** The base class of boolean_colmatrix and boolean_colrowmatrix which implements
  * the common logic of both. */
 template<class IT, class D>
-class BooleanColMatrix_base {
+class boolean_colmatrix_base {
 
     public:
         typedef IT index_type;
         typedef std::vector<index_type> column_type;
         typedef D derived;
 
+    protected:
         /** Create a matrix with 'width' columns, initalized with zero entries. */
-        BooleanColMatrix_base(size_t width) :
+        boolean_colmatrix_base(size_t width) :
             cols(width) {
         }
 
-        /** Get height resp. width of the matrix. */
+    public:
+        /** A casting constructor for any colmatrix with same entries type. */
+        template<class D2>
+        boolean_colmatrix_base(const boolean_colmatrix_base<IT, D2> &mat) :
+            cols(mat.get_columns()) {
+        }
+
+        /** Get width of the matrix. */
         size_t width() const {
             return cols.size();
         }
 
+        /** Get height of the matrix, i.e. maximum row-index + 1 among all columns. */
+        size_t height() const {
+            IT h = 0;
+            for (unsigned c=0; c < width(); ++c)
+                if (cols[c].size() > 0)
+                    h = std::max(h, cols[c].back());
+            return h+1;
+        }
+
         /** Get the matrix entry at row 'r' and column 'c'. */
         bool get(index_type r, index_type c) const {
             assert(c < width());
-            const column_type &col = getColumn(c);
+            const column_type &col = get_column(c);
             return binary_search(col.begin(), col.end(), r);
         }
 
         /** Set the matrix entry at row 'r' and column 'c'. */
         void set(index_type r, index_type c, bool value) {
-            getDerived()->_set(r, c, value);
+            get_derived()->_set(r, c, value);
+        }
+
+        /** For each of the 'count'-many (row-index, column-pair) pair in 'indices', set the specific value. */
+        void set_all(index_type indices[][2], size_t count, bool value) {
+            for (unsigned i=0; i < count; ++i)
+                set(indices[i][0], indices[i][1], value);
         }
 
         /** Get the c-th column. */
-        const column_type& getColumn(index_type c) const {
+        const column_type& get_column(index_type c) const {
             assert(c < width());
             return cols[c];
         }
 
+        /** Get all columns */
+        const std::vector<column_type>& get_columns() const {
+            return cols;
+        }
+
         /** Add the column-vector 'col' to the c-th column. Note that 'col'
          * actually contains the list of row-indices that are 1. */
         void add_column(index_type c, const column_type &col) {
@@ -64,18 +96,36 @@ class BooleanColMatrix_base {
         }
 
         /** Two matrices are equal iff they have the same entries */
-        bool operator==(const BooleanColMatrix_base<IT, D> &m) const {
-            return cols == m.cols;
+        template<class D2>
+        bool operator==(const boolean_colmatrix_base<IT, D2> &m) const {
+            return cols == m.get_columns();
         }
 
         /** Two matrices are equal iff they have the same entries */
-        bool operator!=(const BooleanColMatrix_base<IT, D> &m) const {
+        template<class D2>
+        bool operator!=(const boolean_colmatrix_base<IT, D2> &m) const {
             return !(*this == m);
         }
 
-    protected:
-
+        /** Print index pairs of the 1s as { {r, c}, {r, c}, {r, c} } */
+        void print_indexpairs(std::ostream &os) const {
+            bool first=true;
+
+            os << "{";
+            for (unsigned c=0; c < width(); ++c) {
+                const column_type &col = get_column(c);
+                for (typename column_type::const_iterator it = col.begin(); it != col.end(); ++it) {
+                    if (first)
+                        first = false;
+                    else
+                        os << ",";
+                    os << " {" << *it << ", " << c << "}";
+                }
+            }
+            os << " }";
+        }
 
+    protected:
         /** Set the matrix entry at row 'r' and column 'c'. */
         void _set(index_type r, index_type c, bool value) {
             assert(c < width());
@@ -101,17 +151,18 @@ class BooleanColMatrix_base {
             }
 
 #ifndef NDEBUG
+            // C++11 would have is_sorted
             for (unsigned i=1; i < col.size(); i++)
                 assert(col[i-1] < col[i]);
 #endif
         }
 
-    private:
+    protected:
         /** The matrix is the set of columns. */
         std::vector<column_type> cols;
 
         /** A cast to the derived type */
-        derived* getDerived() {
+        derived* get_derived() {
             return static_cast<derived*>(this);
         }
 };
@@ -121,14 +172,15 @@ class BooleanColMatrix_base {
  * column-vector we save the row-indices of the 1s. It is designed to handle a
  * few 1s and column-wise operations well. */
 template<class IT=uint32_t>
-class BooleanColMatrix : public BooleanColMatrix_base<IT, BooleanColMatrix<IT> > {
+class boolean_colmatrix : public boolean_colmatrix_base<IT, boolean_colmatrix<IT> > {
 
     public:
         typedef IT index_type;
-        typedef BooleanColMatrix_base<IT, BooleanColMatrix<IT> > base;
+        typedef boolean_colmatrix_base<IT, boolean_colmatrix<IT> > base;
+        typedef typename base::column_type column_type;
 
         /** Create a matrix with 'width' columns, initalized with zero entries. */
-        BooleanColMatrix(size_t columns) :
+        boolean_colmatrix(size_t columns) :
             base(columns) {
         }
 
@@ -136,26 +188,59 @@ class BooleanColMatrix : public BooleanColMatrix_base<IT, BooleanColMatrix<IT> >
         void _set(index_type r, index_type c, bool value) {
             base::_set(r, c, value);
         }
+
+        /** A faster implementation of boolean_colmatrix_base::add_column().
+         * Assumes that 'col' is sorted. */
+        void add_column(index_type c, const column_type &col) {
+            assert(c < base::width());
+
+#ifndef NDEBUG
+            for (unsigned i=1; i < col.size(); ++i)
+                assert(col[i-1] < col[i]);
+#endif
+
+            // The original column
+            column_type &orig_col = base::cols[c];
+
+            // Make target column large enough
+            const size_t maxsize = orig_col.size() + col.size();
+            if (tcol.size() < maxsize)
+                tcol.resize(maxsize);
+
+            // Compute symmetric difference
+            typename column_type::iterator it = std::set_symmetric_difference(
+                    orig_col.begin(), orig_col.end(), col.begin(), col.end(), tcol.begin());
+
+            // Copy back to the original column
+            orig_col.resize(it - tcol.begin());
+            std::copy(tcol.begin(), it, orig_col.begin());
+        }
+
+    private:
+        /** A temporary container to speed up add_column() */
+        column_type tcol;
 };
 
 
-/** The base class of BooleanRowMatrix and BooleanColRowMatrix which implements
+/** The base class of boolean_rowmatrix and boolean_colrowmatrix which implements
  * the common logic of both. */
 template<class IT, class D>
-class BooleanRowMatrix_base {
+class boolean_rowmatrix_base {
 
     public:
         typedef IT index_type;
         typedef std::vector<index_type> row_type;
         typedef D derived;
 
+    protected:
         /** Create a matrix with 'height' rows, initalized with zero entries.
          * */
-        BooleanRowMatrix_base(size_t height) :
+        boolean_rowmatrix_base(size_t height) :
             rows(height) {
         }
 
-        /** Get height resp. width of the matrix. */
+    public:
+        /** Get height of the matrix. */
         size_t height() const {
             return rows.size();
         }
@@ -163,17 +248,23 @@ class BooleanRowMatrix_base {
         /** Get the matrix entry at row 'r' and column 'c'. */
         bool get(index_type r, index_type c) const {
             assert(r < height());
-            const row_type &row = getRow(r);
+            const row_type &row = get_row(r);
             return binary_search(row.begin(), row.end(), c);
         }
 
         /** Set the matrix entry at row 'r' and column 'c'. */
         void set(index_type r, index_type c, bool value) {
-            getDerived()->_set(r, c, value);
+            get_derived()->_set(r, c, value);
+        }
+
+        /** For each of the 'count'-many (row-index, column-pair) pair in 'indices', set the specific value. */
+        void set_all(index_type indices[][2], size_t count, bool value) {
+            for (unsigned i=0; i < count; ++i)
+                set(indices[i][0], indices[i][1], value);
         }
 
         /** Get the r-th row. */
-        const row_type& getRow(index_type r) const {
+        const row_type& get_row(index_type r) const {
             assert(r < height());
             return rows[r];
         }
@@ -189,12 +280,12 @@ class BooleanRowMatrix_base {
         }
 
         /** Two matrices are equal iff they have the same entries */
-        bool operator==(const BooleanRowMatrix_base<IT, D> &m) const {
+        bool operator==(const boolean_rowmatrix_base<IT, D> &m) const {
             return rows == m.rows;
         }
 
         /** Two matrices are equal iff they have the same entries */
-        bool operator!=(const BooleanRowMatrix_base<IT, D> &m) const {
+        bool operator!=(const boolean_rowmatrix_base<IT, D> &m) const {
             return !(*this == m);
         }
 
@@ -224,13 +315,14 @@ class BooleanRowMatrix_base {
             }
 
 #ifndef NDEBUG
+            // C++11 would have is_sorted
             for (unsigned i=1; i < row.size(); i++)
                 assert(row[i-1] < row[i]);
 #endif
         }
 
-    private:
-        derived* getDerived() {
+    protected:
+        derived* get_derived() {
             return static_cast<derived*>(this);
         }
 
@@ -243,14 +335,14 @@ class BooleanRowMatrix_base {
  * row-vector we save the column-indices of the 1s. It is designed to handle a
  * few 1s and row-wise operations well. */
 template<class IT=uint32_t>
-class BooleanRowMatrix : public BooleanRowMatrix_base<IT, BooleanRowMatrix<IT> > {
+class boolean_rowmatrix : public boolean_rowmatrix_base<IT, boolean_rowmatrix<IT> > {
 
     public:
         typedef IT index_type;
-        typedef BooleanRowMatrix_base<IT, BooleanRowMatrix<IT> > base;
+        typedef boolean_rowmatrix_base<IT, boolean_rowmatrix<IT> > base;
 
         /** Create a matrix with 'height' rows, initalized with zero entries. */
-        BooleanRowMatrix(size_t height) :
+        boolean_rowmatrix(size_t height) :
             base(height) {
         }
 
@@ -264,22 +356,39 @@ class BooleanRowMatrix : public BooleanRowMatrix_base<IT, BooleanRowMatrix<IT> >
 /** This is a boolean matrix that supports. It is designed to handle a
  * few 1s and row- and column-wise operations well. */
 template<class IT=uint32_t>
-class BooleanColRowMatrix : public BooleanColMatrix_base<IT, BooleanColRowMatrix<IT> >,
-                            public BooleanRowMatrix_base<IT, BooleanColRowMatrix<IT> > {
+class boolean_colrowmatrix : public boolean_colmatrix_base<IT, boolean_colrowmatrix<IT> >,
+                            public boolean_rowmatrix_base<IT, boolean_colrowmatrix<IT> > {
 
     public:
-        typedef BooleanColMatrix_base<IT, BooleanColRowMatrix<IT> > colbase;
-        typedef BooleanRowMatrix_base<IT, BooleanColRowMatrix<IT> > rowbase;
+        typedef boolean_colmatrix_base<IT, boolean_colrowmatrix<IT> > colbase;
+        typedef boolean_rowmatrix_base<IT, boolean_colrowmatrix<IT> > rowbase;
 
     public:
         typedef IT index_type;
 
         /** Create a size x size matrix, initialized with zeros. */
-        BooleanColRowMatrix(size_t size) :
+        boolean_colrowmatrix(size_t size) :
             colbase(size),
             rowbase(size) {
         }
 
+        /** Casting a colmatrix into a colrow matrix */
+        template<class D>
+        boolean_colrowmatrix(const boolean_colmatrix_base<IT, D>& mat) :
+            colbase(std::max(mat.width(), mat.height())),
+            rowbase(std::max(mat.width(), mat.height())) {
+            for (unsigned c=0; c < mat.width(); ++c) {
+                const typename colbase::column_type &col = mat.get_column(c);
+                for (unsigned i=0; i < col.size(); ++i)
+                    set(col[i], c, true);
+            }
+            for (unsigned r=0; r < size(); ++r) {
+                const typename rowbase::row_type &row = rowbase::get_row(r);
+                for (unsigned i=0; i < row.size(); ++i)
+                    assert(get(r, row[i]) == true);
+            }
+        }
+
         /** Override implementation. */
         void _set(index_type r, index_type c, bool value) {
             colbase::_set(r, c, value);
@@ -301,6 +410,11 @@ class BooleanColRowMatrix : public BooleanColMatrix_base<IT, BooleanColRowMatrix
             colbase::set(r, c, value);
         }
 
+        /** For each of the 'count'-many (row-index, column-pair) pair in 'indices', set the specific value. */
+        void set_all(index_type indices[][2], size_t count, bool value) {
+            colbase::set_all(indices, count, value);
+        }
+
         /** Get the matrix entry at row 'r' and column 'c'. */
         bool get(index_type r, index_type c) const {
             assert(colbase::get(r, c) == rowbase::get(r, c));
@@ -308,20 +422,99 @@ class BooleanColRowMatrix : public BooleanColMatrix_base<IT, BooleanColRowMatrix
         }
 
         /** Two matrices are equal iff they have the same entries */
-        bool operator==(const BooleanColRowMatrix<IT> &m) const {
+        bool operator==(const boolean_colrowmatrix<IT> &m) const {
             assert(rowbase::operator==(m) == colbase::operator==(m));
             return colbase::operator==(m);
         }
 
         /** Two matrices are equal iff they have the same entries */
-        bool operator!=(const BooleanColRowMatrix<IT> &m) const {
+        template<class D>
+        bool operator==(const boolean_colmatrix_base<IT, D> &m) const {
+            return colbase::operator==(m);
+        }
+
+        /** Two matrices are equal iff they have the same entries */
+        bool operator!=(const boolean_colrowmatrix<IT> &m) const {
             return !(*this == m);
         }
+
+        /** Multiply with matrix b from the right */
+        template<class D>
+        boolean_colrowmatrix<IT> operator*(const boolean_colmatrix_base<IT, D> &b) const {
+            boolean_colrowmatrix<IT> c(size());
+            multiply_matrix(c, *this, b);
+            return c;
+        }
 };
 
+
+/** Counts the number of common elements in two sorted vectors. Equal to
+ * counting the number of elements given by std::set_intersection. */
+template <class InputIterator1, class InputIterator2>
+size_t count_set_intersection (InputIterator1 first1, InputIterator1 last1, InputIterator2 first2, InputIterator2 last2)
+{
+    size_t count = 0;
+
+    // As long as we did not either end, look for common elements
+    while (first1 != last1 && first2 != last2)
+    {
+        if (*first1 < *first2)
+            ++first1;
+        else if (*first2 < *first1)
+            ++first2;
+        // Element is common to both
+        else {
+            ++count;
+            ++first1;
+            ++first2;
+        }
+    }
+    return count;
+}
+
+/** Multiply a*b and save the product in 'result'. It is assumed that 'result' is intially empty and has appropriate size. */
+template<class IT, class D1, class D2, class RT>
+void multiply_matrix(RT &result, const boolean_rowmatrix_base<IT, D1> &a, const boolean_colmatrix_base<IT, D2> &b) {
+    assert(a.height() == b.width());
+
+    for (unsigned r=0; r < a.height(); ++r) {
+        const typename boolean_rowmatrix_base<IT, D1>::row_type &row = a.get_row(r);
+        for (unsigned c=0; c < b.width(); ++c) {
+            const typename boolean_colmatrix_base<IT, D2>::column_type &col = b.get_column(c);
+            if (count_set_intersection(row.begin(), row.end(), col.begin(), col.end()) % 2 == 1)
+                result.set(r, c, true);
+        }
+    }
+}
+
+template<class MT>
+MT create_unit_matrix(size_t size) {
+    MT mat(size);
+    for (unsigned i=0; i < size; ++i)
+        mat.set(i, i, true);
+    return mat;
+}
+
 template<class IT>
-std::ostream& operator<<(std::ostream &os, const BooleanColRowMatrix<IT> &mat) {
+std::ostream& operator<<(std::ostream &os, const boolean_colrowmatrix<IT> &mat) {
+
+    os << " ";
+    for (unsigned c=0; c < mat.size(); ++c) {
+        const unsigned d = (c % 10);
+        if (d > 0)
+            os << d;
+        else
+            os << " ";
+    }
+    os << std::endl;
+
     for (unsigned r=0; r < mat.size(); ++r) {
+        const unsigned d = (r % 10);
+        if (d > 0)
+            os << d;
+        else
+            os << " ";
+
         for (unsigned c=0; c < mat.size(); ++c)
             os << (mat.get(r,c) ? "X" : ".");
 
@@ -332,17 +525,17 @@ std::ostream& operator<<(std::ostream &os, const BooleanColRowMatrix<IT> &mat) {
 }
 
 template<class IT>
-std::ostream& operator<<(std::ostream &os, BooleanColRowMatrix<IT> &mat) {
-    const BooleanColRowMatrix<IT> &m = mat;
+std::ostream& operator<<(std::ostream &os, boolean_colrowmatrix<IT> &mat) {
+    const boolean_colrowmatrix<IT> &m = mat;
     return os << m;
 }
 
 template<class IT, class D>
-std::ostream& operator<<(std::ostream &os, const BooleanRowMatrix_base<IT, D> &mat) {
+std::ostream& operator<<(std::ostream &os, const boolean_rowmatrix_base<IT, D> &mat) {
     for (unsigned r=0; r < mat.height(); ++r) {
         // Get the sorted r-th row
-        std::list<IT> row(mat.getRow(r).size());
-        copy(mat.getRow(r).begin(), mat.getRow(r).end(), row.begin());
+        std::list<IT> row(mat.get_row(r).size());
+        copy(mat.get_row(r).begin(), mat.get_row(r).end(), row.begin());
 
         os << "|";
         // Print the elements, and remove them
@@ -361,13 +554,13 @@ std::ostream& operator<<(std::ostream &os, const BooleanRowMatrix_base<IT, D> &m
 }
 
 template<class IT, class D>
-std::ostream& operator<<(std::ostream &os, BooleanRowMatrix_base<IT, D> &mat) {
-    const BooleanRowMatrix_base<IT, D> &m = mat;
+std::ostream& operator<<(std::ostream &os, boolean_rowmatrix_base<IT, D> &mat) {
+    const boolean_rowmatrix_base<IT, D> &m = mat;
     return os << m;
 }
 
 template<class IT, class D>
-std::ostream& operator<<(std::ostream &os, const BooleanColMatrix_base<IT, D> &mat) {
+std::ostream& operator<<(std::ostream &os, const boolean_colmatrix_base<IT, D> &mat) {
     // The sorted columns
     std::vector<std::list<IT> > cols;
     // The max height (max. value) of all columns
@@ -375,8 +568,8 @@ std::ostream& operator<<(std::ostream &os, const BooleanColMatrix_base<IT, D> &m
 
     for (unsigned c=0; c < mat.width(); ++c) {
         // Get the sorted c-th column
-        std::list<IT> col(mat.getColumn(c).size());
-        copy(mat.getColumn(c).begin(), mat.getColumn(c).end(), col.begin());
+        std::list<IT> col(mat.get_column(c).size());
+        copy(mat.get_column(c).begin(), mat.get_column(c).end(), col.begin());
         cols.push_back(col);
 
         os << "-";
@@ -407,11 +600,26 @@ std::ostream& operator<<(std::ostream &os, const BooleanColMatrix_base<IT, D> &m
 }
 
 template<class IT, class D>
-std::ostream& operator<<(std::ostream &os, BooleanColMatrix_base<IT, D> &mat) {
-    const BooleanColMatrix_base<IT, D> &m = mat;
+std::ostream& operator<<(std::ostream &os, boolean_colmatrix_base<IT, D> &mat) {
+    const boolean_colmatrix_base<IT, D> &m = mat;
     return os << m;
 }
 
+template<class T>
+std::ostream& operator<<(std::ostream& os, const std::vector<T> &vec) {
+    os << "[";
+
+    typename std::vector<T>::const_iterator it = vec.begin();
+    while ( it != vec.end()) {
+        os << *it;
+        if (++it != vec.end())
+            os << " ";
+    }
+
+    os << "]";
+    return os;
+}
+
 }
 
 #endif