scheduleProjection.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_PROJECTION_H
#define GUM_SCHEDULE_PROJECTION_H

#include <agrum/core/set.h>
#include <agrum/graphicalModels/inference/schedule.h>
#include <agrum/graphicalModels/inference/scheduleMultiDim.h>
#include <agrum/variables/discreteVariable.h>
#include <utility>

namespace gum {

  template < typename GUM_SCALAR >
  class ScheduleProjection {
    public:
    // ############################################################################
    // ############################################################################

    ScheduleProjection();

    ScheduleProjection(const ScheduleProjection< GUM_SCALAR >&);

    virtual ~ScheduleProjection();


    virtual ScheduleProjection< GUM_SCALAR >* newFactory() const = 0;


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


    virtual ScheduleMultiDim< GUM_SCALAR >
       project(const ScheduleMultiDim< GUM_SCALAR >& table,
               const Set< const DiscreteVariable* >& del_vars,
               Schedule< GUM_SCALAR >&               schedule) = 0;
    ScheduleMultiDim< GUM_SCALAR >
       project(const MultiDimImplementation< GUM_SCALAR >& table,
               const Set< const DiscreteVariable* >&       del_vars,
               Schedule< GUM_SCALAR >&                     schedule);
    template < template < typename > class TABLE >
    ScheduleMultiDim< GUM_SCALAR >
       project(const TABLE< GUM_SCALAR >&            table,
               const Set< const DiscreteVariable* >& del_vars,
               Schedule< GUM_SCALAR >&               schedule);

    virtual void setProjectFunction(MultiDimImplementation< GUM_SCALAR >* (*proj)(
       const MultiDimImplementation< GUM_SCALAR >&,
       const Set< const DiscreteVariable* >&)) = 0;

    virtual MultiDimImplementation< GUM_SCALAR >* (*projectFunction())(
       const MultiDimImplementation< GUM_SCALAR >&,
       const Set< const DiscreteVariable* >&) = 0;

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


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


    private:
    ScheduleProjection< GUM_SCALAR >&
       operator=(const ScheduleProjection< GUM_SCALAR >&);
  };

} /* namespace gum */

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

#endif /* GUM_SCHEDULE_PROJECTION_H */