/usr/include/Bpp/Seq/Container/VectorSiteContainer.h is in libbpp-seq-dev 2.1.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 239 | //
// File: VectorSiteContainer.h
// Created by: Julien Dutheil
// Created on: Mon Oct 6 11:50:40 2003
//
/*
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 _VECTORSITECONTAINER_H_
#define _VECTORSITECONTAINER_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 The VectorSiteContainer class.
*
* Sites are stored in a std::vector of pointers.
* Site access is hence in \f$O(1)\f$, and sequence access in \f$O(l)\f$, where
* \f$l\f$ is the number of sites in the container.
*
* See AlignedSequenceContainer for an alternative implementation.
*
* @see Sequence, Site, AlignedSequenceContainer
*/
class VectorSiteContainer :
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_;
std::vector<std::string> names_;
std::vector<Comments*> comments_; // Sequences comments.
mutable std::vector<Sequence*> sequences_; // To store pointer toward sequences retrieves (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.
* @param checkPositions Check for the redundancy of site position tag. This may turn to be very time consuming!
* @throw Exception If sites differ in size or in alphabet.
*/
VectorSiteContainer(const std::vector<const Site*>& vs, const Alphabet* alpha, bool checkPositions = true) 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.
*/
VectorSiteContainer(size_t 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.
*/
VectorSiteContainer(const std::vector<std::string>& names, const Alphabet* alpha);
/**
* @brief Build a new empty container.
*
* @param alpha The alphabet for this container.
*/
VectorSiteContainer(const Alphabet* alpha);
VectorSiteContainer(const VectorSiteContainer& vsc);
VectorSiteContainer(const SiteContainer& sc);
VectorSiteContainer(const OrderedSequenceContainer& osc);
VectorSiteContainer(const SequenceContainer& sc);
VectorSiteContainer& operator=(const VectorSiteContainer& vsc);
VectorSiteContainer& operator=(const SiteContainer& sc);
VectorSiteContainer& operator=(const OrderedSequenceContainer& osc);
VectorSiteContainer& operator=(const SequenceContainer& sc);
virtual ~VectorSiteContainer() { clear(); }
public:
/**
* @name The Clonable interface.
*
* @{
*/
VectorSiteContainer* clone() const { return new VectorSiteContainer(*this); }
/** @} */
/**
* @name The SiteContainer interface implementation:
*
* @{
*/
const Site& getSite(size_t siteIndex) const throw (IndexOutOfBoundsException);
void setSite(size_t siteIndex, const Site& site, bool checkPosition = true) throw (Exception);
Site* removeSite(size_t siteIndex) throw (IndexOutOfBoundsException);
void deleteSite(size_t siteIndex) throw (IndexOutOfBoundsException);
void deleteSites(size_t siteIndex, size_t length) throw (IndexOutOfBoundsException);
void addSite(const Site& site, bool checkPosition = true) throw (Exception);
void addSite(const Site& site, int position, bool checkPosition = true) throw (Exception);
void addSite(const Site& site, size_t siteIndex, bool checkPosition = true) throw (Exception);
void addSite(const Site& site, size_t siteIndex, int position, bool checkPosition = true) throw (Exception);
size_t getNumberOfSites() const;
void reindexSites();
Vint getSitePositions() const;
/** @} */
// Theses methods are implemented for this class:
/**
* @name The SequenceContainer interface.
*
* @{
*/
void setComments(size_t sequenceIndex, const Comments& comments) throw (IndexOutOfBoundsException);
// Method to get a sequence object from sequence container
const Sequence& getSequence(size_t 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
size_t getSequencePosition(const std::string& name) const throw (SequenceNotFoundException);
Sequence* removeSequence(size_t sequenceIndex) throw (IndexOutOfBoundsException);
Sequence* removeSequence(const std::string& name) throw (SequenceNotFoundException);
void deleteSequence(size_t sequenceIndex) throw (IndexOutOfBoundsException);
void deleteSequence(const std::string& name) throw (SequenceNotFoundException);
size_t 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();
VectorSiteContainer* createEmptyContainer() const;
int& valueAt(const std::string& sequenceName, size_t elementIndex) throw (SequenceNotFoundException, IndexOutOfBoundsException)
{
if (elementIndex >= getNumberOfSites()) throw IndexOutOfBoundsException("VectorSiteContainer::valueAt(std::string, size_t).", elementIndex, 0, getNumberOfSites() - 1);
return (*sites_[elementIndex])[getSequencePosition(sequenceName)];
}
const int& valueAt(const std::string& sequenceName, size_t elementIndex) const throw (SequenceNotFoundException, IndexOutOfBoundsException)
{
if (elementIndex >= getNumberOfSites()) throw IndexOutOfBoundsException("VectorSiteContainer::valueAt(std::string, size_t).", elementIndex, 0, getNumberOfSites() - 1);
return (*sites_[elementIndex])[getSequencePosition(sequenceName)];
}
int& operator()(const std::string& sequenceName, size_t elementIndex)
{
return (*sites_[elementIndex])[getSequencePosition(sequenceName)];
}
const int& operator()(const std::string& sequenceName, size_t elementIndex) const
{
return (*sites_[elementIndex])[getSequencePosition(sequenceName)];
}
int& valueAt(size_t sequenceIndex, size_t elementIndex) throw (IndexOutOfBoundsException)
{
if (sequenceIndex >= getNumberOfSequences()) throw IndexOutOfBoundsException("VectorSiteContainer::valueAt(size_t, size_t).", sequenceIndex, 0, getNumberOfSequences() - 1);
if (elementIndex >= getNumberOfSites()) throw IndexOutOfBoundsException("VectorSiteContainer::valueAt(size_t, size_t).", elementIndex, 0, getNumberOfSites() - 1);
return (*sites_[elementIndex])[sequenceIndex];
}
const int& valueAt(size_t sequenceIndex, size_t elementIndex) const throw (IndexOutOfBoundsException)
{
if (sequenceIndex >= getNumberOfSequences()) throw IndexOutOfBoundsException("VectorSiteContainer::valueAt(size_t, size_t).", sequenceIndex, 0, getNumberOfSequences() - 1);
if (elementIndex >= getNumberOfSites()) throw IndexOutOfBoundsException("VectorSiteContainer::valueAt(size_t, size_t).", elementIndex, 0, getNumberOfSites() - 1);
return (*sites_[elementIndex])[sequenceIndex];
}
int& operator()(size_t sequenceIndex, size_t elementIndex)
{
return (*sites_[elementIndex])[sequenceIndex];
}
const int& operator()(size_t sequenceIndex, size_t elementIndex) const
{
return (*sites_[elementIndex])[sequenceIndex];
}
/** @} */
void addSequence(const Sequence& sequence, bool checkName = true) throw (Exception);
void addSequence(const Sequence& sequence, size_t sequenceIndex, bool checkName = true) throw (Exception);
void setSequence(const std::string& name, const Sequence& sequence, bool checkName) throw (Exception);
void setSequence(size_t sequenceIndex, const Sequence& sequence, bool checkName) throw (Exception);
protected:
// Create n void sites:
void realloc(size_t n);
};
} // end of namespace bpp.
#endif // _VECTORSITECONTAINER_H_
|