bpp-phyl  2.2.0
SequenceSimulationTools.cpp
Go to the documentation of this file.
1 //
2 // File: SequenceSimulationTools.cpp
3 // Created by: Julien Dutheil
4 // Created on: Wed Aug 24 16:25 2005
5 //
6 
7 /*
8  Copyright or © or Copr. Bio++ Development Team, (November 16, 2004)
9 
10  This software is a computer program whose purpose is to provide classes
11  for phylogenetic data analysis.
12 
13  This software is governed by the CeCILL license under French law and
14  abiding by the rules of distribution of free software. You can use,
15  modify and/ or redistribute the software under the terms of the CeCILL
16  license as circulated by CEA, CNRS and INRIA at the following URL
17  "http://www.cecill.info".
18 
19  As a counterpart to the access to the source code and rights to copy,
20  modify and redistribute granted by the license, users are provided only
21  with a limited warranty and the software's author, the holder of the
22  economic rights, and the successive licensors have only limited
23  liability.
24 
25  In this respect, the user's attention is drawn to the risks associated
26  with loading, using, modifying and/or developing or reproducing the
27  software by the user in light of its specific status of free software,
28  that may mean that it is complicated to manipulate, and that also
29  therefore means that it is reserved for developers and experienced
30  professionals having in-depth computer knowledge. Users are therefore
31  encouraged to load and test the software's suitability as regards their
32  requirements in conditions enabling the security of their systems and/or
33  data to be ensured and, more generally, to use and operate it in the
34  same conditions as regards security.
35 
36  The fact that you are presently reading this means that you have had
37  knowledge of the CeCILL license and that you accept its terms.
38  */
39 
41 
42 // From bpp-seq:
43 #include <Bpp/Seq/Container/VectorSiteContainer.h>
44 
45 using namespace bpp;
46 using namespace std;
47 
48 SiteContainer* SequenceSimulationTools::simulateSites(const SiteSimulator& simulator, const vector<double>& rates)
49 {
50  size_t numberOfSites = rates.size();
51  vector<const Site*> vs(numberOfSites);
52  for (size_t i = 0; i < numberOfSites; i++)
53  {
54  Site* s = simulator.simulateSite(rates[i]);
55  s->setPosition(static_cast<int>(i));
56  vs[i] = s;
57  }
58  SiteContainer* sites = new VectorSiteContainer(vs, simulator.getAlphabet());
59  sites->setSequencesNames(simulator.getSequencesNames(), false);
60  // Freeing memory:
61  for (size_t i = 0; i < numberOfSites; i++)
62  {
63  delete vs[i];
64  }
65 
66  return sites;
67 }
68 
69 SiteContainer* SequenceSimulationTools::simulateSites(const SiteSimulator& simulator, const vector<double>& rates, const vector<size_t>& states)
70 throw (Exception)
71 {
72  size_t numberOfSites = rates.size();
73  if (states.size() != numberOfSites)
74  throw Exception("SequenceSimulationTools::simulateSites., 'rates' and 'states' must have the same length.");
75  vector<const Site*> vs(numberOfSites);
76  for (size_t i = 0; i < numberOfSites; i++)
77  {
78  Site* s = simulator.simulateSite(states[i], rates[i]);
79  s->setPosition(static_cast<int>(i));
80  vs[i] = s;
81  }
82  SiteContainer* sites = new VectorSiteContainer(vs, simulator.getAlphabet());
83  sites->setSequencesNames(simulator.getSequencesNames(), false);
84  // Freeing memory:
85  for (size_t i = 0; i < numberOfSites; i++)
86  {
87  delete vs[i];
88  }
89 
90  return sites;
91 }
92 
93 SiteContainer* SequenceSimulationTools::simulateSites(const SiteSimulator& simulator, const vector<size_t>& states)
94 throw (Exception)
95 {
96  size_t numberOfSites = states.size();
97  vector<const Site*> vs(numberOfSites);
98  for (size_t i = 0; i < numberOfSites; i++)
99  {
100  Site* s = simulator.simulateSite(states[i]);
101  s->setPosition(static_cast<int>(i));
102  vs[i] = s;
103  }
104  SiteContainer* sites = new VectorSiteContainer(vs, simulator.getAlphabet());
105  sites->setSequencesNames(simulator.getSequencesNames(), false);
106  // Freeing memory:
107  for (size_t i = 0; i < numberOfSites; i++)
108  {
109  delete vs[i];
110  }
111 
112  return sites;
113 }
114 
The SiteSimulator interface. SiteSimulator classes can simulate single sites.
Definition: SiteSimulator.h:55
virtual Site * simulateSite() const =0
STL namespace.
virtual const Alphabet * getAlphabet() const =0
virtual std::vector< std::string > getSequencesNames() const =0
static SiteContainer * simulateSites(const SiteSimulator &simulator, const std::vector< double > &rates)
Simulate a set of sites knowing their rate.