/usr/include/Bpp/Seq/SymbolList.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 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 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 | //
// File: SymbolList.h
// Created by: Julien Dutheil
// Created on: Fri Apr 9 2005
//
/*
Copyright or © or Copr. Bio++ Development Team, (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 _SYMBOLLIST_H_
#define _SYMBOLLIST_H_
#include "Alphabet/Alphabet.h"
#include <Bpp/Clonable.h>
// From the STL:
#include <string>
#include <vector>
#include <algorithm>
#include <iostream>
namespace bpp
{
/**
* @brief The SymbolList interface.
*
* @see Alphabet
*/
class SymbolList:
public virtual Clonable
{
public:
/**
* @name The Clonable interface
*
* @{
*/
#ifndef NO_VIRTUAL_COV
SymbolList* clone() const = 0;
#endif
/** @} */
// Class destructor
virtual ~SymbolList() {}
public:
/**
* @brief Get the alphabet associated to the list.
*
* @return A const pointer to the alphabet.
* @see Alphabet class.
*/
virtual const Alphabet* getAlphabet() const = 0;
/**
* @brief Get the number of elements in the list.
*
* @return The number of sites in the list.
*/
virtual size_t size() const = 0;
/**
* @name Acting on the content of the list.
*
* @{
*/
/**
* @brief Get the whole content of the list as a vector of int.
*
* @return A reference to the content of the list.
*/
virtual const std::vector<int>& getContent() const = 0;
/**
* @brief Set the whole content of the list.
*
* @param list The new content of the list.
* @see The list constructor for information about the way lists are internaly stored.
*/
virtual void setContent(const std::vector<int>& list) throw (BadIntException) = 0;
/**
* @brief Set the whole content of the list.
*
* @param list The new content of the list.
* @see The list constructor for information about the way lists are internaly stored.
*/
virtual void setContent(const std::vector<std::string>& list) throw (BadCharException) = 0;
/** @} */
/**
* @brief Convert the list as a string.
*
* This method is useful for dumping a list to a file or to the screen for display.
*
* @return The whole list as a string.
*/
virtual std::string toString() const = 0;
/**
* @name Edition methods.
*
* @{
*/
/**
* @brief Add a character to the end of the list.
*
* @param c The character to add, given as a string.
*/
virtual void addElement(const std::string& c) throw (BadCharException) = 0;
/**
* @brief Add a character at a certain position in the list.
*
* @param pos The postion where to insert the element.
* @param c The character to add, given as a string.
*/
virtual void addElement(size_t pos, const std::string& c) throw (BadCharException, IndexOutOfBoundsException) = 0;
/**
* @brief Set the element at position 'pos' to character 'c'.
*
* @param pos The position of the character to set.
* @param c The value of the element, given as a string.
*/
virtual void setElement(size_t pos, const std::string& c) throw (BadCharException, IndexOutOfBoundsException) = 0;
/**
* @brief Delete the element at position 'pos'.
*
* @param pos The position of the element to delete.
*/
virtual void deleteElement(size_t pos) throw (IndexOutOfBoundsException) = 0;
/**
* @brief Delete the elements at position 'pos'.
*
* @param pos The position of the first element to delete.
* @param len The length of the region to delete.
*/
virtual void deleteElements(size_t pos, size_t len) throw (IndexOutOfBoundsException) = 0;
/**
* @brief Get the element at position 'pos' as a character.
*
* @param pos The position of the character to retrieve.
*/
virtual std::string getChar(size_t pos) const throw (IndexOutOfBoundsException) = 0;
/**
* @brief Add a character to the end of the list.
*
* @param v The character to add, given as an int.
*/
virtual void addElement(int v) throw (BadIntException) = 0;
/**
* @brief Add a character at a certain position in the list.
*
* @param pos The postion where to insert the element.
* @param v The character to add, given as an int.
*/
virtual void addElement(size_t pos, int v) throw (BadIntException, IndexOutOfBoundsException) = 0;
/**
* @brief Set the element at position 'pos' to character 'v'.
*
* @param pos The position of the character to set.
* @param v The value of the element, given as an int.
*/
virtual void setElement(size_t pos, int v) throw (BadIntException, IndexOutOfBoundsException) = 0;
/**
* @brief Get the element at position 'pos' as an int.
*
* @param pos The position of the character to retrieve.
*/
virtual int getValue(size_t pos) const throw (IndexOutOfBoundsException) = 0;
/** @} */
/**
* @name Provide direct access to the list content.
*
* @warning These operators allow you to modifiy the list content.
* No alphabet checking is performed for your modifications, so use with care, or
* consider using the setContent() method.
*
* @{
*/
/**
* @brief Operator [] overloaded for quick access to a character in list.
*
* @param i The position to retrieve.
* @return The integer value of character at position i.
*/
virtual const int& operator[](size_t i) const = 0;
/**
* @brief Operator [] overloaded for quick access to a character in list.
*
* @param i The position to retrieve.
* @return The integer value of character at position i.
*/
virtual int& operator[](size_t i) = 0;
/**
* @brief Randomly shuffle the content of the list, with linear complexity.
*/
virtual void shuffle() = 0;
/** @} */
};
/**
* @brief A basic SymbolList object.
*
* This is a general purpose container, containing an ordered list of states(= letters).
* The states that allowed to be present in the list are defined by an alphabet object,
* which is passed to the list constructor by a pointer.
*
* For programming convenience, the states are stored as integers, but the translation toward
* and from a char description is easily performed with the Alphabet classes.
*
* @see Alphabet
*/
class BasicSymbolList:
public virtual SymbolList
{
private:
/**
* @brief The Alphabet attribute must be initialized in constructor and then can never be changed.
*
* To apply another alphabet to a list you'll have to create a new list.
*/
const Alphabet* alphabet_;
protected:
/**
* @brief The list content.
*/
std::vector<int> content_;
public:
/**
* @brief Build a new void BasicSymbolList object with the specified alphabet.
*
* @param alpha The alphabet to use.
*/
BasicSymbolList(const Alphabet* alpha) : alphabet_(alpha), content_() {}
/**
* @brief Build a new BasicSymbolList object with the specified alphabet.
* The content of the site is initialized from a vector of characters.
*
* @param list The content of the site.
* @param alpha The alphabet to use.
* @throw BadCharException If the content does not match the specified alphabet.
*/
BasicSymbolList(const std::vector<std::string>& list, const Alphabet* alpha) throw (BadCharException);
/**
* @brief Build a new BasicSymbolList object with the specified alphabet.
* The content of the site is initialized from a vector of integers.
*
* @param list The content of the site.
* @param alpha The alphabet to use.
* @throw BadIntException If the content does not match the specified alphabet.
*/
BasicSymbolList(const std::vector<int>& list, const Alphabet* alpha) throw (BadIntException);
/**
* @brief The generic copy constructor.
*/
BasicSymbolList(const SymbolList& list);
/**
* @brief The copy constructor.
*/
BasicSymbolList(const BasicSymbolList& list);
/**
* @brief The generic assignment operator.
*/
BasicSymbolList& operator=(const SymbolList& list);
/**
* @brief The assignment operator.
*/
BasicSymbolList& operator=(const BasicSymbolList& list);
/**
* @name The Clonable interface
*
* @{
*/
#ifdef NO_VIRTUAL_COV
Clonable*
#else
BasicSymbolList*
#endif
clone() const { return new BasicSymbolList(* this); }
/** @} */
// Class destructor
virtual ~BasicSymbolList() {}
public:
virtual const Alphabet* getAlphabet() const { return alphabet_; }
virtual size_t size() const { return static_cast<size_t>(content_.size()); }
virtual const std::vector<int>& getContent() const { return content_; }
virtual void setContent(const std::vector<int>& list) throw (BadIntException);
virtual void setContent(const std::vector<std::string>& list) throw (BadCharException);
virtual std::string toString() const;
virtual void addElement(const std::string& c) throw (BadCharException);
virtual void addElement(size_t pos, const std::string& c) throw (BadCharException, IndexOutOfBoundsException);
virtual void setElement(size_t pos, const std::string& c) throw (BadCharException, IndexOutOfBoundsException);
virtual void deleteElement(size_t pos) throw (IndexOutOfBoundsException);
virtual void deleteElements(size_t pos, size_t len) throw (IndexOutOfBoundsException);
virtual std::string getChar(size_t pos) const throw (IndexOutOfBoundsException);
virtual void addElement(int v) throw (BadIntException);
virtual void addElement(size_t pos, int v) throw (BadIntException, IndexOutOfBoundsException);
virtual void setElement(size_t pos, int v) throw (BadIntException, IndexOutOfBoundsException);
virtual int getValue(size_t pos) const throw (IndexOutOfBoundsException);
virtual const int& operator[](size_t i) const { return content_[i]; }
virtual int& operator[](size_t i) { return content_[i]; }
virtual void shuffle()
{
random_shuffle(content_.begin(), content_.end());
}
};
class SymbolListEditionEvent
{
private:
SymbolList* list_;
public:
SymbolListEditionEvent(SymbolList* list):
list_(list) {}
SymbolListEditionEvent(const SymbolListEditionEvent& slee): list_(slee.list_) {}
SymbolListEditionEvent& operator=(const SymbolListEditionEvent& slee) {
list_ = slee.list_;
return *this;
}
virtual ~SymbolListEditionEvent() {}
public:
virtual SymbolList* getSymbolList() { return list_; }
virtual const SymbolList* getSymbolList() const { return list_; }
};
class SymbolListInsertionEvent:
public SymbolListEditionEvent
{
private:
size_t pos_;
size_t len_;
public:
SymbolListInsertionEvent(SymbolList* list, size_t pos, size_t len):
SymbolListEditionEvent(list), pos_(pos), len_(len) {}
public:
virtual size_t getPosition() const { return pos_; }
virtual size_t getLength() const { return len_; }
};
class SymbolListDeletionEvent:
public SymbolListEditionEvent
{
private:
size_t pos_;
size_t len_;
public:
SymbolListDeletionEvent(SymbolList* list, size_t pos, size_t len):
SymbolListEditionEvent(list), pos_(pos), len_(len) {}
public:
virtual size_t getPosition() const { return pos_; }
virtual size_t getLength() const { return len_; }
};
class SymbolListSubstitutionEvent:
public SymbolListEditionEvent
{
private:
size_t begin_;
size_t end_;
public:
SymbolListSubstitutionEvent(SymbolList* list, size_t begin, size_t end) :
SymbolListEditionEvent(list), begin_(begin), end_(end) {}
public:
virtual size_t getBegin() const { return begin_; }
virtual size_t getEnd() const { return end_; }
};
class SymbolListListener :
public virtual Clonable
{
public:
virtual ~SymbolListListener() {}
#ifndef NO_VIRTUAL_COV
virtual SymbolListListener* clone() const = 0;
#endif
public:
virtual bool isRemovable() const = 0;
virtual bool isShared() const = 0;
virtual void beforeSequenceChanged(const SymbolListEditionEvent& event) = 0;
virtual void afterSequenceChanged(const SymbolListEditionEvent& event) = 0;
virtual void beforeSequenceInserted(const SymbolListInsertionEvent& event) = 0;
virtual void afterSequenceInserted(const SymbolListInsertionEvent& event) = 0;
virtual void beforeSequenceDeleted(const SymbolListDeletionEvent& event) = 0;
virtual void afterSequenceDeleted(const SymbolListDeletionEvent& event) = 0;
virtual void beforeSequenceSubstituted(const SymbolListSubstitutionEvent& event) = 0;
virtual void afterSequenceSubstituted(const SymbolListSubstitutionEvent& event) = 0;
};
/**
* @brief A event-driven SymbolList object.
*
* This is a general purpose container, containing an ordered list of states(= letters).
* The states that allowed to be present in the list are defined by an alphabet object,
* which is passed to the list constructor by a pointer.
*
* For programming convenience, the states are stored as integers, but the translation toward
* and from a char description is easily performed with the Alphabet classes.
*
* @see Alphabet
*/
class EdSymbolList:
public virtual SymbolList
{
private:
/**
* @brief The Alphabet attribute must be initialized in constructor and then can never be changed.
*
* To apply another alphabet to a list you'll have to create a new list.
*/
const Alphabet* alphabet_;
bool propagateEvents_;
protected:
/**
* @brief The list content.
*/
std::vector<int> content_;
/**
* @brief Contains the listeners.
*/
std::vector<SymbolListListener*> listeners_;
public:
/**
* @brief Build a new void BasicSymbolList object with the specified alphabet.
*
* @param alpha The alphabet to use.
*/
EdSymbolList(const Alphabet* alpha) : alphabet_(alpha), propagateEvents_(true), content_(), listeners_() {}
/**
* @brief Build a new BasicSymbolList object with the specified alphabet.
* The content of the site is initialized from a vector of characters.
*
* @param list The content of the site.
* @param alpha The alphabet to use.
* @throw BadCharException If the content does not match the specified alphabet.
*/
EdSymbolList(const std::vector<std::string>& list, const Alphabet* alpha) throw (BadCharException);
/**
* @brief Build a new BasicSymbolList object with the specified alphabet.
* The content of the site is initialized from a vector of integers.
*
* @param list The content of the site.
* @param alpha The alphabet to use.
* @throw BadIntException If the content does not match the specified alphabet.
*/
EdSymbolList(const std::vector<int>& list, const Alphabet* alpha) throw (BadIntException);
/**
* @brief The generic copy constructor.
*/
EdSymbolList(const SymbolList& list);
/**
* @brief The copy constructor.
*/
EdSymbolList(const EdSymbolList& list);
/**
* @brief The generic assignment operator.
*/
EdSymbolList& operator=(const SymbolList& list);
/**
* @brief The assignment operator.
*/
EdSymbolList& operator=(const EdSymbolList& list);
/**
* @name The Clonable interface
*
* @{
*/
#ifdef NO_VIRTUAL_COV
Clonable*
#else
EdSymbolList*
#endif
clone() const { return new EdSymbolList(* this); }
/** @} */
// Class destructor
virtual ~EdSymbolList()
{
for (size_t i = 0; i < listeners_.size(); ++i) {
if (listeners_[i] && !listeners_[i]->isShared()) {
delete listeners_[i];
}
}
}
public:
virtual const Alphabet* getAlphabet() const { return alphabet_; }
virtual size_t size() const { return static_cast<size_t>(content_.size()); }
virtual const std::vector<int>& getContent() const { return content_; }
virtual void setContent(const std::vector<int>& list) throw (BadIntException);
virtual void setContent(const std::vector<std::string>& list) throw (BadCharException);
virtual std::string toString() const;
virtual void addElement(const std::string& c) throw (BadCharException);
virtual void addElement(size_t pos, const std::string& c) throw (BadCharException, IndexOutOfBoundsException);
virtual void setElement(size_t pos, const std::string& c) throw (BadCharException, IndexOutOfBoundsException);
virtual void deleteElement(size_t pos) throw (IndexOutOfBoundsException);
virtual void deleteElements(size_t pos, size_t len) throw (IndexOutOfBoundsException);
virtual std::string getChar(size_t pos) const throw (IndexOutOfBoundsException);
virtual void addElement(int v) throw (BadIntException);
virtual void addElement(size_t pos, int v) throw (BadIntException, IndexOutOfBoundsException);
virtual void setElement(size_t pos, int v) throw (BadIntException, IndexOutOfBoundsException);
virtual int getValue(size_t pos) const throw (IndexOutOfBoundsException);
virtual const int& operator[](size_t i) const { return content_[i]; }
virtual int& operator[](size_t i) { return content_[i]; }
virtual void shuffle()
{
random_shuffle(content_.begin(), content_.end());
}
/**
* @name Events handling
*
* @{
*/
virtual size_t getNumberOfListeners() const { return listeners_.size(); }
virtual const SymbolListListener& getListener(size_t i) const {
if (listeners_[i] == 0) std::cout << "aie!!!" << std::endl;
return *listeners_[i];
}
virtual SymbolListListener& getListener(size_t i) {
if (listeners_[i] == 0) std::cout << "aie!!!" << std::endl;
return *listeners_[i];
}
virtual void addSymbolListListener(SymbolListListener* listener) {
listeners_.push_back(listener);
}
virtual void removeSymbolListListener(SymbolListListener* listener) {
if (listener->isRemovable())
listeners_.erase(remove(listeners_.begin(), listeners_.end(), listener), listeners_.end());
else
throw Exception("EdSymbolList::removeSymbolListListener. Listener is not removable.");
}
protected:
virtual void beforeSequenceChanged(const SymbolListEditionEvent& event) {};
virtual void afterSequenceChanged(const SymbolListEditionEvent& event) {};
virtual void beforeSequenceInserted(const SymbolListInsertionEvent& event) {};
virtual void afterSequenceInserted(const SymbolListInsertionEvent& event) {};
virtual void beforeSequenceDeleted(const SymbolListDeletionEvent& event) {};
virtual void afterSequenceDeleted(const SymbolListDeletionEvent& event) {};
virtual void beforeSequenceSubstituted(const SymbolListSubstitutionEvent& event) {};
virtual void afterSequenceSubstituted(const SymbolListSubstitutionEvent& event) {};
void fireBeforeSequenceChanged(const SymbolListEditionEvent& event) {
beforeSequenceChanged(event);
if (propagateEvents_)
for (size_t i = 0; i < listeners_.size(); ++i)
listeners_[i]->beforeSequenceChanged(event);
}
void fireAfterSequenceChanged(const SymbolListEditionEvent& event) {
afterSequenceChanged(event);
if (propagateEvents_)
for (size_t i = 0; i < listeners_.size(); ++i)
listeners_[i]->afterSequenceChanged(event);
}
void fireBeforeSequenceInserted(const SymbolListInsertionEvent& event) {
beforeSequenceInserted(event);
if (propagateEvents_)
for (size_t i = 0; i < listeners_.size(); ++i)
listeners_[i]->beforeSequenceInserted(event);
}
void fireAfterSequenceInserted(const SymbolListInsertionEvent& event) {
afterSequenceInserted(event);
if (propagateEvents_)
for (size_t i = 0; i < listeners_.size(); ++i)
listeners_[i]->afterSequenceInserted(event);
}
void fireBeforeSequenceDeleted(const SymbolListDeletionEvent& event) {
beforeSequenceDeleted(event);
if (propagateEvents_)
for (size_t i = 0; i < listeners_.size(); ++i)
listeners_[i]->beforeSequenceDeleted(event);
}
void fireAfterSequenceDeleted(const SymbolListDeletionEvent& event) {
afterSequenceDeleted(event);
if (propagateEvents_)
for (size_t i = 0; i < listeners_.size(); ++i)
listeners_[i]->afterSequenceDeleted(event);
}
void fireBeforeSequenceSubstituted(const SymbolListSubstitutionEvent& event) {
beforeSequenceSubstituted(event);
if (propagateEvents_)
for (size_t i = 0; i < listeners_.size(); ++i)
listeners_[i]->beforeSequenceSubstituted(event);
}
void fireAfterSequenceSubstituted(const SymbolListSubstitutionEvent& event) {
afterSequenceSubstituted(event);
if (propagateEvents_)
for (size_t i = 0; i < listeners_.size(); ++i)
listeners_[i]->afterSequenceSubstituted(event);
}
/** @} */
protected:
void propagateEvents(bool yn) { propagateEvents_ = yn; }
bool propagateEvents() const { return propagateEvents_; }
};
} //end of namespace bpp.
#endif // _SYMBOLLIST_H_
|