multiDimImplementation.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_MULTI_DIM_IMPLEMENTATION_H
#define GUM_MULTI_DIM_IMPLEMENTATION_H

#include <vector>

#include <agrum/agrum.h>

#include <agrum/multidim/implementations/multiDimContainer.h>

namespace gum {

  // ===========================================================================
  // ===                    GUM_MULTI_DIM_IMPLEMENTATION                     ===
  // ===========================================================================
  template < typename GUM_SCALAR >
  class MultiDimImplementation : public MultiDimContainer< GUM_SCALAR > {
    public:
    // =========================================================================
    // =========================================================================

    MultiDimImplementation();

    MultiDimImplementation(const MultiDimImplementation< GUM_SCALAR >& from);

    virtual ~MultiDimImplementation();

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

    virtual const std::string& name() const = 0;

    const std::string& basename() const;

    virtual Size realSize() const = 0;

    float compressionRate() const;

    // ========================================================================
    // ========================================================================
    virtual Idx nbrDim() const override;

    virtual Size domainSize() const override;

    virtual void add(const DiscreteVariable& v) override;

    virtual void erase(const DiscreteVariable& v) override;

    virtual const Sequence< const DiscreteVariable* >&
       variablesSequence() const override;

    virtual const DiscreteVariable& variable(Idx i) const override;
    virtual const DiscreteVariable&
       variable(const std::string& name) const override;

    virtual Idx pos(const DiscreteVariable& v) const override;

    virtual bool contains(const DiscreteVariable& v) const override;

    virtual bool empty() const override;

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

    virtual bool registerSlave(Instantiation& slave) override;

    virtual bool unregisterSlave(Instantiation& slave) override;

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

    using MultiDimContainer< GUM_SCALAR >::get;

    virtual MultiDimContainer< GUM_SCALAR >* newFactory() const override = 0;

    virtual void beginMultipleChanges() override;

    virtual void endMultipleChanges() override;

    virtual void endMultipleChanges(const GUM_SCALAR&) override;


    protected:
    // =========================================================================
    // =========================================================================

    virtual void _commitMultipleChanges();

    virtual void _commitMultipleChanges(const GUM_SCALAR& value);

    bool _isInMultipleChangeMethod() const;

    bool _isCommitNeeded() const;

    const List< Instantiation* >& _slaves() const;

    virtual void _replace(const DiscreteVariable* x,
                          const DiscreteVariable* y) override;

    virtual void _invert(Idx p1, Idx p2);


    virtual const MultiDimImplementation< GUM_SCALAR >* content() const final;

    virtual MultiDimImplementation< GUM_SCALAR >* content() final;

    private:
    Sequence< const DiscreteVariable* > __vars;

    List< Instantiation* > __slaveInstantiations;

    enum class __InternalChangeMethod : char { DIRECT_CHANGE, MULTIPLE_CHANGE };

    enum class __InternalChangeState : char { NO_CHANGE, NOT_COMMITTED_CHANGE };

    __InternalChangeMethod __internalChangeMethod;

    __InternalChangeState __internalChangeState;

    Size __domainSize;

    void __setNotCommitedChange();
  };

  template < typename GUM_SCALAR >
  std::ostream& operator<<(std::ostream&,
                           const MultiDimImplementation< GUM_SCALAR >&);

} /* namespace gum */

#include <agrum/multidim/implementations/multiDimImplementation_tpl.h>

#endif /* GUM_MULTI_DIM_IMPLEMENTATION_H */