multiDimWithOffset.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_MULTI_DIM_WITH_OFFSET_H
#define GUM_MULTI_DIM_WITH_OFFSET_H
 
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/multidim/implementations/multiDimImplementation.h>
 
namespace gum {
  // ==========================================================================
  // ===                    GUM_MULTI_DIM_WITH_OFFSET === */
  // ==========================================================================
  template < typename GUM_SCALAR >
  class MultiDimWithOffset: public MultiDimImplementation< GUM_SCALAR > {
    public:
    // =========================================================================
    // =========================================================================

    MultiDimWithOffset();

    MultiDimWithOffset(const MultiDimWithOffset< GUM_SCALAR >& from);

    virtual ~MultiDimWithOffset();

    MultiDimWithOffset< GUM_SCALAR >& operator=(const MultiDimWithOffset< GUM_SCALAR >& from);
 
    virtual MultiDimContainer< GUM_SCALAR >* newFactory() const = 0;

    // =========================================================================
    // =========================================================================
 
    virtual void add(const DiscreteVariable& v);
 
    virtual void erase(const DiscreteVariable& v);
 
    virtual void fill(const GUM_SCALAR& d) const = 0;
 
    virtual std::string toString(const Instantiation* i) const;
 
    virtual void changeNotification(const Instantiation&          i,
                                    const DiscreteVariable* const var,
                                    Idx                           oldval,
                                    Idx                           newval);
 
    virtual void setChangeNotification(const Instantiation& i);
 
    virtual void setFirstNotification(const Instantiation& i);
 
    virtual void setLastNotification(const Instantiation& i);
 
    void setIncNotification(const Instantiation& i);
 
    void setDecNotification(const Instantiation& i);
 
    virtual bool registerSlave(Instantiation& i);
 
    virtual bool unregisterSlave(Instantiation& i);

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


    Size toOffset(const Instantiation& i) const;

    Instantiation& fromOffset(Instantiation& i, Size offset) const;

 
    protected:
    Size getOffs_(const Instantiation& i) const;

    HashTable< const DiscreteVariable*, Size > gaps_;

    HashTable< const Instantiation*, Size > offsets_;

    void computeInstantiationValue_(Instantiation& result, Size indice) const;
 
    virtual GUM_SCALAR& get_(const Instantiation& i) const = 0;
  };
} /* namespace gum */
 
#include <agrum/base/multidim/implementations/multiDimWithOffset_tpl.h>
 
#endif /* GUM_MULTI_DIM_WITH_OFFSET_H */