multiDimProjection.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_PROJECTION_H
#define GUM_MULTI_DIM_PROJECTION_H

#include <utility>

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

namespace gum {

  // clang-format off
  // clang-format on
  template < typename GUM_SCALAR, template < typename > class TABLE >
  class MultiDimProjection {
    public:
    // ========================================================================
    // ========================================================================

    MultiDimProjection(TABLE< GUM_SCALAR >* (*proj)(
       const TABLE< GUM_SCALAR >&, const Set< const DiscreteVariable* >&));

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

    virtual ~MultiDimProjection();

    virtual MultiDimProjection< GUM_SCALAR, TABLE >* newFactory() const;

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

    TABLE< GUM_SCALAR >* project(const TABLE< GUM_SCALAR >&            table,
                                 const Set< const DiscreteVariable* >& del_vars);

    void project(TABLE< GUM_SCALAR >&                     container,
                 const TABLE< GUM_SCALAR >&               table,
                 const Set< const TABLE< GUM_SCALAR >* >& del_vars);

    void setProjectFunction(TABLE< GUM_SCALAR >* (*proj)(
       const TABLE< GUM_SCALAR >&, const Set< const DiscreteVariable* >&));

    TABLE< GUM_SCALAR >* (*projectFunction())(
       const TABLE< GUM_SCALAR >&, const Set< const DiscreteVariable* >&);

    float nbOperations(const TABLE< GUM_SCALAR >&            table,
                       const Set< const DiscreteVariable* >& del_vars) const;

    float nbOperations(const Sequence< const DiscreteVariable* >& vars,
                       const Set< const DiscreteVariable* >&      del_vars) const;

    std::pair< long, long >
       memoryUsage(const TABLE< GUM_SCALAR >&            table,
                   const Set< const DiscreteVariable* >& del_vars) const;

    std::pair< long, long >
       memoryUsage(const Sequence< const DiscreteVariable* >& vars,
                   const Set< const DiscreteVariable* >&      del_vars) const;


    protected:
    TABLE< GUM_SCALAR >* (*_proj)(const TABLE< GUM_SCALAR >&,
                                  const Set< const DiscreteVariable* >&);

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

} /* namespace gum */

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

#endif /* GUM_MULTI_DIM_PROJECTION_H */