multiDimArray.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_ARRAY_H
#define GUM_MULTI_DIM_ARRAY_H

#include <agrum/agrum.h>
#include <agrum/multidim/implementations/multiDimWithOffset.h>
#include <vector>

namespace gum {

  template < typename GUM_SCALAR >
  class MultiDimBijArray;

  // ===========================================================================
  // ===                          GUM_MULTI_DIM_ARRAY                        ===
  // ===========================================================================
  template < typename GUM_SCALAR >
  class MultiDimArray : public MultiDimWithOffset< GUM_SCALAR > {
    public:
    template < typename GUM_SCALARBIS >
    friend class MultiDimBijArray;
    // =========================================================================
    // =========================================================================

    MultiDimArray();

    MultiDimArray(const MultiDimArray< GUM_SCALAR >& src);

    virtual ~MultiDimArray();

    virtual MultiDimContainer< GUM_SCALAR >* newFactory() const;

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

    virtual void copyFrom(const MultiDimContainer< GUM_SCALAR >& src) 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 add(const DiscreteVariable& v);

    virtual void erase(const DiscreteVariable& v);

    virtual Size realSize() const;

    virtual void fill(const GUM_SCALAR& d) const;

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

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

    const GUM_SCALAR& unsafeGet(Idx offset) const;

    const GUM_SCALAR& getByOffset(Idx offset) const;

    void unsafeSet(Idx offset, const GUM_SCALAR& val);

    void setByOffset(Idx offset, const GUM_SCALAR& val);


    protected:
    mutable std::vector< GUM_SCALAR > _values;

    virtual void _commitMultipleChanges();

    virtual void _commitMultipleChanges(const GUM_SCALAR&);

    virtual GUM_SCALAR& _get(const Instantiation& i) const;

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


#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class MultiDimArray< double >;
#endif


} /* namespace gum */

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

#endif /* GUM_MULTI_DIM_ARRAY_H */