regress.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_REGRESS_H
#define GUM_REGRESS_H
 
#include <agrum/base/multidim/utils/FunctionGraphUtilities/operators/o4DGContext.h>
 
namespace gum {

  template < typename GUM_SCALAR,
             template < typename > class COMBINEOPERATOR,
             template < typename > class PROJECTOPERATOR,
             template < typename > class TerminalNodePolicy = ExactTerminalNodePolicy >
  class Regress {
    public:
    // ============================================================================
    // ============================================================================

    Regress(const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* vfunction,
            const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* probDist,
            const gum::VariableSet*                                        primedVars,
            const DiscreteVariable*                                        targetVar,
            const GUM_SCALAR                                               neutral);

    ~Regress();

 
    // ============================================================================
    // ============================================================================

    MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* compute();

 
    private:
    void _establishVarOrder_();

    void
        _findRetrogradeVariables_(const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* dg,
                                  HashTable< NodeId, short int* >& dgInstNeed);

    NodeId _compute_(O4DGContext& currentSituation, Idx lastInstVarPos);

    const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* _DG1_;

    const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* _DG2_;

    MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* _rd_;

    const gum::VariableSet* _primedVars_;

    const DiscreteVariable* _targetVar_;

    const GUM_SCALAR _neutral_;

    Idx _nbVar_;

    const COMBINEOPERATOR< GUM_SCALAR > _combine_;
    const PROJECTOPERATOR< GUM_SCALAR > _project_;

    HashTable< double, NodeId > _explorationTable_;

    HashTable< NodeId, short int* > _DG1InstantiationNeeded_;
    HashTable< NodeId, short int* > _DG2InstantiationNeeded_;

    short int* _default_;
  };
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class Regress< double, std::multiplies, std::plus >;
#endif
 
}   // namespace gum
 
#include <agrum/base/multidim/utils/FunctionGraphUtilities/operators/regress_tpl.h>
 
#endif   // GUM_REGRESS_H