OpenStructure
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
entropy.hh
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 // This file is part of the OpenStructure project <www.openstructure.org>
3 //
4 // Copyright (C) 2008-2020 by the OpenStructure authors
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License as published by the Free
8 // Software Foundation; either version 3.0 of the License, or (at your option)
9 // any later version.
10 // This library is distributed in the hope that it will be useful, but WITHOUT
11 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
13 // details.
14 //
15 // You should have received a copy of the GNU Lesser General Public License
16 // along with this library; if not, write to the Free Software Foundation, Inc.,
17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 //------------------------------------------------------------------------------
19 #ifndef OST_SEQ_ALG_ENTROPY_HH
20 #define OST_SEQ_ALG_ENTROPY_HH
21 
22 #include <vector>
23 
25 
26 #include "module_config.hh"
27 
28 namespace ost { namespace seq { namespace alg {
29 
31 std::vector<Real> DLLEXPORT_OST_SEQ_ALG ShannonEntropy(const AlignmentHandle& aln,
32  bool ignore_gaps=true);
33 
34 }}}
35 #endif
36 
#define DLLEXPORT_OST_SEQ_ALG
std::vector< Real > DLLIMPORT ShannonEntropy(const AlignmentHandle &aln, bool ignore_gaps=true)
calculates the Shannon entropy for each column in the alignment