scheduler.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_SCHEDULER_H
#define GUM_SCHEDULER_H

#include <agrum/graphicalModels/inference/schedule.h>
#include <utility>

namespace gum {

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

    Scheduler();

    Scheduler(const Scheduler< GUM_SCALAR >&);

    virtual ~Scheduler();


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


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


    virtual bool execute(Schedule< GUM_SCALAR >&) = 0;


    virtual bool execute(Schedule< GUM_SCALAR >&, Size k) = 0;

    virtual float nbOperations(const Schedule< GUM_SCALAR >&) const = 0;

    virtual float nbOperations(const Schedule< GUM_SCALAR >&, Size k) const = 0;


    virtual std::pair< long, long >
       memoryUsage(const Schedule< GUM_SCALAR >&) const = 0;

    virtual std::pair< long, long > memoryUsage(const Schedule< GUM_SCALAR >&,
                                                Size k) const = 0;

  };

} /* namespace gum */

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

#endif /* GUM_SCHEDULER_H */