/usr/include/Bpp/Phyl/Mapping/Mapping.h is in libbpp-phyl-dev 2.4.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 | //
// File: Mapping.h
// Created by: Julien Dutheil
// Created on: Wed Apr 5 09:51 2005
//
/*
Copyright or © or Copr. Bio++ Development Team, (November 16, 2004, 2005, 2006)
This software is a computer program whose purpose is to provide classes
for phylogenetic data analysis.
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/
#ifndef _MAPPING_H_
#define _MAPPING_H_
#include <Bpp/Clonable.h>
#include "../Tree.h"
#include "../TreeTemplate.h"
//From the STL:
#include <vector>
#include <memory>
namespace bpp
{
/**
* @brief General interface for storing mapping data.
*
*/
class Mapping:
public virtual Clonable
{
public:
Mapping() {}
virtual ~Mapping() {}
Mapping* clone() const = 0;
public:
/**
* @return Get the phylogenetic tree associated to this mapping.
*/
virtual const Tree& getTree() const = 0;
/**
* @return True is the map is empty, that is, if no tree is associated to the map yet.
*/
virtual bool isEmpty() const = 0;
/**
* @return The number of sites mapped.
*/
virtual size_t getNumberOfSites() const = 0;
/**
* @return The number of branches mapped.
*/
virtual size_t getNumberOfBranches() const = 0;
/**
* @param index The site index.
* @return The site position corresponding to the index.
*/
virtual int getSitePosition(size_t index) const = 0;
/**
* @return A vector with all tree branch lengths.
*/
virtual std::vector<double> getBranchLengths() const = 0;
/**
* @param nodeId An id of the node to look for in the map.
* @return The mapping index for the specified node id.
*/
virtual size_t getNodeIndex(int nodeId) const = 0;
/**
* @brief Set the position of a given site.
*
* @warning No index checking is performed, use with care!
* @param index The site index.
* @param position The position of the site.
*/
virtual void setSitePosition(size_t index, int position) = 0;
};
/**
* @brief Partial implementation of the mapping interface.
*
* This implementation copies the input tree in a TreeTemplate<Node> object.
*/
class AbstractMapping:
virtual public Mapping
{
private:
std::unique_ptr<const TreeTemplate<Node> > tree_;
std::vector<int> sitesPositions_;
std::vector<const Node *> nodes_;
size_t nbSites_;
size_t nbBranches_;
public:
// AbstractMapping() : tree_(0), sitesPositions_(), nodes_(), nbSites_(0), nbBranches_(0) {}
AbstractMapping(const Tree& tree) : tree_(new TreeTemplate<Node>(tree)), sitesPositions_(), nodes_(), nbSites_(0), nbBranches_(0)
{
nodes_ = tree_->getNodes();
nodes_.pop_back(); // remove root node.
nbBranches_ = nodes_.size();
}
AbstractMapping(const AbstractMapping& absm):
tree_(dynamic_cast<const TreeTemplate<Node>*>(absm.tree_->clone())),
sitesPositions_(absm.sitesPositions_),
nodes_(),
nbSites_(absm.nbSites_),
nbBranches_(absm.nbBranches_)
{
nodes_ = tree_->getNodes();
nodes_.pop_back(); // remove root node.
}
AbstractMapping& operator=(const AbstractMapping& absm)
{
tree_.reset(dynamic_cast<const TreeTemplate<Node>*>(absm.tree_->clone()));
sitesPositions_ = absm.sitesPositions_;
nbSites_ = absm.nbSites_;
nbBranches_ = absm.nbBranches_;
nodes_ = tree_->getNodes();
nodes_.pop_back(); // remove root node.
return *this;
}
AbstractMapping* clone() const = 0;
virtual ~AbstractMapping() {}
public:
bool isEmpty() const { return tree_.get() == 0; }
const TreeTemplate<Node>& getTree() const
{
if (isEmpty()) throw Exception("AbstractSubstitutionMapping::getSitePosition. No tree is assigned to this map yet.");
return *tree_.get();
}
void setTree(const Tree& tree)
{
tree_.reset(new TreeTemplate<Node>(tree));
nodes_ = tree_->getNodes();
nodes_.pop_back(); // remove root node.
nbBranches_ = nodes_.size();
}
int getSitePosition(size_t index) const
{
if (isEmpty()) throw Exception("AbstractMapping::getSitePosition. No tree is assigned to this map yet.");
return sitesPositions_[index];
}
void setSitePosition(size_t index, int position)
{
if (isEmpty()) throw Exception("AbstractMapping::setSitePosition. No tree is assigned to this map yet.");
sitesPositions_[index] = position;
}
size_t getNumberOfSites() const { return nbSites_; }
size_t getNumberOfBranches() const { return nbBranches_; }
virtual const Node* getNode(size_t nodeIndex) const { return nodes_[nodeIndex]; }
virtual void setNumberOfSites(size_t numberOfSites)
{
nbSites_ = numberOfSites;
sitesPositions_.resize(numberOfSites);
for (size_t i = 0; i < numberOfSites; i++)
sitesPositions_[i] = static_cast<int>(i + 1); //Default: all sizes numbered for 1 to n.
}
virtual std::vector<double> getBranchLengths() const
{
std::vector<double> brLen(nbBranches_);
for (size_t i = 0; i < nbBranches_; i++)
brLen[i] = nodes_[i]->getDistanceToFather();
return brLen;
}
virtual size_t getNodeIndex(int nodeId) const
{
for (size_t i = 0; i < nbBranches_; i++)
if(nodes_[i]->getId() == nodeId) return i;
throw NodeNotFoundException("AbstractMapping::getNodeIndex(nodeId).", TextTools::toString(nodeId));
}
};
} //end of namespace bpp.
#endif //_MAPPING_H_
|