score.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_H
#define GUM_LEARNING_SCORE_H

#include <utility>

#include <agrum/agrum.h>
#include <agrum/core/math/math.h>
#include <agrum/core/OMPThreads.h>

#include <agrum/learning/scores_and_tests/recordCounter.h>
#include <agrum/learning/scores_and_tests/scoringCache.h>
#include <agrum/learning/aprioris/apriori.h>
#include <agrum/learning/structureUtils/graphChange.h>

namespace gum {

  namespace learning {

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

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


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



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

      virtual Score< ALLOC >* clone() const = 0;

      virtual Score< ALLOC >* clone(const allocator_type& alloc) const = 0;

      virtual ~Score();



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

      virtual void setMaxNbThreads(std::size_t nb) const;

      virtual std::size_t nbThreads() const;

      virtual void setMinNbRowsPerThread(const std::size_t nb) const;

      virtual std::size_t minNbRowsPerThread() const;


      template < template < typename > class XALLOC >
      void setRanges(
         const std::vector< std::pair< std::size_t, std::size_t >,
                            XALLOC< std::pair< std::size_t, std::size_t > > >&
            new_ranges);

      void clearRanges();

      const std::vector< std::pair< std::size_t, std::size_t >,
                         ALLOC< std::pair< std::size_t, std::size_t > > >&
         ranges() const;

      double score(const NodeId var);


      double score(const NodeId                                  var,
                   const std::vector< NodeId, ALLOC< NodeId > >& rhs_ids);

      void clear();

      void clearCache();

      void useCache(const bool on_off);

      bool isUsingCache() const;


      const Bijection< NodeId, std::size_t, ALLOC< std::size_t > >&
         nodeId2Columns() const;

      const DatabaseTable< ALLOC >& database() const;


      virtual std::string isAprioriCompatible() const = 0;


      virtual const Apriori< ALLOC >& internalApriori() const = 0;

      allocator_type getAllocator() const;



      protected:
      const double _1log2{M_LOG2E};

      Apriori< ALLOC >* _apriori{nullptr};

      RecordCounter< ALLOC > _counter;

      ScoringCache< ALLOC > _cache;

      bool _use_cache{true};

      const std::vector< NodeId, ALLOC< NodeId > > _empty_ids;


      Score(const Score< ALLOC >& from);

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

      Score(Score< ALLOC >&& from);

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

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

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


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


      std::vector< double, ALLOC< double > >
         _marginalize(const NodeId                                  X_id,
                      const std::vector< double, ALLOC< double > >& N_xyz) const;
    };

  } /* namespace learning */

} /* namespace gum */


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


#include <agrum/learning/scores_and_tests/score_tpl.h>

#endif /* GUM_LEARNING_SCORE_H */