multiDimBucket.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_MULTIDIM_BUCKET_H
#define GUM_MULTIDIM_BUCKET_H
 
#include <climits>
#include <sstream>
 
#include <agrum/base/core/bijection.h>
#include <agrum/base/multidim/implementations/multiDimArray.h>
#include <agrum/base/multidim/implementations/multiDimReadOnly.h>
 
namespace gum {

 
  template < typename GUM_SCALAR >
  class MultiDimBucket final: public MultiDimReadOnly< GUM_SCALAR > {
    public:
    // ========================================================================
    // ========================================================================

    explicit MultiDimBucket(Size bufferSize = INT_MAX);

    MultiDimBucket(const MultiDimBucket< GUM_SCALAR >& source);

    virtual ~MultiDimBucket();

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

    void add(const MultiDimContainer< GUM_SCALAR >& impl);

    void add(const MultiDimContainer< GUM_SCALAR >* impl);

    void erase(const MultiDimContainer< GUM_SCALAR >& impl);

    void erase(const MultiDimContainer< GUM_SCALAR >* impl);

    bool contains(const MultiDimContainer< GUM_SCALAR >& impl) const;

    const gum::VariableSet& allVariables() const;

    Size bucketSize() const;

    bool isBucketEmpty() const;

    bool bucketChanged() const;

    const MultiDimArray< GUM_SCALAR >& bucket() const;

    Size bufferSize() const;

    void setBufferSize(Size amount);

    void compute(bool force = false) const;

    // ========================================================================
    // ========================================================================
 
    virtual MultiDimContainer< GUM_SCALAR >* newFactory() const override;
 
    const std::string& name() const override;
 
    virtual void add(const DiscreteVariable& v) override;
 
    virtual void erase(const DiscreteVariable& v) override;
 
    virtual Size realSize() const override;
 
    bool contains(const DiscreteVariable& v) const override;
 
    virtual GUM_SCALAR get(const Instantiation& i) const override;
 
    virtual void changeNotification(const Instantiation&          i,
                                    const DiscreteVariable* const var,
                                    Idx                           oldval,
                                    Idx                           newval) override;
 
    virtual void setFirstNotification(const Instantiation& i) override;
 
    virtual void setLastNotification(const Instantiation& i) override;
 
    virtual void setIncNotification(const Instantiation& i) override;
 
    virtual void setDecNotification(const Instantiation& i) override;
 
    virtual void setChangeNotification(const Instantiation& i) override;
 
    virtual bool registerSlave(Instantiation& i) override;
 
    virtual bool unregisterSlave(Instantiation& i) override;
 
    virtual MultiDimAdressable& getMasterRef() override;
 
    virtual const MultiDimAdressable& getMasterRef() const override;
 
    virtual std::string toString(const Instantiation* i) const override;


    const HashTable< const MultiDimContainer< GUM_SCALAR >*, Instantiation* >& multidims() const;
 
    protected:
    virtual void commitMultipleChanges_() override;

    virtual GUM_SCALAR& get_(const Instantiation& i) const override;
 
    virtual void replace_(const DiscreteVariable* x, const DiscreteVariable* y) override;
 
    private:
    Size _bufferSize_;

    Bijection< Instantiation*, Instantiation* > _instantiations_;

    MultiDimArray< GUM_SCALAR >* _bucket_;

    mutable HashTable< const MultiDimContainer< GUM_SCALAR >*, Instantiation* > _multiDims_;

    gum::VariableSet _allVariables_;

    mutable Instantiation _allVarsInst_;

    void _addVariable_(const DiscreteVariable* var);

    void _eraseVariable_(const DiscreteVariable* var);

    void _initializeBuffer_();

    void _eraseBuffer_();

    GUM_SCALAR _computeValue_(const Instantiation& value) const;

    mutable bool _changed_;

    mutable HashTable< const Instantiation*, GUM_SCALAR > _slavesValue_;

    std::string _name_;
  };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class MultiDimBucket< double >;
#endif
 
 
} /* namespace gum */
 
#include <agrum/base/multidim/implementations/multiDimBucket_tpl.h>
 
#endif /* GUM_MULTIDIM_BUCKET_H */