aGrUM  0.14.1
scoreAIC.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN *
3  * {prenom.nom}_at_lip6.fr *
4  * *
5  * This program is free software; you can redistribute it and/or modify *
6  * it under the terms of the GNU General Public License as published by *
7  * the Free Software Foundation; either version 2 of the License, or *
8  * (at your option) any later version. *
9  * *
10  * This program is distributed in the hope that it will be useful, *
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13  * GNU General Public License for more details. *
14  * *
15  * You should have received a copy of the GNU General Public License *
16  * along with this program; if not, write to the *
17  * Free Software Foundation, Inc., *
18  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19  ***************************************************************************/
26 #ifndef GUM_LEARNING_SCORE_AIC_H
27 #define GUM_LEARNING_SCORE_AIC_H
28 
29 #include <string>
30 
31 #include <agrum/agrum.h>
32 #include <agrum/core/math/math.h>
35 
36 namespace gum {
37 
38  namespace learning {
39 
48  template < template < typename > class ALLOC = std::allocator >
49  class ScoreAIC : public Score< ALLOC > {
50  public:
52  using allocator_type = ALLOC< NodeId >;
53 
54  // ##########################################################################
56  // ##########################################################################
58 
60 
81  const Apriori< ALLOC >& apriori,
82  const std::vector< std::pair< std::size_t, std::size_t >,
83  ALLOC< std::pair< std::size_t, std::size_t > > >&
84  ranges,
85  const Bijection< NodeId, std::size_t, ALLOC< std::size_t > >&
86  nodeId2columns =
87  Bijection< NodeId, std::size_t, ALLOC< std::size_t > >(),
88  const allocator_type& alloc = allocator_type());
89 
90 
92 
107  const Apriori< ALLOC >& apriori,
108  const Bijection< NodeId, std::size_t, ALLOC< std::size_t > >&
109  nodeId2columns =
110  Bijection< NodeId, std::size_t, ALLOC< std::size_t > >(),
111  const allocator_type& alloc = allocator_type());
112 
114  ScoreAIC(const ScoreAIC< ALLOC >& from);
115 
117  ScoreAIC(const ScoreAIC< ALLOC >& from, const allocator_type& alloc);
118 
120  ScoreAIC(ScoreAIC< ALLOC >&& from);
121 
123  ScoreAIC(ScoreAIC< ALLOC >&& from, const allocator_type& alloc);
124 
126  virtual ScoreAIC< ALLOC >* clone() const;
127 
129  virtual ScoreAIC< ALLOC >* clone(const allocator_type& alloc) const;
130 
132  virtual ~ScoreAIC();
133 
135 
136 
137  // ##########################################################################
139  // ##########################################################################
140 
142 
145 
148 
150 
151 
152  // ##########################################################################
154  // ##########################################################################
156 
158 
167  virtual std::string isAprioriCompatible() const final;
168 
170 
180  virtual const Apriori< ALLOC >& internalApriori() const final;
181 
183 
184 
186 
188  static std::string isAprioriCompatible(const std::string& apriori_type,
189  double weight = 1.0f);
190 
192 
193  static std::string isAprioriCompatible(const Apriori< ALLOC >& apriori);
194 
195 
196  protected:
198 
201  virtual double _score(const IdSet< ALLOC >& idset) final;
202 
203 
204 #ifndef DOXYGEN_SHOULD_SKIP_THIS
205 
206  private:
208  AprioriNoApriori< ALLOC > __internal_apriori;
209 
210 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
211  };
212 
213  } /* namespace learning */
214 
215 } /* namespace gum */
216 
217 
218 #ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
219 extern template class gum::learning::ScoreAIC<>;
220 #endif
221 
222 
223 // always include the template implementation
225 
226 #endif /* GUM_LEARNING_SCORE_AIC_H */
Useful macros for maths.
ALLOC< NodeId > allocator_type
type for the allocators passed in arguments of methods
Definition: scoreAIC.h:52
The base class for all the scores used for learning (BIC, BDeu, etc)
Definition: score.h:49
virtual ~ScoreAIC()
destructor
the no a priori class: corresponds to 0 weight-sample
STL namespace.
A class for storing a pair of sets of NodeIds, the second one corresponding to a conditional set...
Definition: idSet.h:45
the base class for all a priori
Definition: apriori.h:47
ScoreAIC< ALLOC > & operator=(const ScoreAIC< ALLOC > &from)
copy operator
ALLOC< NodeId > allocator_type
type for the allocators passed in arguments of methods
Definition: score.h:52
gum is the global namespace for all aGrUM entities
Definition: agrum.h:25
const std::vector< std::pair< std::size_t, std::size_t >, ALLOC< std::pair< std::size_t, std::size_t > > > & ranges() const
returns the current ranges
virtual ScoreAIC< ALLOC > * clone() const
virtual copy constructor
virtual const Apriori< ALLOC > & internalApriori() const final
returns the internal apriori of the score
the class for computing AIC scores
ScoreAIC(const DBRowGeneratorParser< ALLOC > &parser, const Apriori< ALLOC > &apriori, const std::vector< std::pair< std::size_t, std::size_t >, ALLOC< std::pair< std::size_t, std::size_t > > > &ranges, const Bijection< NodeId, std::size_t, ALLOC< std::size_t > > &nodeId2columns=Bijection< NodeId, std::size_t, ALLOC< std::size_t > >(), const allocator_type &alloc=allocator_type())
default constructor
the class for computing AIC scores
Definition: scoreAIC.h:49
Set of pairs of elements with fast search for both elements.
Definition: bijection.h:1803
the base class for all the scores used for learning (BIC, BDeu, etc)
virtual double _score(const IdSet< ALLOC > &idset) final
returns the score for a given IdSet
virtual std::string isAprioriCompatible() const final
indicates whether the apriori is compatible (meaningful) with the score
the class used to read a row in the database and to transform it into a set of DBRow instances that c...
Size NodeId
Type for node ids.
Definition: graphElements.h:97
the no a priori class: corresponds to 0 weight-sample