Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misc/remove char type from file #1400

Merged
merged 7 commits into from
Dec 13, 2019

Conversation

rrahn
Copy link
Contributor

@rrahn rrahn commented Dec 5, 2019

Fixes #1399

Removes the char type from the files.

It also fixes the file exposer which caused hard fails in the format concept checks due to the using statement to import the read/write interfaces for the different file formats. The problem here is that for types that are not formats the using declaration causes compiler errors, which are different from not finding an viable overload. This was first visible when the char type was removed. Also I am not quite sure why?
Strangely, the exposer were not documented nor excluded from documentation but doxygen didn't trigger a warning. Not sure why? But I added the documentation for them as well.

A changelog will be added soon as well.
I also need to check at which places the documentation explicitly refers to the char type. There were three snippets that used it.

@rrahn rrahn requested a review from joergi-w December 5, 2019 17:12
@codecov
Copy link

codecov bot commented Dec 5, 2019

Codecov Report

Merging #1400 into master will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1400      +/-   ##
==========================================
+ Coverage   97.53%   97.54%   +<.01%     
==========================================
  Files         229      231       +2     
  Lines        8735     8747      +12     
==========================================
+ Hits         8520     8532      +12     
  Misses        215      215
Impacted Files Coverage Δ
include/seqan3/io/alignment_file/output.hpp 100% <ø> (ø) ⬆️
include/seqan3/io/structure_file/output.hpp 100% <ø> (ø) ⬆️
include/seqan3/io/structure_file/input.hpp 100% <ø> (ø) ⬆️
include/seqan3/io/sequence_file/input.hpp 100% <ø> (ø) ⬆️
include/seqan3/io/alignment_file/input.hpp 100% <ø> (ø) ⬆️
include/seqan3/io/sequence_file/output.hpp 100% <ø> (ø) ⬆️
.../seqan3/io/sequence_file/output_format_concept.hpp 100% <100%> (ø) ⬆️
.../seqan3/io/structure_file/input_format_concept.hpp 100% <100%> (ø)
...seqan3/io/alignment_file/output_format_concept.hpp 100% <100%> (ø) ⬆️
...seqan3/io/structure_file/output_format_concept.hpp 100% <100%> (ø)
... and 4 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 5984432...3c05f51. Read the comment docs.

Copy link
Member

@joergi-w joergi-w left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, looks good!
Please check these three small issues in the documentation:

include/seqan3/io/sequence_file/input_format_concept.hpp Outdated Show resolved Hide resolved
include/seqan3/io/sequence_file/input_format_concept.hpp Outdated Show resolved Hide resolved
include/seqan3/io/sequence_file/output_format_concept.hpp Outdated Show resolved Hide resolved
@rrahn rrahn requested a review from joergi-w December 6, 2019 11:22
@rrahn rrahn requested a review from smehringer December 6, 2019 19:56
@rrahn rrahn force-pushed the misc/remove_char_type_from_file branch from 1b3a3fa to 751fa98 Compare December 6, 2019 20:08
@rrahn rrahn requested a review from smehringer December 9, 2019 22:20
@rrahn rrahn force-pushed the misc/remove_char_type_from_file branch 2 times, most recently from fc22e1f to 5768afb Compare December 10, 2019 22:23
typename tag_dict_type,
typename e_value_type,
typename bit_score_type>
void read_alignment_record(stream_type & stream,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you replace this at least with

template <typename arg_types...>
void read_alignment_record(arg_types ...args)
{ // ...
}

? We do enough concept checks to enforce the proper parameters?

@rrahn rrahn force-pushed the misc/remove_char_type_from_file branch from 5768afb to d5af8a7 Compare December 12, 2019 07:08
Copy link
Member

@smehringer smehringer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more tiny thing. Otherwise LGTM

@@ -829,61 +833,56 @@ class alignment_file_output
/*!\brief Deduces selected_field_ids from input and sets alignment_file_output::ref_ids_type to
* seqan3::detail::ref_info_not_given. Valid formats and stream_char_type are defaulted.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You forgot to adapt the documentation in this file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch

@rrahn rrahn force-pushed the misc/remove_char_type_from_file branch from d5af8a7 to 8ee5ae1 Compare December 13, 2019 07:06
@smehringer
Copy link
Member

travis still fails

@rrahn rrahn force-pushed the misc/remove_char_type_from_file branch from 8ee5ae1 to 3c05f51 Compare December 13, 2019 10:54
@rrahn
Copy link
Contributor Author

rrahn commented Dec 13, 2019

travis still fails

Documentation was broken due to the last changes. Is not fixed. I'll merge when it run through

@smehringer smehringer merged commit e4fa221 into seqan:master Dec 13, 2019
@rrahn rrahn deleted the misc/remove_char_type_from_file branch January 16, 2020 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[IO] Remove the char_type template parameter
3 participants