aGrUM 2.3.2
a C++ library for (probabilistic) graphical models
operators4MultiDim.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_OPERATORS_4_MULTI_DIM_H
50#define GUM_OPERATORS_4_MULTI_DIM_H
51
52#include <atomic>
53#include <mutex>
54
55#include <agrum/base/core/timer.h>
56#include <agrum/base/multidim/implementations/multiDimArray.h>
57#include <agrum/base/multidim/implementations/multiDimFunctionGraph.h>
58
59namespace gum {
60
61 // ==========================================================================
63 // ==========================================================================
65
82 template < typename T >
83 MultiDimArray< T >* add2MultiDimArrays(const MultiDimArray< T >* t1,
84 const MultiDimArray< T >* t2);
85
102 template < typename T >
103 MultiDimImplementation< T >* add2MultiDimArrays(const MultiDimImplementation< T >* t1,
104 const MultiDimImplementation< T >* t2);
105
122 template < typename T >
123 MultiDimArray< T* >* add2MultiDimArrays4Pointers(const MultiDimArray< T* >* t1,
124 const MultiDimArray< T* >* t2);
125
142 template < typename T >
143 MultiDimImplementation< T* >* add2MultiDimArrays4Pointers(const MultiDimImplementation< T* >* t1,
144 const MultiDimImplementation< T* >* t2);
145
162 template < typename T >
163 MultiDimFunctionGraph< T >* add2MultiDimFunctionGraphs(const MultiDimFunctionGraph< T >* t1,
164 const MultiDimFunctionGraph< T >* t2);
165
182 template < typename T >
183 MultiDimImplementation< T >* add2MultiDimFunctionGraphs(const MultiDimImplementation< T >* t1,
184 const MultiDimImplementation< T >* t2);
185
187 // ==========================================================================
189 // ==========================================================================
191
208 template < typename T >
209 MultiDimArray< T >* subtract2MultiDimArrays(const MultiDimArray< T >* t1,
210 const MultiDimArray< T >* t2);
211
228 template < typename T >
229 MultiDimImplementation< T >* subtract2MultiDimArrays(const MultiDimImplementation< T >* t1,
230 const MultiDimImplementation< T >* t2);
231
248 template < typename T >
249 MultiDimArray< T* >* subtract2MultiDimArrays4Pointers(const MultiDimArray< T* >* t1,
250 const MultiDimArray< T* >* t2);
251
268 template < typename T >
269 MultiDimImplementation< T* >*
270 subtract2MultiDimArrays4Pointers(const MultiDimImplementation< T* >* t1,
271 const MultiDimImplementation< T* >* t2);
272
289 template < typename T >
290 MultiDimFunctionGraph< T >* subtract2MultiDimFunctionGraphs(const MultiDimFunctionGraph< T >* t1,
291 const MultiDimFunctionGraph< T >* t2);
292
309 template < typename T >
310 MultiDimImplementation< T >*
311 subtract2MultiDimFunctionGraphs(const MultiDimImplementation< T >* t1,
312 const MultiDimImplementation< T >* t2);
313
315 // ==========================================================================
317 // ==========================================================================
319
336 template < typename T >
337 MultiDimArray< T >* multiply2MultiDimArrays(const MultiDimArray< T >* t1,
338 const MultiDimArray< T >* t2);
339
356 template < typename T >
357 MultiDimImplementation< T >* multiply2MultiDimArrays(const MultiDimImplementation< T >* t1,
358 const MultiDimImplementation< T >* t2);
359
376 template < typename T >
377 MultiDimArray< T* >* multiply2MultiDimArrays4Pointers(const MultiDimArray< T* >* t1,
378 const MultiDimArray< T* >* t2);
379
396 template < typename T >
397 MultiDimImplementation< T* >*
398 multiply2MultiDimArrays4Pointers(const MultiDimImplementation< T* >* t1,
399 const MultiDimImplementation< T* >* t2);
400
417 template < typename T >
418 MultiDimFunctionGraph< T >* multiply2MultiDimFunctionGraphs(const MultiDimFunctionGraph< T >* t1,
419 const MultiDimFunctionGraph< T >* t2);
420
437 template < typename T >
438 MultiDimImplementation< T >*
439 multiply2MultiDimFunctionGraphs(const MultiDimImplementation< T >* t1,
440 const MultiDimImplementation< T >* t2);
441
443 // ==========================================================================
445 // ==========================================================================
447
464 template < typename T >
465 MultiDimArray< T >* divide2MultiDimArrays(const MultiDimArray< T >* t1,
466 const MultiDimArray< T >* t2);
467
484 template < typename T >
485 MultiDimImplementation< T >* divide2MultiDimArrays(const MultiDimImplementation< T >* t1,
486 const MultiDimImplementation< T >* t2);
487
504 template < typename T >
505 MultiDimArray< T* >* divide2MultiDimArrays4Pointers(const MultiDimArray< T* >* t1,
506 const MultiDimArray< T* >* t2);
507
524 template < typename T >
525 MultiDimImplementation< T* >*
526 divide2MultiDimArrays4Pointers(const MultiDimImplementation< T* >* t1,
527 const MultiDimImplementation< T* >* t2);
528
545 template < typename T >
546 MultiDimFunctionGraph< T >* divide2MultiDimFunctionGraphs(const MultiDimFunctionGraph< T >* t1,
547 const MultiDimFunctionGraph< T >* t2);
548
565 template < typename T >
566 MultiDimImplementation< T >* divide2MultiDimFunctionGraphs(const MultiDimImplementation< T >* t1,
567 const MultiDimImplementation< T >* t2);
568
570 // ==========================================================================
572 // ==========================================================================
574
589 template < typename T >
590 MultiDimFunctionGraph< T >* maximise2MultiDimFunctionGraphs(const MultiDimFunctionGraph< T >* t1,
591 const MultiDimFunctionGraph< T >* t2);
592
607 template < typename T >
608 MultiDimImplementation< T >*
609 maximise2MultiDimFunctionGraphs(const MultiDimImplementation< T >* t1,
610 const MultiDimImplementation< T >* t2);
611
613 // ==========================================================================
615 // ==========================================================================
617
620 template < typename T >
621 MultiDimImplementation< T >* operator+(const MultiDimImplementation< T >&,
622 const MultiDimImplementation< T >&);
623
626 template < typename T >
627 MultiDimImplementation< T >* operator-(const MultiDimImplementation< T >&,
628 const MultiDimImplementation< T >&);
629
632 template < typename T >
633 MultiDimImplementation< T >* operator*(const MultiDimImplementation< T >&,
634 const MultiDimImplementation< T >&);
635
638 template < typename T >
639 MultiDimImplementation< T >* operator/(const MultiDimImplementation< T >&,
640 const MultiDimImplementation< T >&);
641
643
644 // ==========================================================================
645 // DO NOT FORGET TO REGISTER YOUR BINARY FUNCTIONS AT THE END OF FILE
646 // operators4MultiDim_tpl.h
647 // ==========================================================================
648
654 template < typename GUM_SCALAR >
655 void operators4MultiDimInit();
656
662 template < typename GUM_SCALAR >
663 void pointerOperators4MultiDimInit();
664
679 template < typename GUM_SCALAR >
683
699 template < typename GUM_SCALAR >
703
705
706} /* namespace gum */
707
708// always include the templatized implementations
709#include <agrum/base/multidim/utils/operators/operators4MultiDim_tpl.h>
710
711#endif /* GUM_OPERATORS_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::operators4MultiDimInit
void operators4MultiDimInit()
the function used to register all the operators on multidimImplementations over non-pointers types.
gum::multiply2MultiDimArrays4Pointers
MultiDimArray< T * > * multiply2MultiDimArrays4Pointers(const MultiDimArray< T * > *t1, const MultiDimArray< T * > *t2)
a specialized function for multiplying two multiDimArrays
gum::subtract2MultiDimArrays
MultiDimArray< T > * subtract2MultiDimArrays(const MultiDimArray< T > *t1, const MultiDimArray< T > *t2)
a specialized function for subtracting two multiDimArrays
gum::divide2MultiDimArrays
MultiDimArray< T > * divide2MultiDimArrays(const MultiDimArray< T > *t1, const MultiDimArray< T > *t2)
a specialized function for dividing two multiDimArrays
gum::pointerOperators4MultiDimInit
void pointerOperators4MultiDimInit()
the function used to register all the operators on multidimImplementations over pointers types.
gum::divide2MultiDimFunctionGraphs
MultiDimFunctionGraph< T > * divide2MultiDimFunctionGraphs(const MultiDimFunctionGraph< T > *t1, const MultiDimFunctionGraph< T > *t2)
a specialized function for dividing two multiDimArrays
gum::divide2MultiDimArrays4Pointers
MultiDimArray< T * > * divide2MultiDimArrays4Pointers(const MultiDimArray< T * > *t1, const MultiDimArray< T * > *t2)
a specialized function for dividing two multiDimArrays
gum::add2MultiDimArrays
MultiDimArray< T > * add2MultiDimArrays(const MultiDimArray< T > *t1, const MultiDimArray< T > *t2)
a specialized function for summing two multiDimArrays
gum::subtract2MultiDimArrays4Pointers
MultiDimArray< T * > * subtract2MultiDimArrays4Pointers(const MultiDimArray< T * > *t1, const MultiDimArray< T * > *t2)
a specialized function for subtracting two multiDimArrays
gum::maximise2MultiDimFunctionGraphs
MultiDimFunctionGraph< T > * maximise2MultiDimFunctionGraphs(const MultiDimFunctionGraph< T > *t1, const MultiDimFunctionGraph< T > *t2)
a specialized function for compare value from two multiDimFunctionGraphs and gets the maximal
gum::multiply2MultiDimFunctionGraphs
MultiDimFunctionGraph< T > * multiply2MultiDimFunctionGraphs(const MultiDimFunctionGraph< T > *t1, const MultiDimFunctionGraph< T > *t2)
a specialized function for multiplying two multiDimArrays
gum::subtract2MultiDimFunctionGraphs
MultiDimFunctionGraph< T > * subtract2MultiDimFunctionGraphs(const MultiDimFunctionGraph< T > *t1, const MultiDimFunctionGraph< T > *t2)
a specialized function for subtracting two multiDimArrays
gum::add2MultiDimArrays4Pointers
MultiDimArray< T * > * add2MultiDimArrays4Pointers(const MultiDimArray< T * > *t1, const MultiDimArray< T * > *t2)
a specialized function for summing two multiDimArrays
gum::multiply2MultiDimArrays
MultiDimArray< T > * multiply2MultiDimArrays(const MultiDimArray< T > *t1, const MultiDimArray< T > *t2)
a specialized function for multiplying two multiDimArrays
gum::add2MultiDimFunctionGraphs
MultiDimFunctionGraph< T > * add2MultiDimFunctionGraphs(const MultiDimFunctionGraph< T > *t1, const MultiDimFunctionGraph< T > *t2)
a specialized function for summing two multiDimArrays
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::operator*
value_type & operator*()
Returns the value pointed to by the iterator.
gum::operator/
Formula operator/(const Formula &a, const Formula &b)
Definition formula_inl.h:490
gum::operator+
HashTableIteratorSafe< Key, Val > operator+(Size i) const
Returns a new iterator pointing to i elements further in the hashtable.
gum::operator-
ListConstIterator< Val >::difference_type operator-(const ListConstIterator< Val > &iter1, const ListConstIterator< Val > &iter2)
For STL compliance, a distance operator.
Definition list_tpl.h:349
operators4MultiDim_tpl.h
Efficient functionals for combining multiDims.
gum::Operators4MultiDimInitialize< GUM_SCALAR * >::init
void init()
Definition operators4MultiDim.h:701
gum::Operators4MultiDimInitialize
a class used to register operators over non-pointers types
Definition operators4MultiDim.h:680
timer.h
Class used to compute response times for benchmark purposes.
aGrUM 2.3.2

© PHW&CG&others - 2022
DoXyGeN 1.16.1