bpp-popgen  3.0.0
MonoAlleleMonolocusGenotype.h
Go to the documentation of this file.
1 //
2 // File MonoAlleleMonolocusGenotype.h
3 // Author : Sylvain Gaillard <yragael2001@yahoo.fr>
4 // Last modification : Thursday July 29 2004
5 //
6 
7 /*
8  Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
9 
10  This software is a computer program whose purpose is to provide classes
11  for population genetics 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 
40 #ifndef _MONOALLELEMONOLOCUSGENOTYPE_H_
41 #define _MONOALLELEMONOLOCUSGENOTYPE_H_
42 
43 #include <Bpp/Exceptions.h>
44 
45 // From local
46 #include "MonolocusGenotype.h"
47 
48 namespace bpp
49 {
56  public MonolocusGenotype
57 {
58 private:
59  size_t allele_index_;
60 
61 public:
62  // Constructors and destructor
66  MonoAlleleMonolocusGenotype(size_t allele_index);
67 
71  MonoAlleleMonolocusGenotype(std::vector<size_t> allele_index);
72 
77 
82 
83 public:
84  // Other methodes
89 
93  virtual bool operator==(const MonoAlleleMonolocusGenotype& mmg) const;
94 
100  std::vector<size_t> getAlleleIndex() const;
110 };
111 } // end of namespace bpp;
112 
113 #endif // _MONOALLELEMONOLOCUSGENOTYPE_H_
The MonoAlleleMonolocusGenotype class.
std::vector< size_t > getAlleleIndex() const
Get the alleles' index.
MonoAlleleMonolocusGenotype & operator=(const MonoAlleleMonolocusGenotype &mmg)
The affectation operator.
MonoAlleleMonolocusGenotype(size_t allele_index)
Build a monolocus genotype containing one allele.
virtual bool operator==(const MonoAlleleMonolocusGenotype &mmg) const
The == operator.
MonoAlleleMonolocusGenotype * clone() const
~MonoAlleleMonolocusGenotype()
Destroy the MonoAlleleMonolocusGenotype.
The MonolocusGenotype virtual class.