scheduleCombinationBasic.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Pierre-Henri WUILLEMIN et Christophe GONZALES   *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_SCHEDULE_COMBINATION_BASIC_H
#define GUM_SCHEDULE_COMBINATION_BASIC_H

#include <agrum/agrum.h>

#include <agrum/core/priorityQueue.h>
#include <agrum/core/sequence.h>
#include <agrum/graphicalModels/inference/scheduleCombination.h>
#include <agrum/variables/discreteVariable.h>

namespace gum {

  template < typename GUM_SCALAR >
  class ScheduleCombinationBasic : public ScheduleCombination< GUM_SCALAR > {
    public:
    // ############################################################################
    // ############################################################################

    ScheduleCombinationBasic(MultiDimImplementation< GUM_SCALAR >* (*combine)(
       const MultiDimImplementation< GUM_SCALAR >&,
       const MultiDimImplementation< GUM_SCALAR >&));

    ScheduleCombinationBasic(const ScheduleCombinationBasic< GUM_SCALAR >&);

    virtual ~ScheduleCombinationBasic();


    virtual ScheduleCombinationBasic< GUM_SCALAR >* newFactory() const;


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

    // adds to a given schedule the operations necessary to perform a
    // combination
    virtual ScheduleMultiDim< GUM_SCALAR >
       combine(const Set< const ScheduleMultiDim< GUM_SCALAR >* >& set,
               Schedule< GUM_SCALAR >&);
    ScheduleMultiDim< GUM_SCALAR >
       combine(const Set< const MultiDimImplementation< GUM_SCALAR >* >& set,
               Schedule< GUM_SCALAR >&);
    template < template < typename > class TABLE >
    ScheduleMultiDim< GUM_SCALAR >
       combine(const Set< const TABLE< GUM_SCALAR >* >& set,
               Schedule< GUM_SCALAR >&);

    virtual void setCombineFunction(MultiDimImplementation< GUM_SCALAR >* (
       *combine)(const MultiDimImplementation< GUM_SCALAR >&,
                 const MultiDimImplementation< GUM_SCALAR >&));

    virtual MultiDimImplementation< GUM_SCALAR >* (*combineFunction())(
       const MultiDimImplementation< GUM_SCALAR >&,
       const MultiDimImplementation< GUM_SCALAR >&);

    virtual float
       nbOperations(const Set< const ScheduleMultiDim< GUM_SCALAR >* >& set,
                    const Schedule< GUM_SCALAR >&                       schedule);
    float
       nbOperations(const Set< const MultiDimImplementation< GUM_SCALAR >* >& set,
                    const Schedule< GUM_SCALAR >& schedule);
    template < template < typename > class TABLE >
    float nbOperations(const Set< const TABLE< GUM_SCALAR >* >& set,
                       const Schedule< GUM_SCALAR >&            schedule);


    virtual std::pair< long, long >
       memoryUsage(const Set< const ScheduleMultiDim< GUM_SCALAR >* >& set,
                   const Schedule< GUM_SCALAR >&                       schedule);
    std::pair< long, long >
       memoryUsage(const Set< const MultiDimImplementation< GUM_SCALAR >* >& set,
                   const Schedule< GUM_SCALAR >& schedule);
    template < template < typename > class TABLE >
    std::pair< long, long >
       memoryUsage(const Set< const TABLE< GUM_SCALAR >* >& set,
                   const Schedule< GUM_SCALAR >&            schedule);


    protected:
    MultiDimImplementation< GUM_SCALAR >* (*_combine)(
       const MultiDimImplementation< GUM_SCALAR >& t1,
       const MultiDimImplementation< GUM_SCALAR >& t2);

    Size _combinedSize(const Sequence< const DiscreteVariable* >& seq1,
                       const Sequence< const DiscreteVariable* >& seq2) const;
  };

} /* namespace gum */

// always include the template implementation
#include <agrum/graphicalModels/inference/scheduleCombinationBasic_tpl.h>

#endif /* GUM_SCHEDULE_COMBINATION_BASIC_H */