indepTestChi2.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_INDEP_TEST_CHI2_H
#define GUM_LEARNING_INDEP_TEST_CHI2_H

#include <vector>

#include <agrum/core/math/chi2.h>
#include <agrum/learning/scores_and_tests/independenceTest.h>
#include <agrum/learning/aprioris/aprioriNoApriori.h>

namespace gum {

  namespace learning {

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

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


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



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

      IndepTestChi2(const IndepTestChi2< ALLOC >& from);

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

      IndepTestChi2(IndepTestChi2< ALLOC >&& from);

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

      virtual IndepTestChi2< ALLOC >* clone() const;

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

      virtual ~IndepTestChi2();



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


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

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


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


      std::pair< double, double >
         statistics(NodeId                                        var1,
                    NodeId                                        var2,
                    const std::vector< NodeId, ALLOC< NodeId > >& rhs_ids = {});



      protected:

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

      std::pair< double, double > _statistics(const IdSet< ALLOC >& idset);

#ifndef DOXYGEN_SHOULD_SKIP_THIS

      private:
      std::vector< std::size_t, ALLOC< std::size_t > > __domain_sizes;

      Chi2 __chi2;

      const std::vector< Idx > __empty_set;

#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };

  } /* namespace learning */

} /* namespace gum */


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


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

#endif /* GUM_LEARNING_INDEP_TEST_CHI2_H */