Changeset 3391 for trunk/yat/utility/SmithWaterman.h

Timestamp:

Mar 16, 2015, 8:51:09 AM (8 years ago)

Author:

Peter

Message:

document requirements in SmithWaterman?. refs #803

File:

• trunk/yat/utility/SmithWaterman.h (modified) (3 diffs)

trunk/yat/utility/SmithWaterman.h

@@ -25 +25 @@
 #include "Aligner.h"
 #include "Matrix.h"
+
+#include <boost/concept_check.hpp>
 
 #include <cstddef> // size_t
@@ -97 +99 @@
        reference_end-reference_begin where the element ij is 1.0 if
        reference_begin[i] == query_begin[j] and -mismatch otherwise.
+
+       Type Requirements:
+       - \c RandomAccessIterator1 is a \readable_iterator
+       - \c RandomAccessIterator1 is a \random_access_traversal_iterator
+       - \c RandomAccessIterator2 is a \readable_iterator
+       - \c RandomAccessIterator2 is a \random_access_traversal_iterator
      */
     template<typename RandomAccessIterator1, typename RandomAccessIterator2>
@@ -121 +129 @@
                                    double mismatch)
   {
+    using boost_concepts::ReadableIterator;
+    using boost_concepts::RandomAccessTraversal;
+    BOOST_CONCEPT_ASSERT((ReadableIterator<RandomAccessIterator1>));
+    BOOST_CONCEPT_ASSERT((RandomAccessTraversal<RandomAccessIterator1>));
+    BOOST_CONCEPT_ASSERT((ReadableIterator<RandomAccessIterator2>));
+    BOOST_CONCEPT_ASSERT((RandomAccessTraversal<RandomAccessIterator2>));
     Matrix dot(reference_end-reference_begin, query_end-query_begin, -mismatch);
     for (size_t i=0; i<dot.rows(); ++i)