~ubuntu-branches/ubuntu/raring/libbpp-phyl/raring

« back to all changes in this revision

Viewing changes to src/Bpp/Phyl/Parsimony/TreeParsimonyData.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:
 
1
//
 
2
// File: TreeParsimonyData.h
 
3
// Created by: Julien Dutheil
 
4
// Created on: Tue Jan 09 17:15 2007
 
5
// From file AbstractTreeParsimonyScore.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 _TREEPARSIMONYDATA_H_
 
42
#define _TREEPARSIMONYDATA_H_
 
43
 
 
44
#include "../Node.h"
 
45
#include "../TreeTemplate.h"
 
46
 
 
47
#include <Bpp/Clonable.h>
 
48
 
 
49
namespace bpp
 
50
{
 
51
 
 
52
/**
 
53
 * @brief TreeParsimonyScore node data structure.
 
54
 *
 
55
 * Stores inner computation for a given node.
 
56
 *
 
57
 * @see TreeParsimonyData
 
58
 */
 
59
class TreeParsimonyNodeData:
 
60
  public virtual Clonable
 
61
{
 
62
        public:
 
63
                TreeParsimonyNodeData() {}
 
64
                virtual ~TreeParsimonyNodeData() {}
 
65
 
 
66
#ifndef NO_VIRTUAL_COV
 
67
    TreeParsimonyNodeData* clone() const = 0;
 
68
#endif
 
69
 
 
70
        public:
 
71
                /**
 
72
                 * @brief Get the node associated to this data structure.
 
73
                 *
 
74
                 * @return The node associated to this structure.
 
75
                 */
 
76
                virtual const Node* getNode() const = 0;
 
77
 
 
78
    /**
 
79
     * @brief Set the node associated to this data
 
80
     *
 
81
     * @param node A pointer toward the node to be associated to this data.
 
82
     */
 
83
    virtual void setNode(const Node* node) = 0;
 
84
};
 
85
 
 
86
/**
 
87
 * @brief TreeParsimonyScore data structure.
 
88
 *
 
89
 * Stores all the inner computations:
 
90
 * - subtree scores and ancestral states for each node,
 
91
 * - correspondance between sites in the dataset and array indices.
 
92
 *
 
93
 * @see TreeParsimonyNodeData
 
94
 */
 
95
class TreeParsimonyData:
 
96
  public virtual Clonable
 
97
{
 
98
  public:
 
99
    TreeParsimonyData() {}
 
100
    virtual ~TreeParsimonyData() {}
 
101
    
 
102
#ifndef NO_VIRTUAL_COV
 
103
    TreeParsimonyData* clone() const = 0;
 
104
#endif
 
105
    
 
106
        public:
 
107
                virtual const TreeTemplate<Node>* getTree() const = 0;  
 
108
                virtual unsigned int getArrayPosition(int parentId, int sonId, unsigned int currentPosition) const = 0;
 
109
                virtual unsigned int getRootArrayPosition(const unsigned int site) const = 0;
 
110
                virtual TreeParsimonyNodeData& getNodeData(int nodeId) = 0;
 
111
                virtual const TreeParsimonyNodeData& getNodeData(int nodeId) const = 0;
 
112
};
 
113
 
 
114
} //end of namespace bpp.
 
115
 
 
116
#endif //_TREEPARSIMONYDATA_H_
 
117