independenceTest.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2025                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_LEARNING_INDEPENDENCE_TEST_H
#define GUM_LEARNING_INDEPENDENCE_TEST_H
 
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/base/stattests/recordCounter.h>
#include <agrum/base/stattests/scoringCache.h>
#include <agrum/BN/learning/priors/prior.h>
#include <agrum/BN/learning/structureUtils/graphChange.h>
 
namespace gum {
 
  namespace learning {

    class IndependenceTest: public IThreadNumberManager {
      public:
      // ##########################################################################
      // ##########################################################################


      IndependenceTest(const DBRowGeneratorParser&                                 parser,
                       const Prior&                                                external_prior,
                       const std::vector< std::pair< std::size_t, std::size_t > >& ranges,
                       const Bijection< NodeId, std::size_t >&                     nodeId2columns
                       = Bijection< NodeId, std::size_t >());
 


      IndependenceTest(const DBRowGeneratorParser&             parser,
                       const Prior&                            external_prior,
                       const Bijection< NodeId, std::size_t >& nodeId2columns
                       = Bijection< NodeId, std::size_t >());

      virtual IndependenceTest* clone() const = 0;

      virtual ~IndependenceTest();

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


      virtual void setNumberOfThreads(Size nb);

      virtual Size getNumberOfThreads() const;

      virtual bool isGumNumberOfThreadsOverriden() const;

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

      virtual std::size_t minNbRowsPerThread() const;


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

      void clearRanges();

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

      double score(const NodeId var1, const NodeId var2);


      double score(const NodeId var1, const NodeId var2, const std::vector< NodeId >& rhs_ids);

      virtual void clear();

      virtual void clearCache();

      virtual void useCache(const bool on_off);


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

      const DatabaseTable& database() const;

 
 
      protected:
      const double one_log2_{M_LOG2E};

      Prior* prior_{nullptr};

      RecordCounter counter_;

      ScoringCache cache_;

      bool use_cache_{true};

      const std::vector< NodeId > empty_ids_;
 

      IndependenceTest(const IndependenceTest& from);

      IndependenceTest(IndependenceTest&& from);

      IndependenceTest& operator=(const IndependenceTest& from);

      IndependenceTest& operator=(IndependenceTest&& from);


      virtual double score_(const IdCondSet& idset) = 0;


      std::vector< double > marginalize_(const std::size_t            node_2_marginalize,
                                         const std::size_t            X_size,
                                         const std::size_t            Y_size,
                                         const std::size_t            Z_size,
                                         const std::vector< double >& N_xyz) const;
    };
 
  } /* namespace learning */
 
} /* namespace gum */
 
// include the inlined functions if necessary
#ifndef GUM_NO_INLINE
#  include <agrum/base/stattests/independenceTest_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_LEARNING_INDEPENDENCE_TEST_H */