multiDimInterface.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_MULTIDIM_INTERFACE_H
#define GUM_MULTIDIM_INTERFACE_H
 
#include <iostream>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/sequence.h>
#include <agrum/base/variables/discreteVariable.h>
 
namespace gum {
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  // Forward declaration.
  class Instantiation;
#endif
 
  // ==========================================================================
  // ===                    MULTIDIM INTERFACE                              ===
  // ==========================================================================
  class MultiDimInterface {
    public:
    virtual ~MultiDimInterface() {};
 
    // =========================================================================
    // =========================================================================

    virtual Idx nbrDim() const = 0;

    virtual Size domainSize() const = 0;

    virtual void add(const DiscreteVariable& v) = 0;

    virtual void erase(const DiscreteVariable& v) = 0;

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

    virtual const DiscreteVariable& variable(Idx i) const = 0;

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

    virtual Idx pos(const DiscreteVariable& v) const = 0;

    virtual bool contains(const DiscreteVariable& v) const = 0;

    virtual bool empty() const = 0;

    void replace(const DiscreteVariable& x, const DiscreteVariable& y);

 
    protected:
    virtual void replace_(const DiscreteVariable* x, const DiscreteVariable* y) = 0;
  };

  MultiDimInterface& operator<<(MultiDimInterface& c, const DiscreteVariable& v);

  MultiDimInterface& operator>>(MultiDimInterface& c, const DiscreteVariable& v);
 
} /* namespace gum */
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/multidim/implementations/multiDimInterface_inl.h>
#endif   // GUM_NO_INLINE
 
#endif   /* GUM_MULTIDIM_INTERFACE_H */