aprioriDirichletFromDatabase.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_DIRICHLET_FROM_DATABASE_H
#define GUM_LEARNING_A_PRIORI_DIRICHLET_FROM_DATABASE_H

#include <vector>

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

namespace gum {

  namespace learning {

    template < template < typename > class ALLOC = std::allocator >
    class AprioriDirichletFromDatabase : public Apriori< ALLOC > {
      public:
      using type = AprioriDirichletType;

      using allocator_type = ALLOC< NodeId >;


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


      AprioriDirichletFromDatabase(
         const DatabaseTable< ALLOC >&        learning_db,
         const DBRowGeneratorParser< ALLOC >& apriori_parser,
         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());

      AprioriDirichletFromDatabase(
         const AprioriDirichletFromDatabase< ALLOC >& from);

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

      AprioriDirichletFromDatabase(AprioriDirichletFromDatabase< ALLOC >&& from);

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

      virtual AprioriDirichletFromDatabase< ALLOC >* clone() const;

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

      virtual ~AprioriDirichletFromDatabase();



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

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

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



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

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

      virtual const std::string& getType() const final;


      virtual bool isInformative() const final;

      virtual void setWeight(const double weight) final;


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

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



#ifndef DOXYGEN_SHOULD_SKIP_THIS

      private:
      // the record counter used to parse the apriori database
      RecordCounter< ALLOC > __counter;

      // the internal weight is equal to _weight / nb rows of apriori database
      // this internal weight is used to ensure that assigning a weight of 1
      // to the apriori is equivalent to adding just one row to the learning
      // database
      double __internal_weight;

#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };

  } /* namespace learning */

} /* namespace gum */

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

#endif /* GUM_LEARNING_A_PRIORI_DIRICHLET_FROM_DATABASE_H */