[MISC] Deprecate seqan3::gap_score, seqan3::gap_open_score and seqan3…

…::gap_scheme.
seqan · Sep 8, 2020 · 378bbed · 378bbed
1 parent 4832b78
commit 378bbed
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 138 deletions.
diff --git a/include/seqan3/alignment/scoring/gap_scheme.hpp b/include/seqan3/alignment/scoring/gap_scheme.hpp
@@ -33,7 +33,7 @@ namespace seqan3
  * \see seqan3::gap_scheme
  */
 template <arithmetic score_type>
-struct gap_score : detail::strong_type<score_type, gap_score<score_type>, detail::strong_type_skill::convert>
+struct SEQAN3_DEPRECATED_310 gap_score : detail::strong_type<score_type, gap_score<score_type>, detail::strong_type_skill::convert>
 {
      using detail::strong_type<score_type, gap_score<score_type>, detail::strong_type_skill::convert>::strong_type;
 };
@@ -59,7 +59,7 @@ gap_score(score_type) -> gap_score<score_type>;
  * \see seqan3::gap_scheme
  */
 template <arithmetic score_type>
-struct gap_open_score : detail::strong_type<score_type, gap_open_score<score_type>, detail::strong_type_skill::convert>
+struct SEQAN3_DEPRECATED_310 gap_open_score : detail::strong_type<score_type, gap_open_score<score_type>, detail::strong_type_skill::convert>
 {
      using detail::strong_type<score_type, gap_open_score<score_type>, detail::strong_type_skill::convert>::strong_type;
 };
@@ -84,7 +84,7 @@ gap_open_score(score_type) -> gap_open_score<score_type>;
  * \ingroup scoring
  */
 template <arithmetic score_t = int8_t>
-class gap_scheme
+class SEQAN3_DEPRECATED_310 gap_scheme
 {
 public:
 
@@ -131,7 +131,7 @@ class gap_scheme
      * \tparam score_arg_t The underlying type of the arguments.
      * \param[in] g  The cost of each gap character (of type seqan3::gap_score).
      * \param[in] go The additional cost per sequence of gaps (of type seqan3::gap_open_score).
-     * \throws std::invalid_argument Thrown if you pass a value that is to large/low to be represented by `score_t`.
+     * \throws std::invalid_argument Thrown if you pass a value that is too large/low to be represented by `score_t`.
      *
      * \details
      *

diff --git a/test/unit/alignment/scoring/CMakeLists.txt b/test/unit/alignment/scoring/CMakeLists.txt
@@ -1,4 +1,3 @@
-seqan3_test(gap_scheme_test.cpp)
 seqan3_test(scoring_scheme_test.cpp)
 seqan3_test(simd_match_mismatch_scoring_scheme_test.cpp)
 seqan3_test(simd_matrix_scoring_scheme_test.cpp)
diff --git a/test/unit/alignment/scoring/gap_scheme_test.cpp b/test/unit/alignment/scoring/gap_scheme_test.cpp