Move the type traits submodule to utility #2265

joergi-w · 2020-11-17T12:09:43Z

For the reviewer: I strongly recommend to review commit-wise! I created separate commits for moving the files and creating the deprecation note, so the moved file contents do not appear (you see ~90% less).

This PR moves the files from core/type_traits to the position specified below (in the deleted paths there are still header files with a deprecation note).

all.hpp basic.hpp concept.hpp pre.hpp ⇒ utility/type_traits/
transformation_trait_or.hpp ⇒ utility/type_traits/detail/
function.hpp ⇒ utility/type_traits/function_traits.hpp and utility/detail/multi_invocable.hpp
lazy.hpp ⇒ utility/type_traits/lazy_conditional.hpp and core/detail/is_class_template_declarable.hpp
deferred_crtp_base.hpp template_inspection.hpp ⇒ core/detail/
iterator.hpp ⇒ core/detail/iterator_traits.hpp
range.hpp ⇒ core/range/type_traits.hpp (remove range_compatible)
pack.hpp ⇒ deleted

part of seqan/product_backlog#160

codecov · 2020-11-17T12:43:39Z

Codecov Report

Merging #2265 (f8cafc2) into master (b6e8e19) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2265   +/-   ##
=======================================
  Coverage   98.15%   98.15%           
=======================================
  Files         262      262           
  Lines       10815    10815           
=======================================
  Hits        10616    10616           
  Misses        199      199

Impacted Files	Coverage Δ
...ment/configuration/align_config_scoring_scheme.hpp	`100.00% <ø> (ø)`
...e/seqan3/alignment/matrix/alignment_coordinate.hpp	`100.00% <ø> (ø)`
...lude/seqan3/alignment/matrix/alignment_optimum.hpp	`100.00% <ø> (ø)`
include/seqan3/alignment/matrix/debug_matrix.hpp	`98.07% <ø> (ø)`
...ignment/matrix/detail/aligned_sequence_builder.hpp	`100.00% <ø> (ø)`
...etail/alignment_matrix_column_major_range_base.hpp	`100.00% <ø> (ø)`
.../matrix/detail/combined_score_and_trace_matrix.hpp	`100.00% <ø> (ø)`
...qan3/alignment/matrix/detail/coordinate_matrix.hpp	`100.00% <ø> (ø)`
...qan3/alignment/matrix/detail/trace_matrix_full.hpp	`100.00% <ø> (ø)`
...alignment/matrix/detail/two_dimensional_matrix.hpp	`97.67% <ø> (ø)`
... and 71 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b6e8e19...f8cafc2. Read the comment docs.

smehringer · 2020-11-18T08:52:31Z

Please use the [MISC] tag for the commits :)

joergi-w · 2020-11-18T09:22:17Z

Please use the [MISC] tag for the commits :)

Thanks! :)

eseiler

Can you re-add the #pragma once in the deprecated headers? You sometimes removed it.

include/seqan3/utility/type_traits/all.hpp

joergi-w · 2020-11-19T13:04:31Z

Can you re-add the #pragma once in the deprecated headers? You sometimes removed it.

Sure! I also created all.hpp for Utility module, in order to define the utility group for doxygen.

eseiler

Thank you

smehringer

First batch :) I will review the rest tomorrow

smehringer · 2020-11-19T13:39:30Z

include/seqan3/core/detail/deferred_crtp_base.hpp

+{
+
+/*!\brief An invocable wrapper that defers the instantiation of a crtp_base class.
+ * \ingroup type_traits


is this \ingroup command still correct? I think it has to be \ingroup core

Check all other ingroups in this file too

include/seqan3/core/detail/all.hpp

smehringer · 2020-11-19T13:56:56Z

include/seqan3/core/detail/iterator_traits.hpp

+namespace seqan3
+{
+
+/*!\addtogroup type_traits


Suggested change

/*!\addtogroup type_traits

/*!\addtogroup core

smehringer · 2020-11-19T13:57:32Z

include/seqan3/core/detail/template_inspection.hpp

+
+/*!\file
+ * \author Hannes Hauswedell <hannes.hauswedell AT fu-berlin.de>
+ * \brief Provides seqan3::type_list and auxiliary type traits.


This brief seems wrong 🤔

smehringer · 2020-11-19T13:57:54Z

include/seqan3/core/detail/template_inspection.hpp

+
+/*!\brief Determines whether a source_type is a specialisation of another template.
+ * \implements seqan3::unary_type_trait
+ * \ingroup type_traits


also check the ingroup commands in this file

smehringer · 2020-11-19T13:58:23Z

include/seqan3/core/range/type_traits.hpp

+namespace seqan3
+{
+
+/*!\addtogroup type_traits


check ingroup commands

smehringer · 2020-11-19T14:02:48Z

include/seqan3/core/range/type_traits.hpp

+// value_type
+// ----------------------------------------------------------------------------
+
+#ifdef SEQAN3_DEPRECATED_310


why did you deprecate all of this? I thought only range_compatible should be deprecated?

This would have been easier if it would have been done in a separate PR ;) for next time.

These #ifdef SEQAN3_DEPRECATED_310 were already in the type_traits/range.hpp before and I didn't decide to deprecate this. I simply moved the whole file without changing its content (except removing range_compatible in the following commit). If you look at the individual commits it should become clearer where I moved a file or where I changed content.

Ah ok! sorry I missed that :)

smehringer · 2020-11-19T14:05:11Z

include/seqan3/core/type_traits/all.hpp

+SEQAN3_DEPRECATED_HEADER("This header is deprecated and will be removed in SeqAn-3.1. "
+                         "Please #include <seqan3/utility/type_traits/all.hpp> instead.")


Please leave the one liner even though it exceeds the line length. If you break the line here, unfortunately the second line is not properly displayed to the user if triggered.

Same for all other files

Oops, I didn't know... I'll change it!

smehringer · 2020-11-20T14:33:33Z

Oh oh.. a lot of merge conflicts. hopefully just concering the inlcudes. I hope its fine if I review after you resolved them. :)

joergi-w · 2020-11-23T11:36:11Z

Rebased on master.

…tible concept

…cated headers

…; fix a file description

joergi-w · 2020-11-23T11:58:44Z

Rebased on master.

joergi-w force-pushed the refactor/type_traits branch 3 times, most recently from 233ce7d to 2525633 Compare November 18, 2020 01:10

marehr mentioned this pull request Nov 18, 2020

[MISC] Adds new concept template_specialisation_of. #2263

Merged

joergi-w force-pushed the refactor/type_traits branch 4 times, most recently from 73a8d1b to 0176900 Compare November 19, 2020 10:13

joergi-w marked this pull request as ready for review November 19, 2020 10:43

joergi-w requested review from a team and eseiler and removed request for a team November 19, 2020 11:02

eseiler requested changes Nov 19, 2020

View reviewed changes

include/seqan3/utility/type_traits/all.hpp Outdated Show resolved Hide resolved

joergi-w requested a review from eseiler November 19, 2020 13:04

eseiler approved these changes Nov 19, 2020

View reviewed changes

eseiler requested review from a team and smehringer and removed request for a team November 19, 2020 13:07

smehringer requested changes Nov 19, 2020

View reviewed changes

joergi-w force-pushed the refactor/type_traits branch from e9e6c07 to 2d01292 Compare November 23, 2020 11:33

joergi-w requested a review from smehringer November 23, 2020 11:37

joergi-w added 3 commits November 23, 2020 12:54

[MISC] move type_traits/concept to utility

49a1186

[MISC] add deprecation note for type_traits/concept

3de358d

[MISC] move type_traits/basic to utility

32d1048

joergi-w added 23 commits November 23, 2020 12:54

[MISC] add deprecation note for type_traits/basic

8200c83

[MISC] move type_traits/deferred_crtp_base to detail

039d56c

[MISC] add deprecation note for type_traits/deferred_crtp_base

6b34f55

[MISC] move type_traits/function to utility

f04ba1d

[MISC] add deprecation note for type_traits/function

decf36f

[MISC] move type_traits/iterator to detail

c926e20

[MISC] add deprecation note for type_traits/iterator

6d98848

[MISC] move type_traits/pre to utility

d6bd04c

[MISC] add deprecation note for type_traits/pre

2a7ad60

[MISC] move type_traits/template_inspection to detail

9598692

[MISC] add deprecation note for type_traits/template_inspection

79bbd51

[MISC] move type_traits/transformation_trait_or to utility

696b6f9

[MISC] add deprecation note for type_traits/transformation_trait_or

63485af

[MISC] move type_traits/range to core/range

705b394

[MISC] add deprecation note for type_traits/range; remove range_compa…

aa1ed00

…tible concept

[MISC] move type_traits/lazy to utility

fdd8abf

[MISC] add deprecation note for type_traits/lazy

05dd69d

[MISC] add deprecation note for type_traits/pack

0423f89

[MISC] move type_traits/all to utility; add deprecation note

bcaedb0

[MISC] move type_traits unit tests to utility or core/detail

f47c3f6

[MISC] move type_traits snippets to utility or core/detail

9dca460

[DOC, MISC] create group for Utility module; add pragma once to depre…

2ba7f77

…cated headers

[DOC, MISC] correct doxygen group; deprecation notes in a single line…

f8cafc2

…; fix a file description

joergi-w force-pushed the refactor/type_traits branch from 2d01292 to f8cafc2 Compare November 23, 2020 11:58

smehringer approved these changes Nov 23, 2020

View reviewed changes

eseiler merged commit 9dbfcb4 into seqan:master Nov 23, 2020

joergi-w deleted the refactor/type_traits branch November 23, 2020 14:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move the type traits submodule to utility #2265

Move the type traits submodule to utility #2265

joergi-w commented Nov 17, 2020 •

edited by smehringer

Loading

codecov bot commented Nov 17, 2020 •

edited

Loading

smehringer commented Nov 18, 2020

joergi-w commented Nov 18, 2020

eseiler left a comment

joergi-w commented Nov 19, 2020

eseiler left a comment

smehringer left a comment

smehringer Nov 19, 2020

smehringer Nov 19, 2020

smehringer Nov 19, 2020

smehringer Nov 19, 2020

smehringer Nov 19, 2020

smehringer Nov 19, 2020

joergi-w Nov 19, 2020

smehringer Nov 20, 2020

smehringer Nov 19, 2020

joergi-w Nov 19, 2020

smehringer commented Nov 20, 2020

joergi-w commented Nov 23, 2020

joergi-w commented Nov 23, 2020

		SEQAN3_DEPRECATED_HEADER("This header is deprecated and will be removed in SeqAn-3.1. "
		"Please #include <seqan3/utility/type_traits/all.hpp> instead.")

Move the type traits submodule to utility #2265

Move the type traits submodule to utility #2265

Conversation

joergi-w commented Nov 17, 2020 • edited by smehringer Loading

codecov bot commented Nov 17, 2020 • edited Loading

Codecov Report

smehringer commented Nov 18, 2020

joergi-w commented Nov 18, 2020

eseiler left a comment

Choose a reason for hiding this comment

joergi-w commented Nov 19, 2020

eseiler left a comment

Choose a reason for hiding this comment

smehringer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smehringer commented Nov 20, 2020

joergi-w commented Nov 23, 2020

joergi-w commented Nov 23, 2020

joergi-w commented Nov 17, 2020 •

edited by smehringer

Loading

codecov bot commented Nov 17, 2020 •

edited

Loading