aGrUM  0.15.1
scoreAIC.h
Go to the documentation of this file.
1 
29 #ifndef GUM_LEARNING_SCORE_AIC_H
30 #define GUM_LEARNING_SCORE_AIC_H
31 
32 #include <string>
33 
34 #include <agrum/agrum.h>
35 #include <agrum/core/math/math.h>
38 
39 namespace gum {
40 
41  namespace learning {
42 
51  template < template < typename > class ALLOC = std::allocator >
52  class ScoreAIC : public Score< ALLOC > {
53  public:
55  using allocator_type = ALLOC< NodeId >;
56 
57  // ##########################################################################
59  // ##########################################################################
61 
63 
84  const Apriori< ALLOC >& apriori,
85  const std::vector< std::pair< std::size_t, std::size_t >,
86  ALLOC< std::pair< std::size_t, std::size_t > > >&
87  ranges,
88  const Bijection< NodeId, std::size_t, ALLOC< std::size_t > >&
89  nodeId2columns =
90  Bijection< NodeId, std::size_t, ALLOC< std::size_t > >(),
91  const allocator_type& alloc = allocator_type());
92 
93 
95 
110  const Apriori< ALLOC >& apriori,
111  const Bijection< NodeId, std::size_t, ALLOC< std::size_t > >&
112  nodeId2columns =
113  Bijection< NodeId, std::size_t, ALLOC< std::size_t > >(),
114  const allocator_type& alloc = allocator_type());
115 
117  ScoreAIC(const ScoreAIC< ALLOC >& from);
118 
120  ScoreAIC(const ScoreAIC< ALLOC >& from, const allocator_type& alloc);
121 
123  ScoreAIC(ScoreAIC< ALLOC >&& from);
124 
126  ScoreAIC(ScoreAIC< ALLOC >&& from, const allocator_type& alloc);
127 
129  virtual ScoreAIC< ALLOC >* clone() const;
130 
132  virtual ScoreAIC< ALLOC >* clone(const allocator_type& alloc) const;
133 
135  virtual ~ScoreAIC();
136 
138 
139 
140  // ##########################################################################
142  // ##########################################################################
143 
145 
148 
151 
153 
154 
155  // ##########################################################################
157  // ##########################################################################
159 
161 
170  virtual std::string isAprioriCompatible() const final;
171 
173 
183  virtual const Apriori< ALLOC >& internalApriori() const final;
184 
186 
187 
189 
191  static std::string isAprioriCompatible(const std::string& apriori_type,
192  double weight = 1.0f);
193 
195 
196  static std::string isAprioriCompatible(const Apriori< ALLOC >& apriori);
197 
198 
199  protected:
201 
204  virtual double _score(const IdSet< ALLOC >& idset) final;
205 
206 
207 #ifndef DOXYGEN_SHOULD_SKIP_THIS
208 
209  private:
211  AprioriNoApriori< ALLOC > __internal_apriori;
212 
213 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
214  };
215 
216  } /* namespace learning */
217 
218 } /* namespace gum */
219 
220 
221 #ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
222 extern template class gum::learning::ScoreAIC<>;
223 #endif
224 
225 
226 // always include the template implementation
228 
229 #endif /* GUM_LEARNING_SCORE_AIC_H */
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
ALLOC< NodeId > allocator_type
type for the allocators passed in arguments of methods
Definition: scoreAIC.h:55
The base class for all the scores used for learning (BIC, BDeu, etc)
Definition: score.h:52
virtual ~ScoreAIC()
destructor
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
STL namespace.
A class for storing a pair of sets of NodeIds, the second one corresponding to a conditional set...
Definition: idSet.h:48
the base class for all a priori
Definition: apriori.h:50
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:55
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
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
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
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:52
Set of pairs of elements with fast search for both elements.
Definition: bijection.h:1805
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
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:98
the no a priori class: corresponds to 0 weight-sample