A library for working with phylogenetic and population genetic data.
v0.27.0
utils/math/twobit_vector/functions.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_UTILS_MATH_TWOBIT_VECTOR_FUNCTIONS_H_
2 #define GENESIS_UTILS_MATH_TWOBIT_VECTOR_FUNCTIONS_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2017 Lucas Czech
7 
8  This program is free software: you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation, either version 3 of the License, or
11  (at your option) any later version.
12 
13  This program is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with this program. If not, see <http://www.gnu.org/licenses/>.
20 
21  Contact:
22  Lucas Czech <lucas.czech@h-its.org>
23  Exelixis Lab, Heidelberg Institute for Theoretical Studies
24  Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
25 */
26 
35 
36 #include <string>
37 
38 namespace genesis {
39 namespace utils {
40 
41 // =================================================================================================
42 // Strings
43 // =================================================================================================
44 
47 
48 TwobitVector from_nucleic_acids( std::string const& sequence );
49 std::string to_nucleic_acids( TwobitVector const& vec );
50 
51 std::string bitstring( TwobitVector const& vec );
52 std::string bitstring( TwobitVector::WordType const& vec );
53 
54 } // namespace utils
55 } // namespace genesis
56 
57 #endif // include guard
twobit_vector.hpp
genesis::utils::translate_from_nucleic_acid
TwobitVector::ValueType translate_from_nucleic_acid(char site)
Translate a char into TwobitVector::ValueType.
Definition: utils/math/twobit_vector/functions.cpp:49
genesis::utils::TwobitVector::WordType
uint64_t WordType
Underlying word type for the bitvector.
Definition: twobit_vector.hpp:55
genesis::utils::to_nucleic_acids
std::string to_nucleic_acids(TwobitVector const &vec)
Turn a TwobitVector into its string representation of nucleic acids.
Definition: utils/math/twobit_vector/functions.cpp:107
genesis::utils::bitstring
std::string bitstring(TwobitVector const &vec)
Return a string with a bit-representation of a TwobitVector.
Definition: utils/math/twobit_vector/functions.cpp:124
genesis::utils::TwobitVector::ValueType
ValueType
Value Type enumeration for the elements of a TwobitVector.
Definition: twobit_vector.hpp:66
genesis
Container namespace for all symbols of genesis in order to keep them separate when used as a library.
Definition: placement/formats/edge_color.cpp:42
genesis::utils::translate_to_nucleic_acid
char translate_to_nucleic_acid(TwobitVector::ValueType value)
Translate a TwobitVector::ValueType into its char representation.
Definition: utils/math/twobit_vector/functions.cpp:78
genesis::utils::from_nucleic_acids
TwobitVector from_nucleic_acids(std::string const &sequence)
Turn a string of nucleic acids into a TwobitVector.
Definition: utils/math/twobit_vector/functions.cpp:93