multiDimCombination.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_MULTI_DIM_COMBINATION_H
#define GUM_MULTI_DIM_COMBINATION_H

#include <agrum/core/sequence.h>
#include <agrum/core/set.h>
#include <agrum/variables/discreteVariable.h>
#include <utility>

namespace gum {

  template < typename GUM_SCALAR, template < typename > class TABLE >
  class MultiDimCombination {
    public:
    // =========================================================================
    // =========================================================================

    MultiDimCombination();

    MultiDimCombination(const MultiDimCombination< GUM_SCALAR, TABLE >&);

    virtual ~MultiDimCombination();

    virtual MultiDimCombination< GUM_SCALAR, TABLE >* newFactory() const = 0;

    // =========================================================================
    // =========================================================================

    virtual TABLE< GUM_SCALAR >*
                 combine(const Set< const TABLE< GUM_SCALAR >* >& set) = 0;
    virtual void combine(TABLE< GUM_SCALAR >&                     container,
                         const Set< const TABLE< GUM_SCALAR >* >& set) = 0;

    virtual void setCombineFunction(TABLE< GUM_SCALAR >* (*combine)(
       const TABLE< GUM_SCALAR >&, const TABLE< GUM_SCALAR >&)) = 0;

    virtual TABLE< GUM_SCALAR >* (*combineFunction())(
       const TABLE< GUM_SCALAR >&, const TABLE< GUM_SCALAR >&) = 0;

    virtual float
                  nbOperations(const Set< const TABLE< GUM_SCALAR >* >& set) const = 0;
    virtual float nbOperations(
       const Set< const Sequence< const DiscreteVariable* >* >& set) const = 0;

    virtual std::pair< long, long >
                                    memoryUsage(const Set< const TABLE< GUM_SCALAR >* >& set) const = 0;
    virtual std::pair< long, long > memoryUsage(
       const Set< const Sequence< const DiscreteVariable* >* >& set) const = 0;

    private:
    MultiDimCombination< GUM_SCALAR, TABLE >&
       operator=(const MultiDimCombination< GUM_SCALAR, TABLE >&);

  };

} /* namespace gum */

// always include the template implementation
#include <agrum/multidim/utils/operators/multiDimCombination_tpl.h>

#endif /* GUM_MULTI_DIM_COMBINATION_H */