multiDimCompleteProjection_tpl.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 
#pragma once
 

 
#include <agrum/base/multidim/utils/operators/multiDimCompleteProjection.h>   // to ease IDE parser
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#  include <limits>
 
#  include <agrum/agrum.h>
 
namespace gum {
 
  // constructor
  template < typename GUM_ELEMENT, template < typename > class TABLE >
  MultiDimCompleteProjection< GUM_ELEMENT, TABLE >::MultiDimCompleteProjection(
      GUM_ELEMENT (*proj)(const TABLE< GUM_ELEMENT >&, Instantiation*)) : proj_(proj) {
    // for debugging purposes
    GUM_CONSTRUCTOR(MultiDimCompleteProjection);
  }
 
  // copy constructor
  template < typename GUM_ELEMENT, template < typename > class TABLE >
  MultiDimCompleteProjection< GUM_ELEMENT, TABLE >::MultiDimCompleteProjection(
      const MultiDimCompleteProjection< GUM_ELEMENT, TABLE >& from) : proj_(from.proj_) {
    // for debugging purposes
    GUM_CONS_CPY(MultiDimCompleteProjection);
  }
 
  // destructor
  template < typename GUM_ELEMENT, template < typename > class TABLE >
  MultiDimCompleteProjection< GUM_ELEMENT, TABLE >::~MultiDimCompleteProjection() {
    // for debugging purposes
    GUM_DESTRUCTOR(MultiDimCompleteProjection);
  }
 
  // virtual constructor
  template < typename GUM_ELEMENT, template < typename > class TABLE >
  MultiDimCompleteProjection< GUM_ELEMENT, TABLE >*
      MultiDimCompleteProjection< GUM_ELEMENT, TABLE >::newFactory() const {
    return new MultiDimCompleteProjection< GUM_ELEMENT, TABLE >(*this);
  }
 
  // creates and returns the projection of the table over a subset of its vars
  template < typename GUM_ELEMENT, template < typename > class TABLE >
  GUM_ELEMENT
      MultiDimCompleteProjection< GUM_ELEMENT, TABLE >::project(const TABLE< GUM_ELEMENT >& table,
                                                                Instantiation*              inst) {
    return proj_(table, inst);
  }
 
  // changes the function used for projecting TABLES
  template < typename GUM_ELEMENT, template < typename > class TABLE >
  void MultiDimCompleteProjection< GUM_ELEMENT, TABLE >::setProjectFunction(
      GUM_ELEMENT (*proj)(const TABLE< GUM_ELEMENT >&, Instantiation*)) {
    proj_ = proj;
  }
 
  // returns the projection function currently used by the projector
  template < typename GUM_ELEMENT, template < typename > class TABLE >
  GUM_ELEMENT (*MultiDimCompleteProjection< GUM_ELEMENT, TABLE >::projectFunction())(
      const TABLE< GUM_ELEMENT >&,
      Instantiation*) {
    return proj_;
  }
 
} /* namespace gum */
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */