apriori.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_A_PRIORI_H
#define GUM_LEARNING_A_PRIORI_H

#include <string>
#include <vector>

#include <agrum/agrum.h>
#include <agrum/core/bijection.h>
#include <agrum/learning/aprioris/aprioriTypes.h>
#include <agrum/learning/database/databaseTable.h>
#include <agrum/learning/scores_and_tests/idSet.h>

namespace gum {

  namespace learning {

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

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


      Apriori(const DatabaseTable< ALLOC >& database,
              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 Apriori< ALLOC >* clone() const = 0;

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

      virtual ~Apriori();


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

      virtual void setWeight(const double weight);

      double weight() const;

      virtual bool isOfType(const std::string& type) = 0;

      virtual const std::string& getType() const = 0;


      virtual bool isInformative() const = 0;


      virtual void
         addAllApriori(const IdSet< ALLOC >&                   idset,
                       std::vector< double, ALLOC< double > >& counts) = 0;

      virtual void addConditioningApriori(
         const IdSet< ALLOC >&                   idset,
         std::vector< double, ALLOC< double > >& counts) = 0;

      allocator_type getAllocator() const;



      protected:
      double _weight{1.0};

      const DatabaseTable< ALLOC >* _database;

      Bijection< NodeId, std::size_t, ALLOC< std::size_t > > _nodeId2columns;


      Apriori(const Apriori< ALLOC >& from);

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

      Apriori(Apriori< ALLOC >&& from);

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

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

      Apriori< ALLOC >& operator=(Apriori< ALLOC >&& from);
    };

  } /* namespace learning */

} /* namespace gum */

#include <agrum/learning/aprioris/apriori_tpl.h>

#endif /* GUM_LEARNING_A_PRIORI_H */