statesCounter.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_STATES_COUNTER_H
#define GUM_STATES_COUNTER_H
// =========================================================================
// =========================================================================
#include <agrum/FMDP/learning/datastructure/IVisitableGraphLearner.h>
 
// =========================================================================
// =========================================================================
 
namespace gum {
 

  class StatesCounter: public IVisitableGraphLearner {
    public:
    // ==========================================================================
    // ==========================================================================

    StatesCounter();

    ~StatesCounter();

 
    // ==========================================================================
    // ==========================================================================
 
    void incState(const Instantiation&);
 
    void reset(const Instantiation&);
 
    const MultiDimFunctionGraph< int >* counter();

 
 
    // ###################################################################
    // ###################################################################
 
    public:
    // ==========================================================================
    // ==========================================================================
    NodeId root() const { return _counter_->root(); }
 
    // ==========================================================================
    // ==========================================================================
    bool isTerminal(NodeId ni) const { return _counter_->isTerminalNode(ni); }
 
    // ==========================================================================
    // ==========================================================================
    const DiscreteVariable* nodeVar(NodeId ni) const { return _counter_->node(ni)->nodeVar(); }
 
    // ==========================================================================
    // ==========================================================================
    NodeId nodeSon(NodeId ni, Idx modality) const { return _counter_->node(ni)->son(modality); }
 
    // ==========================================================================
    // ==========================================================================
    Idx nodeNbObservation(NodeId ni) const { return _counter_->nodeValue(ni); }
 
    void insertSetOfVars(MultiDimFunctionGraph< double >* ret) const {
      for (SequenceIteratorSafe< const DiscreteVariable* > varIter
           = _counter_->variablesSequence().beginSafe();
           varIter != _counter_->variablesSequence().endSafe();
           ++varIter)
        ret->add(**varIter);
    }

 
    private:
    void _incState_(const Instantiation&, NodeId, Idx, Size);
 
    MultiDimFunctionGraph< Size >* _counter_;
 
    Set< Instantiation* > _visitedStates_;
  };
} /* namespace gum */
 
#endif   // GUM_STATES_COUNTER_H