SeqAn3
3.0.2
The Modern C++ library for sequence analysis.
•
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Modules
Pages
header.hpp
Go to the documentation of this file.
1
// -----------------------------------------------------------------------------------------------------
2
// Copyright (c) 2006-2020, Knut Reinert & Freie Universität Berlin
3
// Copyright (c) 2016-2020, Knut Reinert & MPI für molekulare Genetik
4
// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
5
// shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
6
// -----------------------------------------------------------------------------------------------------
7
13
#pragma once
14
15
#include <
deque
>
16
#include <
unordered_map
>
17
#include <
vector
>
18
19
#include <
seqan3/alphabet/concept.hpp
>
20
#include <
seqan3/core/type_traits/pre.hpp
>
21
#include <
seqan3/io/alignment_file/detail.hpp
>
22
#include <
seqan3/range/hash.hpp
>
23
#include <
seqan3/range/views/type_reduce.hpp
>
24
#include <
seqan3/std/ranges
>
25
26
namespace
seqan3
27
{
28
31
template
<std::ranges::forward_range ref_
id
s_type = std::deque<std::
string
>>
32
class
alignment_file_header
33
{
34
public
:
38
alignment_file_header
() =
default
;
41
alignment_file_header
(
alignment_file_header
const
&) =
default
;
43
alignment_file_header
&
operator=
(
alignment_file_header
const
&) =
default
;
45
alignment_file_header
(
alignment_file_header
&&) =
default
;
47
alignment_file_header
&
operator=
(
alignment_file_header
&&) =
default
;
49
~alignment_file_header
() =
default
;
50
54
alignment_file_header
(ref_ids_type &
ref_ids
) :
55
ref_ids_ptr{&
ref_ids
, ref_ids_deleter_noop}
56
{}
57
61
alignment_file_header
(ref_ids_type &&
ref_ids
) :
62
ref_ids_ptr{
new
ref_ids_type{
std::move
(
ref_ids
)}, ref_ids_deleter_default}
63
{}
65
67
struct
program_info_t
68
{
69
std::string
id
;
70
std::string
name
;
71
std::string
command_line_call
;
72
std::string
previous
;
73
std::string
description
;
74
std::string
version
;
75
};
76
77
std::string
format_version
;
78
std::string
sorting
;
79
std::string
subsorting
;
80
std::string
grouping
;
81
82
std::vector<program_info_t>
program_infos
;
83
84
std::vector<std::string>
comments
;
85
86
private
:
88
using
ref_ids_ptr_t
=
std::unique_ptr
<ref_ids_type,
std::function
<void(ref_ids_type*)>>;
90
static
void
ref_ids_deleter_noop(ref_ids_type *) {}
92
static
void
ref_ids_deleter_default(ref_ids_type * ptr) {
delete
ptr; }
94
using
key_type =
std::conditional_t<std::ranges::contiguous_range<std::ranges::range_reference_t<ref_ids_type>
>,
95
std::span<range_innermost_value_t<ref_ids_type>
const
>,
96
type_reduce_view<std::ranges::range_reference_t<ref_ids_type>>>;
98
ref_ids_ptr_t ref_ids_ptr{
new
ref_ids_type{}, ref_ids_deleter_default};
99
100
public
:
119
ref_ids_type &
ref_ids
()
120
{
121
return
*ref_ids_ptr;
122
}
123
155
std::vector<std::tuple<int32_t, std::string>
>
ref_id_info
{};
156
158
std::unordered_map<key_type, int32_t, std::hash<key_type>
, detail::view_equality_fn>
ref_dict
{};
159
194
std::vector<std::pair<std::string, std::string>
>
read_groups
;
195
};
196
197
}
// namespace seqan3
seqan3::alignment_file_header::program_info_t::name
std::string name
The official name.
Definition:
header.hpp:70
seqan3::alignment_file_header::format_version
std::string format_version
The file format version. Note: this is overwritten by our formats on output.
Definition:
header.hpp:77
seqan3::alignment_file_header::alignment_file_header
alignment_file_header(alignment_file_header &&)=default
Move construction is defaulted.
std::span
pre.hpp
Provides various transformation trait base templates and shortcuts.
std::string
seqan3::alignment_file_header::program_info_t::command_line_call
std::string command_line_call
The command line call that produces the file.
Definition:
header.hpp:71
seqan3::alignment_file_header::program_info_t::id
std::string id
A unique (file scope) id.
Definition:
header.hpp:69
seqan3::alignment_file_header::read_groups
std::vector< std::pair< std::string, std::string > > read_groups
The Read Group Dictionary (used by the SAM/BAM format).
Definition:
header.hpp:194
vector
seqan3::alignment_file_header::operator=
alignment_file_header & operator=(alignment_file_header const &)=default
Copy assignment is defaulted.
seqan3::alignment_file_header::program_info_t::previous
std::string previous
The id of the previous program if program calls were chained.
Definition:
header.hpp:72
std::function
seqan3::alignment_file_header::ref_ids
ref_ids_type & ref_ids()
The range of reference ids.
Definition:
header.hpp:119
seqan3::alignment_file_header::alignment_file_header
alignment_file_header(ref_ids_type &&ref_ids)
Construct from a rvalue range of reference ids which is moved into the ref_ids_ptr (owning).
Definition:
header.hpp:61
seqan3::alignment_file_header::~alignment_file_header
~alignment_file_header()=default
Destructor is defaulted.
seqan3::alignment_file_header::alignment_file_header
alignment_file_header(alignment_file_header const &)=default
Copy construction is defaulted.
seqan3::alignment_file_header::program_info_t
Stores information of the program/tool that was used to create the file.
Definition:
header.hpp:68
seqan3::alignment_file_header::comments
std::vector< std::string > comments
The list of comments.
Definition:
header.hpp:84
seqan3::views::move
auto const move
A view that turns lvalue-references into rvalue-references.
Definition:
move.hpp:68
seqan3::alignment_file_header
Stores the header information of alignment files.
Definition:
header.hpp:33
type_reduce.hpp
Provides seqan3::views::type_reduce.
seqan3::alignment_file_header::ref_dict
std::unordered_map< key_type, int32_t, std::hash< key_type >, detail::view_equality_fn > ref_dict
The mapping of reference id to position in the ref_ids() range and the ref_id_info range.
Definition:
header.hpp:158
seqan3
The main SeqAn3 namespace.
Definition:
aligned_sequence_concept.hpp:29
seqan3::alignment_file_header::alignment_file_header
alignment_file_header(ref_ids_type &ref_ids)
Construct from a range of reference ids which redirects the ref_ids_ptr member (non-owning).
Definition:
header.hpp:54
seqan3::alignment_file_header::sorting
std::string sorting
The sorting of the file. SAM: [unknown, unsorted, queryname, coordinate].
Definition:
header.hpp:78
seqan3::alignment_file_header::program_info_t::description
std::string description
A description of the program and/or program call.
Definition:
header.hpp:73
seqan3::alignment_file_header::alignment_file_header
alignment_file_header()=default
Default constructor is defaulted.
deque
detail.hpp
Auxiliary functions for the alignment IO.
ranges
Adaptations of concepts from the Ranges TS.
seqan3::alignment_file_header::ref_id_info
std::vector< std::tuple< int32_t, std::string > > ref_id_info
The reference information. (used by the SAM/BAM format)
Definition:
header.hpp:155
seqan3::alignment_file_header::subsorting
std::string subsorting
The sub-sorting of the file. SAM: [unknown, unsorted, queryname, coordinate](:[A-Za-z0-9_-]+)+.
Definition:
header.hpp:79
seqan3::alignment_file_header::operator=
alignment_file_header & operator=(alignment_file_header &&)=default
Move assignment is defaulted.
seqan3::alignment_file_header::grouping
std::string grouping
The grouping of the file. SAM: [none, query, reference].
Definition:
header.hpp:80
hash.hpp
Provides overloads for std::hash.
seqan3::alignment_file_header::program_info_t::version
std::string version
The program/tool version.
Definition:
header.hpp:74
std::conditional_t
std::unique_ptr
unordered_map
seqan3::alignment_file_header::program_infos
std::vector< program_info_t > program_infos
The list of program information.
Definition:
header.hpp:82
concept.hpp
Core alphabet concept and free function/type trait wrappers.
Version:
main_user
main_dev
3.4.0
3.3.0
3.2.0
3.1.0
3.0.3
3.0.2
3.0.1
3.0.0
seqan3
io
alignment_file
header.hpp
Generated on Thu Dec 3 2020 18:58:18 for SeqAn3 by
1.8.20