[MISC] deprecate seqan3::views::to_upper

seqan · Apr 20, 2021 · 483cfe6 · 483cfe6
1 parent 50af89f
commit 483cfe6
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 177 deletions.
diff --git a/include/seqan3/range/views/to_upper.hpp b/include/seqan3/range/views/to_upper.hpp
@@ -7,70 +7,10 @@
 
 /*!\file
  * \author Tobias Loka <LokaT AT rki.de>
- * \brief Provides seqan3::views::to_upper.
+ * \brief [DEPRECATED] Provides seqan3::views::to_upper.
  */
 
 #pragma once
 
-#include <seqan3/std/ranges>
-
-#include <seqan3/alphabet/concept.hpp>
-#include <seqan3/range/views/deep.hpp>
-#include <seqan3/utility/char_operations/transform.hpp>
-
-namespace seqan3::views
-{
-
-/*!\name General purpose views
- * \{
- */
-
-/*!\brief               A view that calls seqan3::to_upper() on each element in the input range.
- * \tparam urng_t       The type of the range being processed. See below for requirements. [template parameter is
- *                      omitted in pipe notation]
- * \param[in] urange    The range being processed. [parameter is omitted in pipe notation]
- * \returns             A range of converted elements. See below for the properties of the returned range.
- * \ingroup views
- *
- * \details
- *
- * \header_file{seqan3/range/views/to_upper.hpp}
- *
- * ### View properties
- *
- * This view is a **deep view** Given a range-of-range as input (as opposed to just a range), it will apply
- * the transformation on the innermost range (instead of the outermost range).
- *
- * | Concepts and traits              | `urng_t` (underlying range type) | `rrng_t` (returned range type)                                     |
- * |----------------------------------|:--------------------------------:|:------------------------------------------------------------------:|
- * | std::ranges::input_range         | *required*                       | *preserved*                                                        |
- * | std::ranges::forward_range       |                                  | *preserved*                                                        |
- * | std::ranges::bidirectional_range |                                  | *preserved*                                                        |
- * | std::ranges::random_access_range |                                  | *preserved*                                                        |
- * | std::ranges::contiguous_range    |                                  | *lost*                                                             |
- * |                                  |                                  |                                                                    |
- * | std::ranges::viewable_range      | *required*                       | *guaranteed*                                                       |
- * | std::ranges::view                |                                  | *guaranteed*                                                       |
- * | std::ranges::sized_range         |                                  | *preserved*                                                        |
- * | std::ranges::common_range        |                                  | *preserved*                                                        |
- * | std::ranges::output_range        |                                  | *lost*                                                             |
- * | seqan3::const_iterable_range     |                                  | *preserved*                                                        |
- * |                                  |                                  |                                                                    |
- * | std::ranges::range_reference_t   | seqan3::builtin_character        | seqan3::remove_reference_t<std::ranges::range_reference_t<urngt_>> |
-  *
- * See the \link views views submodule documentation \endlink for detailed descriptions of the view properties.
- *
- * ### Example
- * \include test/snippet/range/views/to_upper.cpp
- * \hideinitializer
- */
-inline auto const to_upper = deep{std::views::transform([] (auto const in) noexcept
-{
-    static_assert(builtin_character<std::remove_cvref_t<decltype(in)>>,
-                  "The value type of seqan3::views::to_upper must model the seqan3::builtin_character.");
-    return seqan3::to_upper(in);
-})};
-
-//!\}
-
-} // namespace seqan3::views
+SEQAN3_DEPRECATED_HEADER(
+   "This header is deprecated and will be removed in SeqAn-3.1.0.")
diff --git a/test/snippet/range/views/to_upper.cpp b/test/snippet/range/views/to_upper.cpp
diff --git a/test/unit/range/views/CMakeLists.txt b/test/unit/range/views/CMakeLists.txt
@@ -24,7 +24,6 @@ seqan3_test(take_line_test.cpp)
 seqan3_test(to_char_test.cpp)
 seqan3_test(to_lower_test.cpp)
 seqan3_test(to_rank_test.cpp)
-seqan3_test(to_upper_test.cpp)
 seqan3_test(translate_join_test.cpp)
 seqan3_test(translate_test.cpp)
 seqan3_test(trim_quality_test.cpp)

diff --git a/test/unit/range/views/to_upper_test.cpp b/test/unit/range/views/to_upper_test.cpp