scoreK2.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_LEARNING_SCORE_K2_H
#define GUM_LEARNING_SCORE_K2_H

#include <string>

#include <agrum/agrum.h>
#include <agrum/core/math/math.h>
#include <agrum/core/math/gammaLog2.h>
#include <agrum/learning/scores_and_tests/score.h>
#include <agrum/learning/aprioris/aprioriK2.h>

namespace gum {

  namespace learning {

    template < template < typename > class ALLOC = std::allocator >
    class ScoreK2 : public Score< ALLOC > {
      public:
      using allocator_type = ALLOC< NodeId >;

      // ##########################################################################
      // ##########################################################################


      ScoreK2(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());



      ScoreK2(const DBRowGeneratorParser< ALLOC >& parser,
              const Apriori< ALLOC >&              apriori,
              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());

      ScoreK2(const ScoreK2< ALLOC >& from);

      ScoreK2(const ScoreK2< ALLOC >& from, const allocator_type& alloc);

      ScoreK2(ScoreK2< ALLOC >&& from);

      ScoreK2(ScoreK2< ALLOC >&& from, const allocator_type& alloc);

      virtual ScoreK2< ALLOC >* clone() const;

      virtual ScoreK2< ALLOC >* clone(const allocator_type& alloc) const;

      virtual ~ScoreK2();



      // ##########################################################################
      // ##########################################################################


      ScoreK2< ALLOC >& operator=(const ScoreK2< ALLOC >& from);

      ScoreK2< ALLOC >& operator=(ScoreK2< ALLOC >&& from);



      // ##########################################################################
      // ##########################################################################


      virtual std::string isAprioriCompatible() const final;


      virtual const Apriori< ALLOC >& internalApriori() const final;




      static std::string isAprioriCompatible(const std::string& apriori_type,
                                             double             weight = 1.0f);


      static std::string isAprioriCompatible(const Apriori< ALLOC >& apriori);


      protected:

      virtual double _score(const IdSet< ALLOC >& idset) final;


#ifndef DOXYGEN_SHOULD_SKIP_THIS

      private:
      AprioriK2< ALLOC > __internal_apriori;

      GammaLog2 __gammalog2;


#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };

  } /* namespace learning */

} /* namespace gum */


#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::learning::ScoreK2<>;
#endif


// always include the template implementation
#include <agrum/learning/scores_and_tests/scoreK2_tpl.h>

#endif /* GUM_LEARNING_SCORE_K2_H */