multiDimContainer.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_CONTAINER_H
#define GUM_MULTIDIM_CONTAINER_H

#include <functional>
#include <initializer_list>
#include <iostream>
#include <vector>

#include <agrum/agrum.h>
#include <agrum/core/math/math.h>

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

namespace gum {
  // needed for content()
  template < typename GUM_SCALAR >
  class MultiDimImplementation;

  // ==========================================================================
  // ===                             GUM_MULTI_DIM                          ===
  // ==========================================================================
  template < typename GUM_SCALAR >
  class MultiDimContainer : public MultiDimAdressable {
    public:
    // =========================================================================
    // =========================================================================

    MultiDimContainer();

    MultiDimContainer(const MultiDimContainer< GUM_SCALAR >& src);

    MultiDimContainer& operator=(const MultiDimContainer< GUM_SCALAR >& src);

    MultiDimContainer(MultiDimContainer< GUM_SCALAR >&&);

    MultiDimContainer& operator=(MultiDimContainer< GUM_SCALAR >&& src);

    virtual ~MultiDimContainer();

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

    virtual void set(const Instantiation& i, const GUM_SCALAR& value) const;

    virtual GUM_SCALAR get(const Instantiation& i) const;

    GUM_SCALAR operator[](const Instantiation& i) const;

    virtual void fill(const GUM_SCALAR& d) const = 0;

    virtual void populate(const std::vector< GUM_SCALAR >& v) const;

    virtual void populate(std::initializer_list< GUM_SCALAR > l) const;

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

    virtual void copyFrom(const MultiDimContainer< GUM_SCALAR >& src) const;

    virtual void copyFrom(const MultiDimContainer< GUM_SCALAR >& src,
                          Instantiation*                         p_i) const;

    virtual void extractFrom(const MultiDimContainer< GUM_SCALAR >& src,
                             const Instantiation&                   mask);

    virtual const MultiDimImplementation< GUM_SCALAR >* content() const = 0;

    virtual MultiDimImplementation< GUM_SCALAR >* content() = 0;

    virtual MultiDimAdressable& getMasterRef();

    virtual const MultiDimAdressable& getMasterRef() const;


    virtual void copy(const MultiDimContainer< GUM_SCALAR >& src);

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

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

    virtual const std::string toString() const;

    virtual const std::string toString(const Instantiation* i) const = 0;

    bool operator==(const MultiDimContainer< GUM_SCALAR >& p) const;

    bool operator!=(const MultiDimContainer< GUM_SCALAR >& p) const;

    virtual void apply(std::function< GUM_SCALAR(GUM_SCALAR) > f) const;

    virtual GUM_SCALAR
       reduce(std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) > f,
              GUM_SCALAR                                          base) const;


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

    virtual void beginMultipleChanges() = 0;

    virtual void endMultipleChanges() = 0;

    virtual void endMultipleChanges(const GUM_SCALAR& v) = 0;


    protected:
    virtual GUM_SCALAR& _get(const Instantiation& i) const = 0;
  };
} /* namespace gum */

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

#endif /* GUM_MULTIDIM_CONTAINER_H */