/usr/include/Bpp/Phyl/Model/FrequenciesSet.h is in libbpp-phyl-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 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 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 | //
// File: FrequenciesSet.h
// Created by: Bastien Boussau
// Julien Dutheil
// Created on: Tue Aug 21 2007
//
/*
Copyright or (c) 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 _FREQUENCIESSET_H_
#define _FREQUENCIESSET_H_
#include <Bpp/Numeric/Parametrizable.h>
#include <Bpp/Numeric/VectorTools.h>
#include <Bpp/Numeric/AbstractParametrizable.h>
#include <Bpp/Seq/Alphabet/Alphabet.h>
#include <Bpp/Seq/Alphabet/NucleicAlphabet.h>
#include <Bpp/Seq/Alphabet/ProteicAlphabet.h>
#include <Bpp/Seq/Alphabet/WordAlphabet.h>
#include <Bpp/Seq/Alphabet/CodonAlphabet.h>
#include <Bpp/Seq/GeneticCode/GeneticCode.h>
namespace bpp
{
/**
* @brief Parametrize a set of state frequencies.
*/
class FrequenciesSet :
public virtual Parametrizable
{
public:
#ifndef NO_VIRTUAL_COV
FrequenciesSet* clone() const = 0;
#endif
public:
/**
* @return The alphabet associated to this set.
*/
virtual const Alphabet* getAlphabet() const = 0;
/**
* @return The frequencies values of the set.
*/
virtual const std::vector<double>& getFrequencies() const = 0;
/**
* @brief Set the parameters in order to match a given set of frequencies.
*
* @param frequencies The set of frequencies to match.
* @throw DimensionException If the number of frequencies does not match the size of the alphabet.
* @throw Exception If the frequencies do not sum to 1.
*/
virtual void setFrequencies(const std::vector<double>& frequencies) = 0;
/**
* @brief Set the Frequencies from the one of the map which keys
* match with a letter of the Alphabet.
* The frequencies are normalized so that the matching values sum 1.
*
* @param frequencies The set of frequencies to match.
*/
virtual void setFrequenciesFromMap(const std::map<int, double>& frequencies) = 0;
virtual std::string getName() const = 0;
/**
* @return The number of frequencies in the set. In most cases this will correspond to the size of the alphabet,
* but it needs not be.
*/
virtual unsigned int getNumberOfFrequencies() const = 0;
public:
/**
* @brief A helper function that provide frequencies set for codon models
* according to PAML option.
*
* @param option A code describing the option, one of F61, F1X4 or F3X4.
* @param CA the Codon Alphabet to use.
*/
static FrequenciesSet* getFrequenciesSetForCodons(short option, const CodonAlphabet& CA);
static const short F0;
static const short F1X4;
static const short F3X4;
static const short F61;
static ExcludingInterval FREQUENCE_CONSTRAINT;
};
/**
* @brief Parametrize a set of state frequencies for nucleotides.
*/
class NucleotideFrequenciesSet :
public virtual FrequenciesSet
{
public:
#ifndef NO_VIRTUAL_COV
NucleotideFrequenciesSet* clone() const = 0;
const NucleicAlphabet* getAlphabet() const = 0;
#endif
};
/**
* @brief Parametrize a set of state frequencies for proteins.
*/
class ProteinFrequenciesSet :
public virtual FrequenciesSet
{
public:
#ifndef NO_VIRTUAL_COV
ProteinFrequenciesSet* clone() const = 0;
const ProteicAlphabet* getAlphabet() const = 0;
#endif
};
/**
* @brief Parametrize a set of state frequencies for codons.
*/
class CodonFrequenciesSet :
public virtual FrequenciesSet
{
public:
#ifndef NO_VIRTUAL_COV
CodonFrequenciesSet* clone() const = 0;
const CodonAlphabet* getAlphabet() const = 0;
#endif
};
/**
* @brief Basic implementation of the FrequenciesSet interface.
*/
class AbstractFrequenciesSet :
public virtual FrequenciesSet,
public AbstractParametrizable
{
private:
const Alphabet* alphabet_;
std::vector<double> freq_;
std::string name_;
public:
AbstractFrequenciesSet(unsigned int n, const Alphabet* alphabet, const std::string& prefix, const std::string& name) :
AbstractParametrizable(prefix),
alphabet_(alphabet),
freq_(n),
name_(name)
{}
#ifndef NO_VIRTUAL_COV
AbstractFrequenciesSet*
#else
Clonable*
#endif
clone() const = 0;
AbstractFrequenciesSet(const AbstractFrequenciesSet& af) :
AbstractParametrizable(af),
alphabet_(af.alphabet_),
freq_(af.freq_),
name_(af.name_)
{}
AbstractFrequenciesSet& operator=(const AbstractFrequenciesSet& af)
{
AbstractParametrizable::operator=(af);
alphabet_ = af.alphabet_;
freq_ = af.freq_;
name_ = af.name_;
return *this;
}
public:
const Alphabet* getAlphabet() const { return alphabet_; }
const std::vector<double>& getFrequencies() const { return freq_; }
void setFrequenciesFromMap(const std::map<int, double>& frequencies);
unsigned int getNumberOfFrequencies() const { return freq_.size(); }
std::string getName() const { return(name_); }
protected:
std::vector<double>& getFrequencies_() { return freq_; }
double& getFreq_(unsigned int i) { return freq_[i]; }
const double& getFreq_(unsigned int i) const { return freq_[i]; }
void setFrequencies_(const std::vector<double>& frequencies) { freq_ = frequencies; }
};
/**
* @brief A generic FrequenciesSet allowing for the estimation of all frequencies.
*
* The FrequenciesSet has hence n-1 parameters, where n is the size of the input alphabet.
*/
class FullFrequenciesSet :
public AbstractFrequenciesSet
{
public:
/**
* @brief Construction with uniform frequencies on the letters of
* the alphabet.
*/
FullFrequenciesSet(const Alphabet* alphabet, bool allowNullFreqs = false, const std::string& name = "Full");
FullFrequenciesSet(const Alphabet* alphabet, const std::vector<double>& initFreqs, bool allowNullFreqs = false, const std::string& name = "Full");
FullFrequenciesSet* clone() const { return new FullFrequenciesSet(*this); }
public:
void setFrequencies(const std::vector<double>& frequencies);
protected:
void fireParameterChanged(const ParameterList& parameters);
};
/**
* @brief A generic FrequenciesSet for Codon alphabets.
*
* It is very similar to FullFrequencySet, but only the non-stop codon
* frequencies are parameterized.
*/
class FullCodonFrequenciesSet :
public virtual CodonFrequenciesSet,
public AbstractFrequenciesSet
{
public:
/**
* @brief Construction with uniform frequencies on the letters of
* the alphabet. The stop codon frequencies are null.
*/
FullCodonFrequenciesSet(const CodonAlphabet* alphabet, bool allowNullFreqs = false, const std::string& name = "FullCodon");
FullCodonFrequenciesSet(const CodonAlphabet* alphabet, const std::vector<double>& initFreqs, bool allowNullFreqs = false, const std::string& name = "FullCodon");
#ifndef NO_VIRTUAL_COV
FullCodonFrequenciesSet*
#else
Clonable*
#endif
clone() const { return new FullCodonFrequenciesSet(*this); }
public:
/**
* @brief the given frequencies are normalized such thaat the sum of
* the frequencies on the non-stop codons equals 1.
*
*/
void setFrequencies(const std::vector<double>& frequencies);
#ifndef NO_VIRTUAL_COV
const CodonAlphabet* getAlphabet() const
{
return dynamic_cast<const CodonAlphabet*>(AbstractFrequenciesSet::getAlphabet());
}
#endif
protected:
void fireParameterChanged(const ParameterList& parameters);
};
/**
* @brief Nucleotide FrequenciesSet using only one parameter, the GC content.
*/
class GCFrequenciesSet :
public virtual NucleotideFrequenciesSet,
public AbstractFrequenciesSet
{
public:
GCFrequenciesSet(const NucleicAlphabet* alphabet) :
AbstractFrequenciesSet(4, alphabet, "GC.", "GC")
{
Parameter p("GC.theta", 0.5, &Parameter::PROP_CONSTRAINT_IN);
addParameter_(p);
getFreq_(0) = getFreq_(1) = getFreq_(2) = getFreq_(3) = 0.25;
}
GCFrequenciesSet(const NucleicAlphabet* alphabet, double theta) :
AbstractFrequenciesSet(4, alphabet, "GC.", "GC")
{
Parameter p("GC.theta", theta, &Parameter::PROP_CONSTRAINT_IN);
addParameter_(p);
getFreq_(0) = getFreq_(3) = (1. - theta) / 2.;
getFreq_(1) = getFreq_(2) = theta / 2.;
}
#ifndef NO_VIRTUAL_COV
GCFrequenciesSet*
#else
Clonable*
#endif
clone() const { return new GCFrequenciesSet(*this); }
public:
#ifndef NO_VIRTUAL_COV
const NucleicAlphabet* getAlphabet() const
{
return dynamic_cast<const NucleicAlphabet*>(AbstractFrequenciesSet::getAlphabet());
}
#endif
void setFrequencies(const std::vector<double>& frequencies);
protected:
void fireParameterChanged(const ParameterList& parameters);
};
/**
* @brief Nucleotide FrequenciesSet using three independent parameters
* (theta, theta1, theta2) to modelize the four frequencies:
*
* \f[
* \begin{cases}
* \theta = \pi_C + \pi_G\\
* \theta_1 = \frac{\pi_A}{1 - \theta} = \frac{\pi_A}{\pi_A + \pi_T}\\
* \theta_2 = \frac{\pi_G}{\theta} = \frac{\pi_G}{\pi_C + \pi_G}\\
* \end{cases}
* \Longleftrightarrow
* \begin{cases}
* \pi_A = \theta_1 (1 - \theta)\\
* \pi_C = (1 - \theta_2) \theta\\
* \pi_G = \theta_2 \theta\\
* \pi_T = (1 - \theta_1)(1 - \theta).
* \end{cases}
* \f]
*
* with \f$\pi_x\f$ the frequency of nucleotide \f$x\f$.
*
*/
class FullNucleotideFrequenciesSet :
public virtual NucleotideFrequenciesSet,
public AbstractFrequenciesSet
{
public:
FullNucleotideFrequenciesSet(const NucleicAlphabet* alphabet, bool allowNullFreqs = false, const std::string& name = "FullNucleotide");
FullNucleotideFrequenciesSet(const NucleicAlphabet* alphabet, double theta, double theta1, double theta2, bool allowNullFreqs = false, const std::string& name = "FullNucleotide");
#ifndef NO_VIRTUAL_COV
FullNucleotideFrequenciesSet*
#else
Clonable*
#endif
clone() const { return new FullNucleotideFrequenciesSet(*this); }
public:
#ifndef NO_VIRTUAL_COV
const NucleicAlphabet* getAlphabet() const
{
return dynamic_cast<const NucleicAlphabet*>(AbstractFrequenciesSet::getAlphabet());
}
#endif
void setFrequencies(const std::vector<double>& frequencies);
protected:
void fireParameterChanged(const ParameterList& parameters);
};
/**
* @brief Protein FrequenciesSet using 19 independent parameters to modelize the 20 frequencies.
*
* The parameters are called @f$ \theta_{i \in 1..19} @f$, and are initialized so that all frequencies are equal to 0.005, that is
* @f[ \theta_i = \frac{0.05}{0.956{i-1}},\quad i = 1..19 @f] or according to a user-specified vector of initial values.
*/
class FullProteinFrequenciesSet :
public virtual ProteinFrequenciesSet,
public FullFrequenciesSet
{
public:
FullProteinFrequenciesSet(const ProteicAlphabet* alphabet, bool allowNullFreqs = false, const std::string& name = "FullProtein") :
FullFrequenciesSet(alphabet, allowNullFreqs, name) {}
FullProteinFrequenciesSet(const ProteicAlphabet* alphabet, const std::vector<double>& initFreqs, bool allowNullFreqs = false, const std::string& name = "FullProtein") :
FullFrequenciesSet(alphabet, initFreqs, allowNullFreqs, name) {}
#ifndef NO_VIRTUAL_COV
FullProteinFrequenciesSet*
#else
Clonable*
#endif
clone() const { return new FullProteinFrequenciesSet(*this); }
public:
#ifndef NO_VIRTUAL_COV
const ProteicAlphabet* getAlphabet() const
{
return dynamic_cast<const ProteicAlphabet*>(AbstractFrequenciesSet::getAlphabet());
}
#endif
};
/**
* @brief FrequenciesSet to be used with a Markov-modulated substitution model.
*
* This implementation uses one parameter per character state frequency.
* The rate states are assumed to be fixed and are passed as an argument to the constructor, together with a 'regular'
* FrequenciesSet. The number of parameters hence do not depends on the number of rates used.
*/
class MarkovModulatedFrequenciesSet :
public AbstractFrequenciesSet
{
private:
FrequenciesSet* freqSet_;
std::vector<double> rateFreqs_;
public:
MarkovModulatedFrequenciesSet(FrequenciesSet* freqSet, const std::vector<double>& rateFreqs);
MarkovModulatedFrequenciesSet(const MarkovModulatedFrequenciesSet& mmfs) :
AbstractFrequenciesSet(mmfs),
freqSet_(mmfs.freqSet_->clone()),
rateFreqs_(mmfs.rateFreqs_)
{}
MarkovModulatedFrequenciesSet& operator=(const MarkovModulatedFrequenciesSet& mmfs)
{
AbstractFrequenciesSet::operator=(mmfs);
freqSet_ = mmfs.freqSet_->clone();
rateFreqs_ = mmfs.rateFreqs_;
return *this;
}
MarkovModulatedFrequenciesSet* clone() const { return new MarkovModulatedFrequenciesSet(*this); }
virtual ~MarkovModulatedFrequenciesSet() { delete freqSet_; }
public:
void setFrequencies(const std::vector<double>& frequencies)
{
// Just forward this method to the sequence state frequencies set. This may change in the future...
freqSet_->setFrequencies(frequencies);
}
void fireParameterChanged(const ParameterList& pl)
{
freqSet_->matchParametersValues(pl);
setFrequencies_(VectorTools::kroneckerMult(rateFreqs_, freqSet_->getFrequencies()));
}
const FrequenciesSet& getStatesFrequenciesSet() const { return *freqSet_; }
void setNamespace(const std::string& prefix)
{
AbstractFrequenciesSet::setNamespace(prefix);
freqSet_->setNamespace(prefix + freqSet_->getNamespace());
}
};
/**
* @brief FrequenciesSet useful for homogeneous and stationary models.
*
* This set contains no parameter.
*/
class FixedFrequenciesSet :
public AbstractFrequenciesSet
{
public:
/**
* @brief Construction with uniform frequencies on the letters of
* the alphabet.
*
* @param alphabet The alphabet for wich this frequencies set should be build. Will determine the number of frequencies.
* @param initFreqs The frequencies to use.
* @param name The name of the set.
*/
FixedFrequenciesSet(const Alphabet* alphabet, const std::vector<double>& initFreqs, const std::string& name = "Fixed");
/**
* @brief Construction with uniform frequencies on the letters of
* the alphabet.
*
* @param alphabet The alphabet for wich this frequencies set should be build. Will determine the number of frequencies.
* @param name The name of the set.
*/
FixedFrequenciesSet(const Alphabet* alphabet, const std::string& name = "Fixed");
FixedFrequenciesSet* clone() const { return new FixedFrequenciesSet(*this); }
public:
void setFrequencies(const std::vector<double>& frequencies);
protected:
void fireParameterChanged(const ParameterList& parameters) {}
};
/**
* @brief FrequenciesSet useful for homogeneous and stationary models, nucleotide implementation
*
* This set contains no parameter.
*/
class FixedNucleotideFrequenciesSet :
public virtual NucleotideFrequenciesSet,
public FixedFrequenciesSet
{
public:
FixedNucleotideFrequenciesSet(const NucleicAlphabet* alphabet, const std::vector<double>& initFreqs, const std::string& name = "FixedNucleotide") :
FixedFrequenciesSet(alphabet, initFreqs, name) {}
/**
* @brief Construction with uniform frequencies on the letters of
* the alphabet.
*/
FixedNucleotideFrequenciesSet(const NucleicAlphabet* alphabet, const std::string& name = "FixedNucleotide") :
FixedFrequenciesSet(alphabet, name) {}
#ifndef NO_VIRTUAL_COV
FixedNucleotideFrequenciesSet*
#else
NucleotideFrequenciesSet*
#endif
clone() const { return new FixedNucleotideFrequenciesSet(*this); }
#ifndef NO_VIRTUAL_COV
const NucleicAlphabet* getAlphabet() const
{
return dynamic_cast<const NucleicAlphabet*>(AbstractFrequenciesSet::getAlphabet());
}
#endif
};
/**
* @brief FrequenciesSet useful for homogeneous and stationary models, protein implementation
*
* This set contains no parameter.
*/
class FixedProteinFrequenciesSet :
public virtual ProteinFrequenciesSet,
public FixedFrequenciesSet
{
public:
FixedProteinFrequenciesSet(const ProteicAlphabet* alphabet, const std::vector<double>& initFreqs, const std::string& name = "FixedProtein") :
FixedFrequenciesSet(alphabet, initFreqs, name) {}
/**
* @brief Construction with uniform frequencies on the letters of
* the alphabet.
*/
FixedProteinFrequenciesSet(const ProteicAlphabet* alphabet, const std::string& name = "FixedProtein") :
FixedFrequenciesSet(alphabet, name) {}
#ifndef NO_VIRTUAL_COV
FixedProteinFrequenciesSet*
#else
FixedFrequenciesSet*
#endif
clone() const { return new FixedProteinFrequenciesSet(*this); }
#ifndef NO_VIRTUAL_COV
const ProteicAlphabet* getAlphabet() const
{
return dynamic_cast<const ProteicAlphabet*>(AbstractFrequenciesSet::getAlphabet());
}
#endif
};
/**
* @brief FrequenciesSet useful for homogeneous and stationary models, codon implementation
*
* This set contains no parameter.
*/
class FixedCodonFrequenciesSet :
public virtual CodonFrequenciesSet,
public AbstractFrequenciesSet
{
public:
FixedCodonFrequenciesSet(const CodonAlphabet* alphabet, const std::vector<double>& initFreqs, const std::string& name = "FixedCodon");
/**
* @brief Construction with uniform frequencies on the letters of
* the alphabet. The stop codon frequencies are null.
*/
FixedCodonFrequenciesSet(const CodonAlphabet* alphabet, const std::string& name = "FixedCodon");
#ifndef NO_VIRTUAL_COV
FixedCodonFrequenciesSet*
#else
Clonable*
#endif
clone() const { return new FixedCodonFrequenciesSet(*this); }
public:
#ifndef NO_VIRTUAL_COV
const CodonAlphabet* getAlphabet() const
{
return dynamic_cast<const CodonAlphabet*>(AbstractFrequenciesSet::getAlphabet());
}
#endif
/**
* @brief the given frequencies are normalized such thaat the sum of
* the frequencies on the non-stop codons equals 1.
*
*/
void setFrequencies(const std::vector<double>& frequencies);
protected:
void fireParameterChanged(const ParameterList& parameters) {}
};
/*********************************************************************/
/**** Frequencies Set in Words *****/
/*********************************************************************/
/**
* @brief Frequencies in words computed from the frequencies on
* letters. The parameters are the parameters of the Frequencies on
* letters.
* The WordFrequenciesSet owns the FrequenciesSet* it is built on.
* Interface class.
* @author Laurent Guéguen
*/
class WordFrequenciesSet :
public virtual FrequenciesSet
{
protected:
virtual unsigned int getSizeFromVector(const std::vector<FrequenciesSet*>& freqVector) = 0;
public:
#ifndef NO_VIRTUAL_COV
WordFrequenciesSet* clone() const = 0;
const WordAlphabet* getAlphabet() const = 0;
#endif
/**
*@ brief Returns the n-th FrequenciesSet&
**/
virtual const FrequenciesSet& getFrequenciesSetForLetter(unsigned int i) const = 0;
/**
*@ brief Returns the length of the words
**/
virtual unsigned int getLength() const = 0;
};
class AbstractWordFrequenciesSet :
public virtual WordFrequenciesSet,
public AbstractFrequenciesSet
{
protected:
unsigned int getSizeFromVector(const std::vector<FrequenciesSet*>& freqVector);
public:
AbstractWordFrequenciesSet(unsigned int size, const Alphabet* palph, const std::string& prefix = "", const std::string& name="");
#ifndef NO_VIRTUAL_COV
AbstractWordFrequenciesSet*
#else
Clonable*
#endif
clone() const = 0;
AbstractWordFrequenciesSet(const AbstractWordFrequenciesSet& af) :
AbstractFrequenciesSet(af) {}
AbstractWordFrequenciesSet & operator=(const AbstractWordFrequenciesSet& af)
{
AbstractFrequenciesSet::operator=(af);
return *this;
}
#ifndef NO_VIRTUAL_COV
const WordAlphabet* getAlphabet() const
{
return dynamic_cast<const WordAlphabet*>(AbstractFrequenciesSet::getAlphabet());
}
#endif
virtual ~AbstractWordFrequenciesSet();
/**
*@ brief Return the length of the words
**/
unsigned int getLength() const;
};
/**
* @brief the Frequencies in words are the product of Independent Frequencies in letters
* @author Laurent Guéguen
*/
class WordFromIndependentFrequenciesSet :
public AbstractWordFrequenciesSet
{
protected:
std::vector<FrequenciesSet*> vFreq_;
std::vector<std::string> vNestedPrefix_;
public:
/**
* @brief Constructor from a WordAlphabet* and a vector of different FrequenciesSet*.
* Throws an Exception if their lengths do not match.
*/
WordFromIndependentFrequenciesSet(const WordAlphabet* pWA, const std::vector<FrequenciesSet*>& freqVector, const std::string& prefix = "Word", const std::string& name="");
WordFromIndependentFrequenciesSet(const WordFromIndependentFrequenciesSet& iwfs);
~WordFromIndependentFrequenciesSet();
WordFromIndependentFrequenciesSet& operator=(const WordFromIndependentFrequenciesSet& iwfs);
WordFromIndependentFrequenciesSet* clone() const { return new WordFromIndependentFrequenciesSet(*this); }
public:
void fireParameterChanged(const ParameterList& pl);
virtual void updateFrequencies();
/**
*@ brief Independent letter frequencies from given word frequencies.
* The frequencies of a letter at a position is the sum of the
* frequencies of the words that have this letter at this
* position.
*/
virtual void setFrequencies(const std::vector<double>& frequencies);
/**
*@ brief Return the n-th FrequenciesSet&
**/
const FrequenciesSet& getFrequenciesSetForLetter(unsigned int i) const { return *vFreq_[i]; }
/**
*@ brief Return the length of the words
**/
virtual unsigned int getLength() const;
void setNamespace(const std::string& prefix);
std::string getDescription() const;
};
/**
* @brief the Frequencies in codons are the product of Independent
* Frequencies in letters with the frequencies of stop codons set to
* zero.
*
*
* @author Laurent Guéguen
*/
class CodonFromIndependentFrequenciesSet :
public virtual CodonFrequenciesSet,
public WordFromIndependentFrequenciesSet
{
public:
/**
* @brief Constructor from a CodonAlphabet* and a vector of different FrequenciesSet*.
* Throws an Exception if their lengths do not match.
*/
CodonFromIndependentFrequenciesSet(const CodonAlphabet* pCA, const std::vector<FrequenciesSet*>& freqvector, const std::string& name = "");
CodonFromIndependentFrequenciesSet(const CodonFromIndependentFrequenciesSet& iwfs);
~CodonFromIndependentFrequenciesSet(){};
CodonFromIndependentFrequenciesSet& operator=(const CodonFromIndependentFrequenciesSet& iwfs);
CodonFromIndependentFrequenciesSet* clone() const { return new CodonFromIndependentFrequenciesSet(*this); }
const CodonAlphabet* getAlphabet() const;
public:
void updateFrequencies();
/**
*@ brief Independent letter frequencies from given word frequencies.
* The frequencies of a letter at a position is the sum of the
* frequencies of the words that have this letter at this
* position.
*/
void setFrequencies(const std::vector<double>& frequencies);
};
/**
* @brief the Frequencies in words are the product of the frequencies
* for a unique FrequenciesSet in letters
* @author Laurent Guéguen
*/
class WordFromUniqueFrequenciesSet :
public AbstractWordFrequenciesSet
{
protected:
FrequenciesSet* pFreq_;
std::string NestedPrefix_;
unsigned int length_;
public:
/**
* @brief Constructor from a WordAlphabet* and a FrequenciesSet*
* repeated as many times as the length of the words.
*/
WordFromUniqueFrequenciesSet(const WordAlphabet* pWA, FrequenciesSet* pabsfreq, const std::string& prefix = "Word", const std::string& name = "");
WordFromUniqueFrequenciesSet(const WordFromUniqueFrequenciesSet& iwfs);
WordFromUniqueFrequenciesSet& operator=(const WordFromUniqueFrequenciesSet& iwfs);
~WordFromUniqueFrequenciesSet();
WordFromUniqueFrequenciesSet* clone() const { return new WordFromUniqueFrequenciesSet(*this); }
public:
virtual void fireParameterChanged(const ParameterList& pl);
/**
*@ brief letter frequencies from given word frequencies. The
* frequencies of a letter at a position is the sum of the
* frequencies of the words that have this letter at this position.
* The frequencies of each letter is the average of the frequencies
* of that letter at all positions.
*/
virtual void setFrequencies(const std::vector<double>& frequencies);
virtual void updateFrequencies();
/**
*@ brief Return the n-th FrequenciesSet&
**/
const FrequenciesSet& getFrequenciesSetForLetter(unsigned int i) const { return *pFreq_; }
unsigned int getLength() const { return length_; }
void setNamespace(const std::string& prefix);
std::string getDescription() const;
};
/**
* @brief the Frequencies in codons are the product of the frequencies
* for a unique FrequenciesSet in letters, with the frequencies of
* stop codons set to zero.
*
* @author Laurent Guéguen
*/
class CodonFromUniqueFrequenciesSet :
public virtual CodonFrequenciesSet,
public WordFromUniqueFrequenciesSet
{
public:
/**
* @brief Constructor from a CodonAlphabet* and a FrequenciesSet*
* repeated three times.
*/
CodonFromUniqueFrequenciesSet(const CodonAlphabet* pCA, FrequenciesSet* pfreq, const std::string& name = "");
CodonFromUniqueFrequenciesSet(const CodonFromUniqueFrequenciesSet& iwfs);
~CodonFromUniqueFrequenciesSet(){};
CodonFromUniqueFrequenciesSet& operator=(const CodonFromUniqueFrequenciesSet& iwfs);
CodonFromUniqueFrequenciesSet* clone() const { return new CodonFromUniqueFrequenciesSet(*this); }
public:
const CodonAlphabet* getAlphabet() const;
void updateFrequencies();
/**
*@ brief letter frequencies from given word frequencies. The
* frequencies of a letter at a position is the sum of the
* frequencies of the words that have this letter at this position.
* The frequencies of each letter is the average of the frequencies
* of that letter at all positions.
*/
void setFrequencies(const std::vector<double>& frequencies);
};
} // end of namespace bpp.
#endif // _FREQUENCIESSET_H_
|