scheduleMultiDim.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_SCHEDULE_MULTI_DIM_H
#define GUM_SCHEDULE_MULTI_DIM_H
 
#include <memory>
#include <string>
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphicalModels/inference/scheduler/IScheduleMultiDim.h>
 
namespace gum {

  template < typename TABLE >
  class ScheduleMultiDim: public IScheduleMultiDim {
    public:
    // ############################################################################
    // ############################################################################


    explicit ScheduleMultiDim(const TABLE& table, const bool copy, const Idx id = 0);


    explicit ScheduleMultiDim(TABLE&& table, const Idx id = 0);


    explicit ScheduleMultiDim(const Sequence< const DiscreteVariable* >& vars, const Idx id = 0);

    ScheduleMultiDim(const ScheduleMultiDim< TABLE >& from);

    ScheduleMultiDim(ScheduleMultiDim< TABLE >&& from);

    virtual ScheduleMultiDim< TABLE >* clone() const;

    virtual ScheduleMultiDim< TABLE >* clone(bool force_copy) const;

    virtual ~ScheduleMultiDim();

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


    ScheduleMultiDim< TABLE >& operator=(const ScheduleMultiDim< TABLE >& from);

    ScheduleMultiDim< TABLE >& operator=(ScheduleMultiDim< TABLE >&& from);


    virtual bool operator==(const ScheduleMultiDim< TABLE >&) const;


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


    virtual bool operator!=(const ScheduleMultiDim< TABLE >&) const;


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

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


    virtual bool hasSameVariables(const IScheduleMultiDim& m) const;


    virtual bool hasSameVariables(const ScheduleMultiDim< TABLE >& m) const;


    virtual bool hasSameContent(const IScheduleMultiDim&) const;


    virtual bool hasSameContent(const ScheduleMultiDim< TABLE >&) const;


    bool isAbstract() const final;


    bool containsMultiDim() const final;


    void makeAbstract() final;

    TABLE* exportMultiDim();

    const TABLE& multiDim() const;

    const Sequence< const DiscreteVariable* >& variablesSequence() const final;

    Size domainSize() const final;


    double sizeOfContent() const final;


    void setMultiDim(const TABLE& table, const bool copy);

    void setMultiDim(TABLE&& pot);

    std::string toString() const final;

 
 
    private:
    TABLE* _table_{nullptr};

    bool _table_contained_{true};

    Sequence< const DiscreteVariable* > _var_sequence_;

    Size _domain_size_{Size(1)};
 

    void _removeTable_();

    template < typename T >
    struct ElementType {
      using value_type = T;
    };
 
    template < template < typename, typename... > class CONTAINER, typename T, typename... Args >
    struct ElementType< CONTAINER< T, Args... > > {
      using value_type = T;
    };
  };
 
} /* namespace gum */
 
// always include the template implementation
#include <agrum/base/graphicalModels/inference/scheduler/scheduleMultiDim_tpl.h>
 
#endif /* GUM_SCHEDULE_MULTI_DIM_H */