mixmod  3.2.0
Mixture models for clustering and classification
 All Classes Namespaces Files Functions Variables Enumerations Friends
MAlgo.h
1 /***************************************************************************
2  SRC/mixmod/Kernel/Algo/MAlgo.h description
3  copyright : (C) MIXMOD Team - 2001-2016
4  email : contact@mixmod.org
5  ***************************************************************************/
6 
7 /***************************************************************************
8  This file is part of MIXMOD
9 
10  MIXMOD is free software: you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation, either version 3 of the License, or
13  (at your option) any later version.
14 
15  MIXMOD is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  GNU General Public License for more details.
19 
20  You should have received a copy of the GNU General Public License
21  along with MIXMOD. If not, see <http://www.gnu.org/licenses/>.
22 
23  All informations available on : http://www.mixmod.org
24 ***************************************************************************/
25 #ifndef XEMMALGO_H
26 #define XEMMALGO_H
27 
28 #include "mixmod/Kernel/Algo/Algo.h"
29 
30 namespace XEM {
31 
37 class MAlgo : public Algo {
38 
39 public:
40 
42  MAlgo();
43 
45  MAlgo(const MAlgo & mAlgo);
46 
48  MAlgo(AlgoStopName algoStopName, double epsilon, int64_t nbIteration);
49 
51  virtual ~MAlgo();
52 
54  virtual Algo * clone();
55 
57  virtual void run(Model *& model);
58 
59  virtual const AlgoName getAlgoName() const;
60 
61  virtual void setEpsilon(double epsilon);
62 
63  virtual const double getEpsilon() const;
64 };
65 
66 inline const AlgoName MAlgo::getAlgoName() const {
67  return M;
68 }
69 
70 inline const double MAlgo::getEpsilon() const {
71  THROW(OtherException, internalMixmodError);
72 }
73 
74 inline void MAlgo::setEpsilon(double eps) {
75  THROW(OtherException, internalMixmodError);
76 }
77 
78 }
79 
80 #endif
Derived class of XEMAlgo for M Algorithm.
Definition: MAlgo.h:37
virtual Algo * clone()
clone
Definition: MAlgo.cpp:57
MAlgo()
Default constructor.
Definition: MAlgo.cpp:33
AlgoName
Enumeration of Algo type.
Definition: Util.h:319
virtual void run(Model *&model)
Run method.
Definition: MAlgo.cpp:64
Definition: Model.h:50
virtual ~MAlgo()
Destructor.
Definition: MAlgo.cpp:52
Base class for Algorithm(s)
Definition: Algo.h:40
AlgoStopName
Enumeration of differents type of converge of algorithm (stop rule)
Definition: Util.h:291