scheduleSeparatorStoreMultiDim.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_SEPARATOR_STORE_MULTI_DIM_H
#define GUM_SCHEDULE_SEPARATOR_STORE_MULTI_DIM_H

#include <string>

#include <agrum/agrum.h>

#include <agrum/core/sequence.h>
#include <agrum/graphicalModels/inference/scheduleMultiDim.h>
#include <agrum/graphicalModels/inference/scheduleOperation.h>
#include <agrum/graphs/graphElements.h>
#include <agrum/multidim/implementations/multiDimImplementation.h>

namespace gum {

  template < typename GUM_SCALAR >

  class ScheduleSeparatorStoreMultiDim : public ScheduleOperation< GUM_SCALAR > {
    public:
    // ############################################################################
    // ############################################################################

    ScheduleSeparatorStoreMultiDim(
       const ScheduleMultiDim< GUM_SCALAR >& table,
       ArcProperty< Set< const MultiDimImplementation< GUM_SCALAR >* > >&
           separator_tables,
       Arc separator);

    ScheduleSeparatorStoreMultiDim(
       const ScheduleSeparatorStoreMultiDim< GUM_SCALAR >&);

    virtual ScheduleSeparatorStoreMultiDim< GUM_SCALAR >* newFactory() const;

    virtual ~ScheduleSeparatorStoreMultiDim();


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

    ScheduleSeparatorStoreMultiDim< GUM_SCALAR >&
       operator=(const ScheduleSeparatorStoreMultiDim< GUM_SCALAR >&);


    bool operator==(const ScheduleOperation< GUM_SCALAR >&) const;


    bool operator!=(const ScheduleOperation< GUM_SCALAR >&) const;


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

    void execute();

    float nbOperations() const;


    std::pair< long, long > memoryUsage() const;

    const Sequence< const ScheduleMultiDim< GUM_SCALAR >* >& multiDimArgs() const;

    const Sequence< const ScheduleMultiDim< GUM_SCALAR >* >&
       multiDimResults() const;

    std::string toString() const;


    private:
    // the table to store into the clique
    ScheduleMultiDim< GUM_SCALAR > __table;

    // a mapping assigning to each clique a set of tables
    ArcProperty< Set< const MultiDimImplementation< GUM_SCALAR >* > >* __tableSet;

    // the separator into which the table will be stored
    Arc __separator;

    mutable Sequence< const ScheduleMultiDim< GUM_SCALAR >* >* __args;
  };

} /* namespace gum */

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

#endif /* GUM_SCHEDULE_SEPARATOR_STORE_MULTI_DIM_H */