aGrUM 2.3.2
a C++ library for (probabilistic) graphical models
projections4MultiDim.h
Go to the documentation of this file.
1/****************************************************************************
2 * This file is part of the aGrUM/pyAgrum library. *
3 * *
4 * Copyright (c) 2005-2025 by *
5 * - Pierre-Henri WUILLEMIN(_at_LIP6) *
6 * - Christophe GONZALES(_at_AMU) *
7 * *
8 * The aGrUM/pyAgrum library is free software; you can redistribute it *
9 * and/or modify it under the terms of either : *
10 * *
11 * - the GNU Lesser General Public License as published by *
12 * the Free Software Foundation, either version 3 of the License, *
13 * or (at your option) any later version, *
14 * - the MIT license (MIT), *
15 * - or both in dual license, as here. *
16 * *
17 * (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html) *
18 * *
19 * This aGrUM/pyAgrum library is distributed in the hope that it will be *
20 * useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
21 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
22 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, *
25 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR *
26 * OTHER DEALINGS IN THE SOFTWARE. *
27 * *
28 * See LICENCES for more details. *
29 * *
30 * SPDX-FileCopyrightText: Copyright 2005-2025 *
31 * - Pierre-Henri WUILLEMIN(_at_LIP6) *
32 * - Christophe GONZALES(_at_AMU) *
33 * SPDX-License-Identifier: LGPL-3.0-or-later OR MIT *
34 * *
35 * Contact : info_at_agrum_dot_org *
36 * homepage : http://agrum.gitlab.io *
37 * gitlab : https://gitlab.com/agrumery/agrum *
38 * *
39 ****************************************************************************/
40
41
48
49#ifndef GUM_PROJECTIONS_4_MULTI_DIM_H
50#define GUM_PROJECTIONS_4_MULTI_DIM_H
51
52#include <atomic>
53#include <mutex>
54
55#include <agrum/base/multidim/implementations/multiDimArray.h>
56#include <agrum/base/multidim/implementations/multiDimFunctionGraph.h>
57
58namespace gum {
59
60 // ==========================================================================
62 // ==========================================================================
64
82 template < typename GUM_SCALAR >
83 MultiDimArray< GUM_SCALAR >* projectMaxMultiDimArray(const MultiDimArray< GUM_SCALAR >* table,
84 const gum::VariableSet& del_vars);
85
103 template < typename GUM_SCALAR >
104 MultiDimImplementation< GUM_SCALAR >*
105 projectMaxMultiDimArray(const MultiDimImplementation< GUM_SCALAR >* table,
106 const gum::VariableSet& del_vars);
107
125 template < typename GUM_SCALAR >
126 MultiDimArray< GUM_SCALAR* >*
127 projectMaxMultiDimArray4Pointers(const MultiDimArray< GUM_SCALAR* >* table,
128 const gum::VariableSet& del_vars);
129
147 template < typename GUM_SCALAR >
148 MultiDimImplementation< GUM_SCALAR* >*
149 projectMaxMultiDimArray4Pointers(const MultiDimImplementation< GUM_SCALAR* >* table,
150 const gum::VariableSet& del_vars);
151
152 // @}
153 // ==========================================================================
155 // ==========================================================================
157
175 template < typename GUM_SCALAR >
176 MultiDimArray< GUM_SCALAR >* projectMinMultiDimArray(const MultiDimArray< GUM_SCALAR >* table,
177 const gum::VariableSet& del_vars);
178
196 template < typename GUM_SCALAR >
197 MultiDimImplementation< GUM_SCALAR >*
198 projectMinMultiDimArray(const MultiDimImplementation< GUM_SCALAR >* table,
199 const gum::VariableSet& del_vars);
200
218 template < typename GUM_SCALAR >
219 MultiDimArray< GUM_SCALAR* >*
220 projectMinMultiDimArray4Pointers(const MultiDimArray< GUM_SCALAR* >* table,
221 const gum::VariableSet& del_vars);
222
240 template < typename GUM_SCALAR >
241 MultiDimImplementation< GUM_SCALAR* >*
242 projectMinMultiDimArray4Pointers(const MultiDimImplementation< GUM_SCALAR* >* table,
243 const gum::VariableSet& del_vars);
244
245 // @}
246 // ==========================================================================
248 // ==========================================================================
250
268 template < typename GUM_SCALAR >
269 MultiDimArray< GUM_SCALAR >* projectSumMultiDimArray(const MultiDimArray< GUM_SCALAR >* table,
270 const gum::VariableSet& del_vars);
271
289 template < typename GUM_SCALAR >
290 MultiDimImplementation< GUM_SCALAR >*
291 projectSumMultiDimArray(const MultiDimImplementation< GUM_SCALAR >* table,
292 const gum::VariableSet& del_vars);
293
311 template < typename GUM_SCALAR >
312 MultiDimArray< GUM_SCALAR* >*
313 projectSumMultiDimArray4Pointers(const MultiDimArray< GUM_SCALAR* >* table,
314 const gum::VariableSet& del_vars);
315
333 template < typename GUM_SCALAR >
334 MultiDimImplementation< GUM_SCALAR* >*
335 projectSumMultiDimArray4Pointers(const MultiDimImplementation< GUM_SCALAR* >* table,
336 const gum::VariableSet& del_vars);
337
338 // @}
339 // ==========================================================================
341 // ==========================================================================
343
361 template < typename GUM_SCALAR >
362 MultiDimArray< GUM_SCALAR >* projectProductMultiDimArray(const MultiDimArray< GUM_SCALAR >* table,
363 const gum::VariableSet& del_vars);
364
382 template < typename GUM_SCALAR >
383 MultiDimImplementation< GUM_SCALAR >*
384 projectProductMultiDimArray(const MultiDimImplementation< GUM_SCALAR >* table,
385 const gum::VariableSet& del_vars);
386
404 template < typename GUM_SCALAR >
405 MultiDimArray< GUM_SCALAR* >*
406 projectProductMultiDimArray4Pointers(const MultiDimArray< GUM_SCALAR* >* table,
407 const gum::VariableSet& del_vars);
408
426 template < typename GUM_SCALAR >
427 MultiDimImplementation< GUM_SCALAR* >*
428 projectProductMultiDimArray4Pointers(const MultiDimImplementation< GUM_SCALAR* >* table,
429 const gum::VariableSet& del_vars);
430
431 // @}
432 // ==========================================================================
434 // ==========================================================================
436
448 template < typename GUM_SCALAR >
449 MultiDimArray< GUM_SCALAR >* ProjectFuncMultiDimArray(const MultiDimArray< GUM_SCALAR >* t1,
450 const MultiDimArray< GUM_SCALAR >* t2,
451 const GUM_SCALAR (*f)(const GUM_SCALAR&,
452 const GUM_SCALAR&));
453
465 template < typename GUM_SCALAR >
466 MultiDimImplementation< GUM_SCALAR >*
467 combine2MultiDimArrays(const MultiDimImplementation< GUM_SCALAR >* t1,
468 const MultiDimImplementation< GUM_SCALAR >* t2,
469 const GUM_SCALAR (*f)(const GUM_SCALAR&, const GUM_SCALAR&));
470
471 // @}
472 // ==========================================================================
474 // ==========================================================================
476
495 template < typename GUM_SCALAR >
496 MultiDimFunctionGraph< GUM_SCALAR >*
497 projectMaxMultiDimFunctionGraph(const MultiDimFunctionGraph< GUM_SCALAR >* table,
498 const gum::VariableSet& del_vars);
499
518 template < typename GUM_SCALAR >
519 MultiDimImplementation< GUM_SCALAR >*
520 projectMaxMultiDimFunctionGraph(const MultiDimImplementation< GUM_SCALAR >* table,
521 const gum::VariableSet& del_vars);
522
523
542 template < typename GUM_SCALAR >
543 MultiDimFunctionGraph< GUM_SCALAR >*
544 projectMinMultiDimFunctionGraph(const MultiDimFunctionGraph< GUM_SCALAR >* table,
545 const gum::VariableSet& del_vars);
546
565 template < typename GUM_SCALAR >
566 MultiDimImplementation< GUM_SCALAR >*
567 projectMinMultiDimFunctionGraph(const MultiDimImplementation< GUM_SCALAR >* table,
568 const gum::VariableSet& del_vars);
569
570
589 template < typename GUM_SCALAR >
590 MultiDimFunctionGraph< GUM_SCALAR >*
591 projectSumMultiDimFunctionGraph(const MultiDimFunctionGraph< GUM_SCALAR >* table,
592 const gum::VariableSet& del_vars);
593
612 template < typename GUM_SCALAR >
613 MultiDimImplementation< GUM_SCALAR >*
614 projectSumMultiDimFunctionGraph(const MultiDimImplementation< GUM_SCALAR >* table,
615 const gum::VariableSet& del_vars);
616
617
636 template < typename GUM_SCALAR >
637 MultiDimFunctionGraph< GUM_SCALAR >*
638 projectProductMultiDimFunctionGraph(const MultiDimFunctionGraph< GUM_SCALAR >* table,
639 const gum::VariableSet& del_vars);
640
659 template < typename GUM_SCALAR >
660 MultiDimImplementation< GUM_SCALAR >*
661 projectProductMultiDimFunctionGraph(const MultiDimImplementation< GUM_SCALAR >* table,
662 const gum::VariableSet& del_vars);
663
665
667 template < typename GUM_SCALAR >
668 MultiDimImplementation< GUM_SCALAR >*
669 projectMax(const MultiDimImplementation< GUM_SCALAR >& table,
670 const gum::VariableSet& del_vars);
671
673 template < typename GUM_SCALAR >
674 MultiDimImplementation< GUM_SCALAR >*
675 projectMin(const MultiDimImplementation< GUM_SCALAR >& table,
676 const gum::VariableSet& del_vars);
677
679 template < typename GUM_SCALAR >
680 MultiDimImplementation< GUM_SCALAR >*
681 projectSum(const MultiDimImplementation< GUM_SCALAR >& table,
682 const gum::VariableSet& del_vars);
683
686 template < typename GUM_SCALAR >
687 MultiDimImplementation< GUM_SCALAR >*
688 projectProduct(const MultiDimImplementation< GUM_SCALAR >& table,
689 const gum::VariableSet& del_vars);
690
691
692 // ==========================================================================
693 // DO NOT FORGET TO REGISTER YOUR PROJECTION FUNCTIONS AT THE END OF FILE
694 // projections4MultiDim_tpl.h
695 // ==========================================================================
696
701 template < typename GUM_SCALAR >
702 void projections4MultiDimInit();
703
708 template < typename GUM_SCALAR >
709 void pointerProjections4MultiDimInit();
710
724 template < typename GUM_SCALAR >
728
743 template < typename GUM_SCALAR >
747
748} /* namespace gum */
749
750// always include the templatized implementations
751#include <agrum/base/multidim/utils/operators/projections4MultiDim_tpl.h>
752
753#endif /* GUM_PROJECTIONS_4_MULTI_DIM_H */
gum::MultiDimArray
Multidimensional matrix stored as an array in memory.
Definition multiDimArray.h:75
gum::MultiDimFunctionGraph
Class implementingting a function graph.
Definition multiDimFunctionGraph.h:92
gum::MultiDimImplementation
<agrum/base/multidim/multiDimImplementation.h>
Definition multiDimImplementation.h:85
gum::projectProductMultiDimArray
GUM_SCALAR projectProductMultiDimArray(const MultiDimArray< GUM_SCALAR > *table, Instantiation *instantiation=0)
a function for projecting a multiDimArray using a Product operator
gum::projectSumMultiDimArray
GUM_SCALAR projectSumMultiDimArray(const MultiDimArray< GUM_SCALAR > *table, Instantiation *instantiation=0)
a specialized function for projecting a multiDimArray using a Sum operator
gum::projectMaxMultiDimArray4Pointers
GUM_SCALAR * projectMaxMultiDimArray4Pointers(const MultiDimArray< GUM_SCALAR * > *table, Instantiation *instantiation=0)
A specialized function for projecting a multiDimArray using a Max operator.
gum::projectMinMultiDimArray
GUM_SCALAR projectMinMultiDimArray(const MultiDimArray< GUM_SCALAR > *table, Instantiation *instantiation=0)
A specialized function for projecting a multiDimArray using a Min operator.
gum::projectProductMultiDimArray4Pointers
GUM_SCALAR * projectProductMultiDimArray4Pointers(const MultiDimArray< GUM_SCALAR * > *table, Instantiation *instantiation=0)
a function for projecting a multiDimArray using a Product operator
gum::projectMaxMultiDimArray
GUM_SCALAR projectMaxMultiDimArray(const MultiDimArray< GUM_SCALAR > *table, Instantiation *instantiation=0)
A specialized function for projecting a multiDimArray using a Max operator.
gum::projectSumMultiDimArray4Pointers
GUM_SCALAR * projectSumMultiDimArray4Pointers(const MultiDimArray< GUM_SCALAR * > *table, Instantiation *instantiation=0)
a specialized function for projecting a multiDimArray using a Sum operator
gum::projectMinMultiDimArray4Pointers
GUM_SCALAR * projectMinMultiDimArray4Pointers(const MultiDimArray< GUM_SCALAR * > *table, Instantiation *instantiation=0)
A specialized function for projecting a multiDimArray using a Min operator.
multiDimArray.h
Header of the MultiDimArray class.
multiDimFunctionGraph.h
Headers of MultiDimFunctionGraph.
gum
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
gum::projectMinMultiDimFunctionGraph
MultiDimFunctionGraph< GUM_SCALAR > * projectMinMultiDimFunctionGraph(const MultiDimFunctionGraph< GUM_SCALAR > *table, const gum::VariableSet &del_vars)
a specialized function for projecting a multiDimFunctionGraph using a Min operator
gum::projectProduct
GUM_SCALAR projectProduct(const MultiDimImplementation< GUM_SCALAR > &table, Instantiation *instantiation=0)
the function to be used to project a MultiDimImplementation using a Product
gum::VariableSet
Set< const DiscreteVariable * > VariableSet
Definition discreteVariable.h:187
gum::projectMin
GUM_SCALAR projectMin(const MultiDimImplementation< GUM_SCALAR > &table, Instantiation *instantiation=0)
the function to be used to project a MultiDimImplementation using a Min
gum::projectMax
GUM_SCALAR projectMax(const MultiDimImplementation< GUM_SCALAR > &table, Instantiation *instantiation=0)
the function to be used to project a MultiDimImplementation using a Max
gum::projectProductMultiDimFunctionGraph
MultiDimFunctionGraph< GUM_SCALAR > * projectProductMultiDimFunctionGraph(const MultiDimFunctionGraph< GUM_SCALAR > *table, const gum::VariableSet &del_vars)
a specialized function for projecting a multiDimFunctionGraph using products
gum::projectMaxMultiDimFunctionGraph
MultiDimFunctionGraph< GUM_SCALAR > * projectMaxMultiDimFunctionGraph(const MultiDimFunctionGraph< GUM_SCALAR > *table, const gum::VariableSet &del_vars)
a specialized function for projecting a multiDimFunctionGraph using a Max operator
gum::ProjectFuncMultiDimArray
MultiDimArray< GUM_SCALAR > * ProjectFuncMultiDimArray(const MultiDimArray< GUM_SCALAR > *t1, const MultiDimArray< GUM_SCALAR > *t2, const GUM_SCALAR(*f)(const GUM_SCALAR &, const GUM_SCALAR &))
a specialized function for functionally projecting a multiDimArray
gum::projectSumMultiDimFunctionGraph
MultiDimFunctionGraph< GUM_SCALAR > * projectSumMultiDimFunctionGraph(const MultiDimFunctionGraph< GUM_SCALAR > *table, const gum::VariableSet &del_vars)
a specialized function for projecting a multiDimFunctionGraph using a summation
gum::combine2MultiDimArrays
MultiDimImplementation< GUM_SCALAR > * combine2MultiDimArrays(const MultiDimImplementation< GUM_SCALAR > *t1, const MultiDimImplementation< GUM_SCALAR > *t2, const GUM_SCALAR(*f)(const GUM_SCALAR &, const GUM_SCALAR &))
a specialized function for functionally projecting a multiDimArray
gum::projectSum
GUM_SCALAR projectSum(const MultiDimImplementation< GUM_SCALAR > &table, Instantiation *instantiation=0)
the function to be used to project a MultiDimImplementation using a sum
gum::pointerProjections4MultiDimInit
void pointerProjections4MultiDimInit()
the function used to register all the projections on multidimImplementations over pointers types.
gum::projections4MultiDimInit
void projections4MultiDimInit()
the function used to register all the projection operators on multidimImplementations over non-pointe...
projections4MultiDim_tpl.h
Efficient functionals for projecting multiDimensional tables.
gum::Projections4MultiDimInitialize< GUM_SCALAR * >::init
void init()
Definition projections4MultiDim.h:745
gum::Projections4MultiDimInitialize
a class used to register projections over non-pointers types
Definition projections4MultiDim.h:725
aGrUM 2.3.2

© PHW&CG&others - 2022
DoXyGeN 1.16.1