completeProjections4MultiDim.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 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-2025                            *
 *       - 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                           *
 *                                                                          *
 ****************************************************************************/
 

 
#ifndef GUM_COMPLETE_PROJECTIONS_4_MULTI_DIM_H
#define GUM_COMPLETE_PROJECTIONS_4_MULTI_DIM_H
 
#include <atomic>
#include <mutex>
 
#include <agrum/base/multidim/implementations/multiDimArray.h>
 
namespace gum {
 
  // ==========================================================================
  // ==========================================================================

  template < typename GUM_SCALAR >
  GUM_SCALAR projectMaxMultiDimArray(const MultiDimArray< GUM_SCALAR >* table,
                                     Instantiation*                     instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR projectMaxMultiDimArray(const MultiDimImplementation< GUM_SCALAR >* table,
                                     Instantiation*                              instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR* projectMaxMultiDimArray4Pointers(const MultiDimArray< GUM_SCALAR* >* table,
                                               Instantiation* instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR* projectMaxMultiDimArray4Pointers(const MultiDimImplementation< GUM_SCALAR* >* table,
                                               Instantiation* instantiation = 0);

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

  template < typename GUM_SCALAR >
  GUM_SCALAR projectMinMultiDimArray(const MultiDimArray< GUM_SCALAR >* table,
                                     Instantiation*                     instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR projectMinMultiDimArray(const MultiDimImplementation< GUM_SCALAR >* table,
                                     Instantiation*                              instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR* projectMinMultiDimArray4Pointers(const MultiDimArray< GUM_SCALAR* >* table,
                                               Instantiation* instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR* projectMinMultiDimArray4Pointers(const MultiDimImplementation< GUM_SCALAR* >* table,
                                               Instantiation* instantiation = 0);

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

  template < typename GUM_SCALAR >
  GUM_SCALAR projectSumMultiDimArray(const MultiDimArray< GUM_SCALAR >* table,
                                     Instantiation*                     instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR projectSumMultiDimArray(const MultiDimImplementation< GUM_SCALAR >* table,
                                     Instantiation*                              instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR* projectSumMultiDimArray4Pointers(const MultiDimArray< GUM_SCALAR* >* table,
                                               Instantiation* instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR* projectSumMultiDimArray4Pointers(const MultiDimImplementation< GUM_SCALAR* >* table,
                                               Instantiation* instantiation = 0);

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

  template < typename GUM_SCALAR >
  GUM_SCALAR projectProductMultiDimArray(const MultiDimArray< GUM_SCALAR >* table,
                                         Instantiation*                     instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR projectProductMultiDimArray(const MultiDimImplementation< GUM_SCALAR >* table,
                                         Instantiation* instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR* projectProductMultiDimArray4Pointers(const MultiDimArray< GUM_SCALAR* >* table,
                                                   Instantiation* instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR*
      projectProductMultiDimArray4Pointers(const MultiDimImplementation< GUM_SCALAR* >* table,
                                           Instantiation* instantiation = 0);


  template < typename GUM_SCALAR >
  GUM_SCALAR projectMax(const MultiDimImplementation< GUM_SCALAR >& table,
                        Instantiation*                              instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR projectMin(const MultiDimImplementation< GUM_SCALAR >& table,
                        Instantiation*                              instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR projectSum(const MultiDimImplementation< GUM_SCALAR >& table,
                        Instantiation*                              instantiation = 0);

  template < typename GUM_SCALAR >
  GUM_SCALAR projectProduct(const MultiDimImplementation< GUM_SCALAR >& table,
                            Instantiation*                              instantiation = 0);
 
  // ==========================================================================
  // DO NOT FORGET TO REGISTER YOUR PROJECTION FUNCTIONS AT THE END OF FILE
  // completeProjections4MultiDim_tpl.h
  // ==========================================================================

  template < typename GUM_SCALAR >
  void completeProjections4MultiDimInit();

  template < typename GUM_SCALAR >
  void pointerCompleteProjections4MultiDimInit();

  template < typename GUM_SCALAR >
  struct CompleteProjections4MultiDimInitialize {
    void init() { completeProjections4MultiDimInit< GUM_SCALAR >(); };
  };

  template < typename GUM_SCALAR >
  struct CompleteProjections4MultiDimInitialize< GUM_SCALAR* > {
    void init() { pointerCompleteProjections4MultiDimInit< GUM_SCALAR >(); };
  };
 
} /* namespace gum */
 
// always include the templatized implementations
#include <agrum/base/multidim/utils/operators/completeProjections4MultiDim_tpl.h>
 
#endif /* GUM_COMPLETE_PROJECTIONS_4_MULTI_DIM_H */