regress.h

Go to the documentation of this file.

/****************************************************************************
 *  Copyright (C) 2005 by Pierre-Henri WUILLEMIN et Christophe GONZALES     *
 *  {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_REGRESS_H
#define GUM_REGRESS_H

#include <agrum/multidim/implementations/multiDimFunctionGraph.h>
#include <agrum/multidim/utils/FunctionGraphUtilities/operators/o4DGContext.h>
#include <agrum/multidim/utils/FunctionGraphUtilities/terminalNodePolicies/ExactTerminalNodePolicy.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 Set< const DiscreteVariable* >*                          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 Set< const DiscreteVariable* >* __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/multidim/utils/FunctionGraphUtilities/operators/regress_tpl.h>

#endif   // GUM_REGRESS_H