multiDimBucket.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_MULTIDIM_BUCKET_H
#define GUM_MULTIDIM_BUCKET_H

#include <climits>
#include <sstream>

#include <agrum/core/bijection.h>
#include <agrum/core/hashTable.h>
#include <agrum/core/sequence.h>
#include <agrum/core/set.h>

#include <agrum/multidim/implementations/multiDimArray.h>
#include <agrum/multidim/implementations/multiDimReadOnly.h>

namespace gum {

  template < typename GUM_SCALAR >
  class MultiDimBucket : 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 Set< const DiscreteVariable* >& 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 const 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;

    Set< const DiscreteVariable* > __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/multidim/implementations/multiDimBucket_tpl.h>

#endif /* GUM_MULTIDIM_BUCKET_H */