~ubuntu-branches/ubuntu/saucy/libbpp-seq/saucy-proposed

« back to all changes in this revision

Viewing changes to src/Bpp/Seq/StateProperties/GranthamAAPolarityIndex.h

  • Committer: Package Import Robot
  • Author(s): Julien Dutheil
  • Date: 2013-03-05 14:31:00 UTC
  • mfrom: (1.1.2)
  • Revision ID: package-import@ubuntu.com-20130305143100-2jox395vr1ghao46
Tags: 2.1.0-1
* 'omics' tools now in bpp-seq-omics
* Extended BppO support
* StateProperties renamed to AlphabetIndex

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
//
2
 
// File: GranthamAAPolarityIndex.h
3
 
// Created by: Julien Dutheil
4
 
// Created on: Tue Apr 21 2005
5
 
//
6
 
 
7
 
/*
8
 
Copyright or © or Copr. CNRS, (November 17, 2004)
9
 
 
10
 
This software is a computer program whose purpose is to provide classes
11
 
for sequences analysis.
12
 
 
13
 
This software is governed by the CeCILL  license under French law and
14
 
abiding by the rules of distribution of free software.  You can  use, 
15
 
modify and/ or redistribute the software under the terms of the CeCILL
16
 
license as circulated by CEA, CNRS and INRIA at the following URL
17
 
"http://www.cecill.info". 
18
 
 
19
 
As a counterpart to the access to the source code and  rights to copy,
20
 
modify and redistribute granted by the license, users are provided only
21
 
with a limited warranty  and the software's author,  the holder of the
22
 
economic rights,  and the successive licensors  have only  limited
23
 
liability. 
24
 
 
25
 
In this respect, the user's attention is drawn to the risks associated
26
 
with loading,  using,  modifying and/or developing or reproducing the
27
 
software by the user in light of its specific status of free software,
28
 
that may mean  that it is complicated to manipulate,  and  that  also
29
 
therefore means  that it is reserved for developers  and  experienced
30
 
professionals having in-depth computer knowledge. Users are therefore
31
 
encouraged to load and test the software's suitability as regards their
32
 
requirements in conditions enabling the security of their systems and/or 
33
 
data to be ensured and,  more generally, to use and operate it in the 
34
 
same conditions as regards security. 
35
 
 
36
 
The fact that you are presently reading this means that you have had
37
 
knowledge of the CeCILL license and that you accept its terms.
38
 
*/
39
 
 
40
 
#ifndef _GRANTHAMAAPOLARITYINDEX_H_
41
 
#define _GRANTHAMAAPOLARITYINDEX_H_
42
 
 
43
 
#include "AlphabetIndex1.h"
44
 
#include "../Alphabet/ProteicAlphabet.h"
45
 
 
46
 
namespace bpp
47
 
{
48
 
 
49
 
/**
50
 
 * @brief Polarity index used in Grantham (1974).
51
 
 *
52
 
 * @code
53
 
 * Database: AAindex1
54
 
 * Entry: GRAR740102
55
 
 *
56
 
 * H GRAR740102
57
 
 * D Polarity (Grantham, 1974)
58
 
 * R LIT:2004143b PMID:4843792
59
 
 * A Grantham, R.
60
 
 * T Amino acid difference formula to help explain protein evolution
61
 
 * J Science 185, 862-864 (1974)
62
 
 * I    A/L     R/K     N/M     D/F     C/P     Q/S     E/T     G/W     H/Y     I/V
63
 
 *      8.1    10.5    11.6    13.0     5.5    10.5    12.3     9.0    10.4     5.2
64
 
 *      4.9    11.3     5.7     5.2     8.0     9.2     8.6     5.4     6.2     5.9
65
 
 * //
66
 
 * @endcode
67
 
 */
68
 
class GranthamAAPolarityIndex:
69
 
  public AlphabetIndex1<double>
70
 
{
71
 
  private:
72
 
    std::vector<double> polarity_;
73
 
 
74
 
  public:
75
 
    GranthamAAPolarityIndex() :
76
 
      polarity_()
77
 
    {
78
 
      polarity_.resize(20);
79
 
      polarity_[ 0] =  8.1; //A
80
 
      polarity_[ 1] = 10.5; //R
81
 
      polarity_[ 2] = 11.6; //N
82
 
      polarity_[ 3] = 13.0; //D
83
 
      polarity_[ 4] =  5.5; //C
84
 
      polarity_[ 5] = 10.5; //Q
85
 
      polarity_[ 6] = 12.3; //E
86
 
      polarity_[ 7] =  9.0; //G
87
 
      polarity_[ 8] = 10.4; //H
88
 
      polarity_[ 9] =  5.2; //I
89
 
      polarity_[10] =  4.9; //L
90
 
      polarity_[11] = 11.3; //K
91
 
      polarity_[12] =  5.7; //M
92
 
      polarity_[13] =  5.2; //F
93
 
      polarity_[14] =  8.0; //P
94
 
      polarity_[15] =  9.2; //S
95
 
      polarity_[16] =  8.6; //T
96
 
      polarity_[17] =  5.4; //W
97
 
      polarity_[18] =  6.2; //Y
98
 
      polarity_[19] =  5.9; //V
99
 
    }
100
 
 
101
 
    virtual ~GranthamAAPolarityIndex() {}
102
 
    
103
 
    GranthamAAPolarityIndex* clone() const { return new GranthamAAPolarityIndex(); }
104
 
 
105
 
  public:
106
 
    double getIndex(int state) const throw (BadIntException)
107
 
    {
108
 
      if (state < 0 || state > 19) throw BadIntException(state, "GranthamAAPolarityIndex::getIndex(). Invalid state.", &AlphabetTools::PROTEIN_ALPHABET);
109
 
      return polarity_[state];
110
 
    }
111
 
    
112
 
    double getIndex(const std::string& state) const throw (BadCharException)
113
 
    {
114
 
      return polarity_[AlphabetTools::PROTEIN_ALPHABET.charToInt(state)];
115
 
    }
116
 
 
117
 
    std::vector<double>* getIndexVector() const { return new std::vector<double>(polarity_); }
118
 
 
119
 
    const Alphabet* getAlphabet() const { return &AlphabetTools::PROTEIN_ALPHABET; }
120
 
 
121
 
};
122
 
 
123
 
} //end of namespace bpp.
124
 
 
125
 
#endif //_GRANTHAMAAPOLARITYINDEX_H_
126