scheduleBinaryCombination.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_BINARY_COMBINATION_H
#define GUM_SCHEDULE_BINARY_COMBINATION_H
 
#include <memory>
#include <string>
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphicalModels/inference/scheduler/scheduleMultiDim.h>
#include <agrum/base/graphicalModels/inference/scheduler/scheduleOperator.h>
 
namespace gum {

  template < typename TABLE1, typename TABLE2, typename TABLE_RES >
  class ScheduleBinaryCombination: public ScheduleOperator {
    public:
    // ############################################################################
    // ############################################################################


    ScheduleBinaryCombination(const ScheduleMultiDim< TABLE1 >& table1,
                              const ScheduleMultiDim< TABLE2 >& table2,
                              TABLE_RES (*combine)(const TABLE1&, const TABLE2&),
                              const bool is_result_persistent = false);

    ScheduleBinaryCombination(const ScheduleBinaryCombination< TABLE1, TABLE2, TABLE_RES >& from);

    ScheduleBinaryCombination(ScheduleBinaryCombination< TABLE1, TABLE2, TABLE_RES >&& from);

    ScheduleBinaryCombination< TABLE1, TABLE2, TABLE_RES >* clone() const final;


    virtual ~ScheduleBinaryCombination();

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

    ScheduleBinaryCombination< TABLE1, TABLE2, TABLE_RES >&
        operator=(const ScheduleBinaryCombination< TABLE1, TABLE2, TABLE_RES >&);

    ScheduleBinaryCombination< TABLE1, TABLE2, TABLE_RES >&
        operator=(ScheduleBinaryCombination< TABLE1, TABLE2, TABLE_RES >&&);


    bool operator==(const ScheduleOperator&) const final;


    bool operator!=(const ScheduleOperator&) const final;


    bool operator==(const ScheduleBinaryCombination< TABLE1, TABLE2, TABLE_RES >&) const;


    bool operator!=(const ScheduleBinaryCombination< TABLE1, TABLE2, TABLE_RES >&) const;

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

    bool hasSameArguments(const ScheduleOperator&) const final;

    bool hasSameArguments(const ScheduleBinaryCombination< TABLE1, TABLE2, TABLE_RES >&) const;

    bool hasSimilarArguments(const ScheduleOperator&) const final;

    bool hasSimilarArguments(const ScheduleBinaryCombination< TABLE1, TABLE2, TABLE_RES >&) const;

    bool isSameOperator(const ScheduleOperator&) const final;

    bool isSameOperator(const ScheduleBinaryCombination< TABLE1, TABLE2, TABLE_RES >&) const;

    const ScheduleMultiDim< TABLE1 >& arg1() const;

    const ScheduleMultiDim< TABLE2 >& arg2() const;

    const Sequence< const IScheduleMultiDim* >& args() const final;


    const ScheduleMultiDim< TABLE_RES >& result() const;


    const Sequence< const IScheduleMultiDim* >& results() const final;


    void updateArgs(const Sequence< const IScheduleMultiDim* >& new_args) final;

    bool isExecuted() const final;


    void execute() final;

    void undo() final;

    double nbOperations() const final;


    std::pair< double, double > memoryUsage() const final;

    std::string toString() const final;

    void setCombinationFunction(TABLE_RES (*combine)(const TABLE1&, const TABLE2&));

 
 
    private:
    const ScheduleMultiDim< TABLE1 >* _arg1_{nullptr};

    const ScheduleMultiDim< TABLE2 >* _arg2_{nullptr};


    Sequence< const IScheduleMultiDim* > _args_;

    ScheduleMultiDim< TABLE_RES >* _result_{nullptr};


    Sequence< const IScheduleMultiDim* > _results_;

    TABLE_RES (*_combine_)(const TABLE1&, const TABLE2&);
  };
 
} /* namespace gum */
 
// always include the template implementation
#include <agrum/base/graphicalModels/inference/scheduler/scheduleBinaryCombination_tpl.h>
 
#endif /* GUM_SCHEDULE_BINARY_COMBINATION_H */