clusteredLayerGenerator.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_CLUSTERED_LAYER_GENERATOR_H
#define GUM_CLUSTERED_LAYER_GENERATOR_H
 
#include <cstdlib>
#include <ctime>
#include <list>
#include <sstream>
#include <string>
#include <vector>
 
#include <agrum/PRM/generator/layerGenerator.h>
 
namespace gum {
  namespace prm {

    template < typename GUM_SCALAR >
    class ClusteredLayerGenerator: public PRMGenerator< GUM_SCALAR > {
      public:
      // ========================================================================
      // ========================================================================

      ClusteredLayerGenerator();
      ClusteredLayerGenerator(const ClusteredLayerGenerator& source);
      ClusteredLayerGenerator& operator=(const ClusteredLayerGenerator& source);
      virtual ~ClusteredLayerGenerator();

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

      Size getDomainSize() const;

      void setDomainSize(Size s);

      Size getMaxParents() const;

      void setMaxParents(Size s);

      double getClusterRatio() const;

      void setClusterRatio(double ratio);

      void setLayers(const std::vector< typename LayerGenerator< GUM_SCALAR >::LayerData >& v);
 
      std::vector< typename LayerGenerator< GUM_SCALAR >::LayerData >&       getLayer();
      const std::vector< typename LayerGenerator< GUM_SCALAR >::LayerData >& getLayer() const;

      virtual PRM< GUM_SCALAR >* generate();

 
      private:
      std::vector< typename LayerGenerator< GUM_SCALAR >::LayerData > _layers_;
      Size                                                            _domain_size_;
      Size                                                            _max_parents_;
      double                                                          _cluster_ratio_;
      HashTable< std::string, std::vector< std::string >* >           _cluster_map_;
 
      struct MyData {
        // interface name
        std::string                i;
        std::vector< std::string > a;
        std::vector< std::string > g;
        std::string                r;
        std::vector< std::string > c;
      };
 
      std::string _generateType_(PRMFactory< GUM_SCALAR >& f);
 
      void _generateInterfaces_(PRMFactory< GUM_SCALAR >& f,
                                const std::string&        type,
                                std::vector< MyData >&    l);
 
      void _generateClasses_(PRMFactory< GUM_SCALAR >&                                f,
                             const std::string&                                       type,
                             std::vector< typename ClusteredLayerGenerator::MyData >& l);
 
      void _generateCluster_(PRMFactory< GUM_SCALAR >&                                f,
                             const std::string&                                       type,
                             std::vector< typename ClusteredLayerGenerator::MyData >& l,
                             Size                                                     lvl,
                             Set< std::string >&                                      i);
 
      void _generateClass_(PRMFactory< GUM_SCALAR >&                                f,
                           const std::string&                                       type,
                           std::vector< typename ClusteredLayerGenerator::MyData >& l,
                           Size                                                     lvl,
                           Set< std::string >&                                      i);
 
      void _generateClassDag_(Size                                                     lvl,
                              DAG&                                                     dag,
                              Bijection< std::string, NodeId >&                        names,
                              std::vector< typename ClusteredLayerGenerator::MyData >& l);
 
      void _generateSystem_(PRMFactory< GUM_SCALAR >&                                factory,
                            std::vector< typename ClusteredLayerGenerator::MyData >& l);
    };
 
  } /* namespace prm */
} /* namespace gum */
 
#include <agrum/PRM/generator/clusteredLayerGenerator_tpl.h>
 
#endif /* GUM_CLUSTERED_LAYER_GENERATOR_H */