/usr/include/Bpp/Seq/Container/CompressedVectorSiteContainer.h is in libbpp-seq-dev 2.0.3-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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 | //
// File: CompressedVectorSiteContainer.h
// Created by: Julien Dutheil
// Created on: Wed Dec 16 12:08 2009
//
/*
Copyright or © or Copr. CNRS, (November 17, 2004)
This software is a computer program whose purpose is to provide classes
for sequences 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 _COMPRESSEDVECTORSITECONTAINER_H_
#define _COMPRESSEDVECTORSITECONTAINER_H_
#include "../Site.h"
#include "SiteContainer.h"
#include "AbstractSequenceContainer.h"
#include "AlignedSequenceContainer.h"
#include "OrderedSequenceContainer.h"
#include <Bpp/Numeric/VectorTools.h>
// From the STL library:
#include <string>
#include <vector>
#include <iostream>
namespace bpp
{
/**
* @brief A low memory, yet restricted, version of the VectorSiteContainer class.
*
* This implementation is very similar to VectorSiteContainer, but identical sites
* are stored only once, which significantly reduce memory usage in the case of
* containers where the number of sites is large compared to the number of sequences.
* site access is as fast as in the standard VectorSiteContainer class, but site
* addition takes more time, as the new site must be first compared to the existing set.
* A major restriction of this container is that you can't add or remove sequences.
* The number of sequences is fixed after the first site has been added.
*
* @warning Since the data is compressed, the sites given as input are modified. The
* major pratical consequence is that the 'position' attribute of sites will be lost.
* Instead, the position will correspond to the position in the compressed container.
* In addition, this container may lead to unexpected behavior if used with derived
* classes of Site. Use with care then...
*
* @see Sequence, Site, VectorSiteContainer
*/
class CompressedVectorSiteContainer :
public AbstractSequenceContainer,
// This container implements the SequenceContainer interface
// and use the AbstractSequenceContainer adapter.
public virtual SiteContainer // This container is a SiteContainer.
{
protected:
std::vector<Site*> sites_; //A set of unique sites.
std::vector<unsigned int> index_; //For all sites, give the actual position in the set.
std::vector<std::string> names_;
std::vector<Comments*> comments_; // Sequences comments.
mutable std::vector<Sequence*> sequences_; // To store pointer toward sequences retrieved (cf. AlignedSequenceContainer).
public:
/**
* @brief Build a new container from a set of sites.
*
* @param vs A std::vector of sites.
* @param alpha The common alphabet for all sites.
* @throw Exception If sites differ in size or in alphabet.
*/
CompressedVectorSiteContainer(const std::vector<const Site*>& vs, const Alphabet* alpha) throw (Exception);
/**
* @brief Build a new empty container with specified size.
*
* @param size Number of sequences in the container.
* @param alpha The alphabet for this container.
*/
CompressedVectorSiteContainer(unsigned int size, const Alphabet* alpha);
/**
* @brief Build a new empty container with specified sequence names.
*
* @param names Sequence names. This will set the number of sequences in the container.
* @param alpha The alphabet for this container.
*/
CompressedVectorSiteContainer(const std::vector<std::string>& names, const Alphabet* alpha);
/**
* @brief Build a new empty container.
*
* @param alpha The alphabet for this container.
*/
CompressedVectorSiteContainer(const Alphabet* alpha);
CompressedVectorSiteContainer(const CompressedVectorSiteContainer& vsc);
CompressedVectorSiteContainer(const SiteContainer& sc);
CompressedVectorSiteContainer& operator=(const CompressedVectorSiteContainer& vsc);
CompressedVectorSiteContainer& operator=(const SiteContainer& sc);
virtual ~CompressedVectorSiteContainer() { clear(); }
public:
/**
* @name The Clonable interface.
*
* @{
*/
CompressedVectorSiteContainer* clone() const { return new CompressedVectorSiteContainer(*this); }
/** @} */
/**
* @name The SiteContainer interface implementation:
*
* @{
*/
const Site& getSite(unsigned int siteIndex) const throw (IndexOutOfBoundsException);
void setSite(unsigned int siteIndex, const Site& site, bool checkPosition = false) throw (Exception);
Site* removeSite(unsigned int siteIndex) throw (IndexOutOfBoundsException);
void deleteSite(unsigned int siteIndex) throw (IndexOutOfBoundsException);
void deleteSites(unsigned int siteIndex, unsigned int length) throw (IndexOutOfBoundsException);
void addSite(const Site& site, bool checkPosition = false) throw (Exception);
void addSite(const Site& site, int position, bool checkPosition = false) throw (Exception)
{
addSite(site, checkPosition);
}
void addSite(const Site& site, unsigned int siteIndex, bool checkPosition = false) throw (Exception);
void addSite(const Site& site, unsigned int siteIndex, int position, bool checkPosition = false) throw (Exception)
{
addSite(site, siteIndex, checkPosition);
}
unsigned int getNumberOfSites() const { return index_.size(); }
void reindexSites();
Vint getSitePositions() const;
/** @} */
// Theses methods are implemented for this class:
/**
* @name The SequenceContainer interface.
*
* @{
*/
void setComments(unsigned int sequenceIndex, const Comments& comments) throw (IndexOutOfBoundsException);
// Method to get a sequence object from sequence container
const Sequence& getSequence(unsigned int sequenceIndex) const throw (IndexOutOfBoundsException);
const Sequence& getSequence(const std::string& name) const throw (SequenceNotFoundException);
bool hasSequence(const std::string& name) const;
// Methods to get position of a sequence in sequence container from his name
// This method is used by delete and remove methods
unsigned int getSequencePosition(const std::string& name) const throw (SequenceNotFoundException);
Sequence* removeSequence(unsigned int sequenceIndex) throw (IndexOutOfBoundsException, NotImplementedException)
{
//Implementing this function would involve (partially) decompressing the data...
throw NotImplementedException("CompressedVectorSiteContainer::removeSequence.");
}
Sequence* removeSequence(const std::string& name) throw (SequenceNotFoundException, NotImplementedException)
{
//Implementing this function would involve (partially) decompressing the data...
throw NotImplementedException("CompressedVectorSiteContainer::removeSequence.");
}
void deleteSequence(unsigned int sequenceIndex) throw (IndexOutOfBoundsException, NotImplementedException)
{
//Implementing this function would involve (partially) decompressing the data...
throw NotImplementedException("CompressedVectorSiteContainer::deleteSequence.");
}
void deleteSequence(const std::string& name) throw (SequenceNotFoundException, NotImplementedException)
{
//Implementing this function would involve (partially) decompressing the data...
throw NotImplementedException("CompressedVectorSiteContainer::deleteSequence.");
}
unsigned int getNumberOfSequences() const { return names_.size(); }
std::vector<std::string> getSequencesNames() const;
void setSequencesNames(const std::vector<std::string>& names, bool checkNames = true) throw (Exception);
void clear();
CompressedVectorSiteContainer* createEmptyContainer() const;
int& valueAt(const std::string& sequenceName, unsigned int elementIndex) throw (SequenceNotFoundException, IndexOutOfBoundsException)
{
if (elementIndex >= getNumberOfSites()) throw IndexOutOfBoundsException("VectorSiteContainer::operator(std::string, unsigned int).", elementIndex, 0, getNumberOfSites() - 1);
return (*sites_[index_[elementIndex]])[getSequencePosition(sequenceName)];
}
const int& valueAt(const std::string& sequenceName, unsigned int elementIndex) const throw (SequenceNotFoundException, IndexOutOfBoundsException)
{
if (elementIndex >= getNumberOfSites()) throw IndexOutOfBoundsException("VectorSiteContainer::operator(std::string, unsigned int).", elementIndex, 0, getNumberOfSites() - 1);
return (*sites_[index_[elementIndex]])[getSequencePosition(sequenceName)];
}
int& operator()(const std::string& sequenceName, unsigned int elementIndex)
{
return (*sites_[index_[elementIndex]])[getSequencePosition(sequenceName)];
}
const int& operator()(const std::string& sequenceName, unsigned int elementIndex) const
{
return (*sites_[index_[elementIndex]])[getSequencePosition(sequenceName)];
}
int& valueAt(unsigned int sequenceIndex, unsigned int elementIndex) throw (IndexOutOfBoundsException)
{
if (sequenceIndex >= getNumberOfSequences()) throw IndexOutOfBoundsException("VectorSiteContainer::operator(unsigned int, unsigned int).", sequenceIndex, 0, getNumberOfSequences() - 1);
if (elementIndex >= getNumberOfSites()) throw IndexOutOfBoundsException("VectorSiteContainer::operator(unsigned int, unsigned int).", elementIndex, 0, getNumberOfSites() - 1);
return (*sites_[index_[elementIndex]])[sequenceIndex];
}
const int& valueAt(unsigned int sequenceIndex, unsigned int elementIndex) const throw (IndexOutOfBoundsException)
{
if (sequenceIndex >= getNumberOfSequences()) throw IndexOutOfBoundsException("VectorSiteContainer::operator(unsigned int, unsigned int).", sequenceIndex, 0, getNumberOfSequences() - 1);
if (elementIndex >= getNumberOfSites()) throw IndexOutOfBoundsException("VectorSiteContainer::operator(unsigned int, unsigned int).", elementIndex, 0, getNumberOfSites() - 1);
return (*sites_[index_[elementIndex]])[sequenceIndex];
}
int& operator()(unsigned int sequenceIndex, unsigned int elementIndex)
{
return (*sites_[index_[elementIndex]])[sequenceIndex];
}
const int& operator()(unsigned int sequenceIndex, unsigned int elementIndex) const
{
return (*sites_[index_[elementIndex]])[sequenceIndex];
}
/** @} */
void addSequence(const Sequence& sequence, bool checkName = true) throw (Exception, NotImplementedException)
{
//Implementing this function would involve (partially) decompressing the data...
throw NotImplementedException("CompressedVectorSiteContainer::addSequence.");
}
void addSequence(const Sequence& sequence, unsigned int sequenceIndex, bool checkName = true) throw (Exception, NotImplementedException)
{
//Implementing this function would involve (partially) decompressing the data...
throw NotImplementedException("CompressedVectorSiteContainer::addSequence.");
}
void setSequence(const std::string& name, const Sequence& sequence, bool checkName) throw (Exception, NotImplementedException)
{
//Implementing this function would involve (partially) decompressing the data...
throw NotImplementedException("CompressedVectorSiteContainer::setSequence.");
}
void setSequence(unsigned int sequenceIndex, const Sequence& sequence, bool checkName) throw (Exception, NotImplementedException)
{
//Implementing this function would involve (partially) decompressing the data...
throw NotImplementedException("CompressedVectorSiteContainer::setSequence.");
}
protected:
/**
* @return The position of the site in the compressed set. If the site is not found,
* this will return the number of sites in the compressed set.
*/
unsigned int getSiteIndex_(const Site& site);
};
} // end of namespace bpp.
#endif // _COMPRESSEDVECTORSITECONTAINER_H_
|