← Back to branch summary

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

« back to all changes in this revision

Viewing changes to src/Bpp/Phyl/Likelihood/TreeLikelihoodData.h

  • Committer: Bazaar Package Importer
  • Author(s): Julien Dutheil
  • Date: 2011-06-09 11:00:00 UTC
  • Revision ID: james.westby@ubuntu.com-20110609110000-yvx78svv6w7xxgph
Tags: upstream-2.0.2
Import upstream version 2.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/Bpp/Phyl/Likelihood/TreeLikelihoodData.h
 
1
//
 
2
// File: TreeLikelihoodData.h
 
3
// Created by: Julien Dutheil
 
4
// Created on: Sat Dec 30 12:48 2006
 
5
// From file AbstractTreeLikelihood.h
 
6
//
 
7
 
 
8
/*
 
9
Copyright or © or Copr. CNRS, (November 16, 2004)
 
10
 
 
11
This software is a computer program whose purpose is to provide classes
 
12
for phylogenetic data analysis.
 
13
 
 
14
This software is governed by the CeCILL  license under French law and
 
15
abiding by the rules of distribution of free software.  You can  use, 
 
16
modify and/ or redistribute the software under the terms of the CeCILL
 
17
license as circulated by CEA, CNRS and INRIA at the following URL
 
18
"http://www.cecill.info". 
 
19
 
 
20
As a counterpart to the access to the source code and  rights to copy,
 
21
modify and redistribute granted by the license, users are provided only
 
22
with a limited warranty  and the software's author,  the holder of the
 
23
economic rights,  and the successive licensors  have only  limited
 
24
liability. 
 
25
 
 
26
In this respect, the user's attention is drawn to the risks associated
 
27
with loading,  using,  modifying and/or developing or reproducing the
 
28
software by the user in light of its specific status of free software,
 
29
that may mean  that it is complicated to manipulate,  and  that  also
 
30
therefore means  that it is reserved for developers  and  experienced
 
31
professionals having in-depth computer knowledge. Users are therefore
 
32
encouraged to load and test the software's suitability as regards their
 
33
requirements in conditions enabling the security of their systems and/or 
 
34
data to be ensured and,  more generally, to use and operate it in the 
 
35
same conditions as regards security. 
 
36
 
 
37
The fact that you are presently reading this means that you have had
 
38
knowledge of the CeCILL license and that you accept its terms.
 
39
*/
 
40
 
 
41
#ifndef _TREELIKELIHOODDATA_H_
 
42
#define _TREELIKELIHOODDATA_H_
 
43
 
 
44
#include "../Node.h"
 
45
#include "../TreeTemplate.h"
 
46
 
 
47
//From SeqLib:
 
48
#include <Bpp/Seq/Alphabet/Alphabet.h>
 
49
#include <Bpp/Seq/Container/SiteContainer.h>
 
50
 
 
51
namespace bpp
 
52
{
 
53
 
 
54
/**
 
55
 * @brief TreeLikelihood partial data structure.
 
56
 *
 
57
 * Stores inner computation for a given node.
 
58
 *
 
59
 * @see TreeLikelihoodData
 
60
 */
 
61
class TreeLikelihoodNodeData:
 
62
  public virtual Clonable
 
63
{
 
64
  public:
 
65
    TreeLikelihoodNodeData() {}
 
66
    virtual ~TreeLikelihoodNodeData() {}
 
67
 
 
68
#ifndef NO_VIRTUAL_COV
 
69
    TreeLikelihoodNodeData*
 
70
#else
 
71
    Clonable*
 
72
#endif
 
73
    clone() const = 0;
 
74
 
 
75
  public:
 
76
    /**
 
77
     * @brief Get the node associated to this data structure.
 
78
     *
 
79
     * @return The node associated to this structure.
 
80
     */
 
81
    virtual const Node* getNode() const = 0;
 
82
 
 
83
    /**
 
84
     * @brief Set the node associated to this data
 
85
     *
 
86
     * A pointer toward this node will be created and associated to this data.
 
87
     *
 
88
     * @param node The node to be associated to this data.
 
89
     */
 
90
    virtual void setNode(const Node* node) = 0;
 
91
};
 
92
 
 
93
/**
 
94
 * @brief TreeLikelihood data structure.
 
95
 *
 
96
 * Stores all the inner computations:
 
97
 * - conditionnal likelihoods for each node,
 
98
 * - correspondance between sites in the dataset and array indices.
 
99
 * 
 
100
 * @see TreeLikelihoodNodeData
 
101
 */
 
102
class TreeLikelihoodData:
 
103
  public virtual Clonable
 
104
{
 
105
  public:
 
106
    TreeLikelihoodData() {}
 
107
    virtual ~TreeLikelihoodData() {}
 
108
    
 
109
#ifndef NO_VIRTUAL_COV
 
110
    TreeLikelihoodData* clone() const = 0;
 
111
#endif
 
112
 
 
113
  public:
 
114
    virtual const Alphabet* getAlphabet() const = 0;
 
115
    virtual const TreeTemplate<Node>* getTree() const = 0;
 
116
    virtual unsigned int getArrayPosition(int parentId, int sonId, unsigned int currentPosition) const = 0;
 
117
    virtual unsigned int getRootArrayPosition(unsigned int site) const = 0;
 
118
    virtual       TreeLikelihoodNodeData& getNodeData(int nodeId) = 0;
 
119
    virtual const TreeLikelihoodNodeData& getNodeData(int nodeId) const = 0;
 
120
 
 
121
    /**
 
122
     * @return The number of non redundant patterns.
 
123
     */
 
124
    virtual unsigned int getNumberOfDistinctSites() const = 0;
 
125
    
 
126
    /**
 
127
     * @return The total number of sites.
 
128
     */
 
129
    virtual unsigned int getNumberOfSites() const = 0;
 
130
    
 
131
    /**
 
132
     * @return Get the number of states used in the model.
 
133
     */
 
134
    virtual unsigned int getNumberOfStates() const = 0;
 
135
 
 
136
    /**
 
137
     * @return The frequency of a given pattern.
 
138
     */
 
139
    virtual unsigned int getWeight(unsigned int pos) const = 0;
 
140
    
 
141
    /**
 
142
     * @return Frequencies for each pattern.
 
143
     */
 
144
    virtual const std::vector<unsigned int>& getWeights() const = 0;
 
145
 
 
146
};
 
147
 
 
148
} //end of namespace bpp.
 
149
 
 
150
#endif //_TREELIKELIHOODDATA_H_
 
151