OpenStructure
build-dev-doc
stage
include
ost
seq
alg
sequence_identity.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_SEQUENCE_IDENTITY_HH
20
#define OST_SEQ_SEQUENCE_IDENTITY_HH
21
22
/*
23
Author: Marco Biasini
24
*/
25
#include <
ost/seq/alg/module_config.hh
>
26
#include <
ost/seq/alignment_handle.hh
>
27
28
namespace
ost
{
namespace
seq {
namespace
alg {
29
30
struct
RefMode
{
31
enum
Type
{
32
ALIGNMENT
=0,
33
LONGER_SEQUENCE
34
};
35
};
36
47
Real
DLLEXPORT_OST_SEQ_ALG
48
SequenceIdentity
(
const
AlignmentHandle
& aln,
49
RefMode::Type
ref_mode=
RefMode::LONGER_SEQUENCE
,
50
int
seq_a=0,
int
seq_b=1);
51
52
}}}
53
54
#endif
alignment_handle.hh
ost::seq::AlignmentHandle
representation of a multiple sequence alignemnt consisting of two or more sequences
Definition:
alignment_handle.hh:53
Real
float Real
Definition:
base.hh:44
ost::seq::alg::SequenceIdentity
Real DLLEXPORT_OST_SEQ_ALG SequenceIdentity(const AlignmentHandle &aln, RefMode::Type ref_mode=RefMode::LONGER_SEQUENCE, int seq_a=0, int seq_b=1)
calculate sequence identity for two sequences in an alignment
ost
Definition:
base.dox:1
module_config.hh
DLLEXPORT_OST_SEQ_ALG
#define DLLEXPORT_OST_SEQ_ALG
Definition:
module_config.hh:27
ost::seq::alg::RefMode
Definition:
sequence_identity.hh:30
ost::seq::alg::RefMode::Type
Type
Definition:
sequence_identity.hh:31
ost::seq::alg::RefMode::ALIGNMENT
@ ALIGNMENT
Definition:
sequence_identity.hh:32
ost::seq::alg::RefMode::LONGER_SEQUENCE
@ LONGER_SEQUENCE
Definition:
sequence_identity.hh:33
Generated by
1.9.1