IScheduleMultiDim.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_ISCHEDULE_MULTI_DIM_H
#define GUM_ISCHEDULE_MULTI_DIM_H
 
#include <atomic>
#include <memory>
#include <string>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/sequence.h>
#include <agrum/base/variables/discreteVariable.h>
 
namespace gum {

  class IScheduleMultiDim {
    public:
    // ############################################################################
    // ############################################################################


    explicit IScheduleMultiDim(const Idx id = 0);

    virtual IScheduleMultiDim* clone() const = 0;

    virtual IScheduleMultiDim* clone(bool force_copy) const = 0;

    virtual ~IScheduleMultiDim();

 
 
    // ############################################################################
    // ############################################################################



    virtual bool operator==(const IScheduleMultiDim&) const;


    virtual bool operator!=(const IScheduleMultiDim&) const;

 
 
    // ############################################################################
    // ############################################################################


    virtual bool hasSameVariables(const IScheduleMultiDim& m) const = 0;


    virtual bool hasSameContent(const IScheduleMultiDim&) const = 0;


    virtual bool isAbstract() const = 0;


    virtual bool containsMultiDim() const = 0;


    virtual void makeAbstract() = 0;


    Idx id() const;

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

    virtual Size domainSize() const = 0;


    virtual double sizeOfContent() const = 0;

    virtual std::string toString() const = 0;


    static void resetIdGenerator();

 
    protected:
    IScheduleMultiDim& operator=(const IScheduleMultiDim& from);

    IScheduleMultiDim& operator=(IScheduleMultiDim&& from);

    IScheduleMultiDim(const IScheduleMultiDim& from);

    IScheduleMultiDim(IScheduleMultiDim&& from);
 

    Idx id_;
 
 
    private:
    static Idx _newId_();
 
    // the id used whenever any ScheduleMultiDim of any type asks for a new id
    static std::atomic< Idx > _multidim_id_;
  };
 
} /* namespace gum */

#ifndef GUM_NO_INLINE
#  include <agrum/base/graphicalModels/inference/scheduler/IScheduleMultiDim_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_ISCHEDULE_MULTI_DIM_H */