scoringCache.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_SCORING_CACHE_H
#define GUM_LEARNING_SCORING_CACHE_H

#include <utility>

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

namespace gum {

  namespace learning {


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

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

      ScoringCache(const allocator_type& alloc = allocator_type());

      ScoringCache(const ScoringCache< ALLOC >& from);

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

      ScoringCache(ScoringCache< ALLOC >&& from);

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

      virtual ScoringCache< ALLOC >* clone() const;

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

      virtual ~ScoringCache();



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

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

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



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


      void insert(const IdSet< ALLOC >& idset, double score);


      void insert(IdSet< ALLOC >&& idset, double score);


      void erase(const IdSet< ALLOC >& idset);


      bool exists(const IdSet< ALLOC >& idset);


      double score(const IdSet< ALLOC >& idset);

      void clear();

      std::size_t size() const;

      allocator_type getAllocator() const;



#ifndef DOXYGEN_SHOULD_SKIP_THIS

      private:
      HashTable< IdSet< ALLOC >,
                 double,
                 ALLOC< std::pair< IdSet< ALLOC >, double > > >
         __scores;

#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };

  } /* namespace learning */

} /* namespace gum */


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


#endif /* GUM_LEARNING_SCORING_CACHE_H */