/usr/include/Bpp/Seq/DistanceMatrix.h is in libbpp-seq-dev 2.2.0-1+b1.
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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 | //
// File: DistanceMatrix.h
// Created on: Wed jun 08 10:39 2005
//
/*
Copyright or © or Copr. Bio++ Development Team, (November 16, 2004)
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 _DISTANCEMATRIX_H_
#define _DISTANCEMATRIX_H_
// From the STL:
#include <vector>
#include <string>
#include <Bpp/Exceptions.h>
#include <Bpp/Numeric/VectorExceptions.h> //DimensionException
#include <Bpp/Numeric/Matrix/Matrix.h>
namespace bpp
{
/**
* @brief A Matrix class to store phylogenetic distances.
*/
class DistanceMatrix:
public virtual Clonable
{
private:
RowMatrix<double> distances_;
std::vector<std::string> names_;
public:
/**
* @brief Build a new distance matrix with specified names.
*
* The dimension of the matrix will be equal to the number of names
*
* @param names The names to use.
*/
DistanceMatrix(const std::vector<std::string>& names):
distances_(names.size(), names.size()),
names_(names)
{
reset();
}
/**
* @brief Build a new distance matrix with specified size.
*
* Row names will be named 'Taxon 0', 'Taxon 1', and so on.
*
* @param n The size of the matrix.
*/
DistanceMatrix(size_t n):
distances_(n, n), names_(n)
{
resize(n);
}
virtual ~DistanceMatrix() {}
DistanceMatrix(const DistanceMatrix& dist):
distances_(dist.distances_),
names_(dist.names_) {}
DistanceMatrix& operator=(const DistanceMatrix& dist)
{
size_t n = dist.size();
resize(n);
for(size_t i = 0; i < n; ++i)
{
for(size_t j = 0; j < n; ++j)
{
distances_(i, j) = dist(i, j);
}
}
names_ = dist.names_;
return *this;
}
DistanceMatrix* clone() const { return new DistanceMatrix(*this); }
public:
/**
* @brief Reset the distance matrix: all distances are set to 0.
*/
void reset()
{
size_t n = size();
for (size_t i = 0; i < n; ++i)
{
for (size_t j = 0; j < n; ++j)
{
distances_(i, j) = 0;
}
}
}
/**
* @return The dimension of the matrix.
*/
size_t size() const { return names_.size(); }
/**
* @return The names associated to the matrix.
*/
const std::vector<std::string>& getNames() const { return names_; }
/**
* @return The ith name.
* @param i Name index.
* @throw IndexOutOfBoundsException If i is not a valid index.
*/
const std::string& getName(size_t i) const throw (IndexOutOfBoundsException)
{
if (i >= size()) throw IndexOutOfBoundsException("DistanceMatrix::getName. Invalid indice.", i, 0, size());
return names_[i];
}
/**
* @brief Set the ith name.
*
* @param i Name index.
* @param name The new name.
* @throw IndexOutOfBoundsException If i is not a valid index.
*/
void setName(size_t i, const std::string& name) throw (IndexOutOfBoundsException)
{
if (i >= size()) throw IndexOutOfBoundsException("DistanceMatrix::setName. Invalid indice.", i, 0, size());
names_[i] = name;
}
/**
* @brief Set the names associated to the matrix.
*
* @param names Matrix names.
* @throw DimensionException If 'names' have not the same size as the matrix.
*/
void setNames(const std::vector<std::string>& names) throw (DimensionException)
{
if (names.size() != names_.size()) throw DimensionException("DistanceMatrix::setNames. Invalid number of names.", names.size(), names_.size());
names_ = names;
}
/**
* @brief Get the index of a given name.
*
* @param name The name to look for.
* @return The position of the name.
* @throw Exception If no names are attached to this matrix, or if the name was not found.
*/
size_t getNameIndex(const std::string& name) const throw (Exception);
/**
* @brief Change the dimension of the matrix.
*
* @param n the new dimension of the matrix.
*/
void resize(size_t n) {
//RowMatrix<double>::resize(n, n);
distances_.resize(n, n);
names_.resize(n);
for (size_t i = 0; i < n; ++i)
names_[i] = "Taxon " + TextTools::toString(i);
reset();
}
/**
* @brief Access by name.
*
* @param iName Name 1 (row)
* @param jName Name 2 (column)
* @return A reference toward the specified distance.
* @throw Exception if the matrix has no name of if one of the name do not match existing names.
*/
virtual const double& operator()(const std::string& iName, const std::string& jName) const throw (Exception)
{
size_t i = getNameIndex(iName);
size_t j = getNameIndex(jName);
//return operator()(i,j);
return distances_(i,j);
}
/**
* @brief Access by name.
*
* @param iName Name 1 (row)
* @param jName Name 2 (column)
* @return A reference toward the specified distance.
* @throw Exception if the matrix has no name of if one of the name do not match existing names.
*/
virtual double& operator()(const std::string& iName, const std::string& jName) throw (Exception)
{
size_t i = getNameIndex(iName);
size_t j = getNameIndex(jName);
//return operator()(i,j);
return distances_(i,j);
}
virtual const double& operator()(size_t i, size_t j) const
{
//return RowMatrix<double>::operator()(i, j);
return distances_(i, j);
}
virtual double& operator()(size_t i, size_t j)
{
//return RowMatrix<double>::operator()(i, j);
return distances_(i, j);
}
virtual const Matrix<double>& asMatrix() const {
return distances_;
}
virtual Matrix<double>& asMatrix() {
return distances_;
}
};
} //end of namespace bpp.
#endif //_DISTANCEMATRIX_H_
|