aGrUM 2.3.2
a C++ library for (probabilistic) graphical models
partialInstantiationPattern4MultiDimImplementation.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
50
51// check if we allowed these patterns to be used
52#ifndef GUM_PARTIAL_INSTANTIATION_PATTERN_ALLOWED
53
54// #warning To use partialIntantiationPattern4MultiDimImplementation.h, you must
55// define GUM_PARTIAL_INSTANTIATION_PATTERN_ALLOWED
56
57#else
58namespace gum {
59
60# ifdef GUM_MULTI_DIM_PARTIAL_INSTANTIATION_NAME
61 template < typename GUM_SCALAR >
65# endif
66
68
69 // get the appropriate function to perform the operation
70 try {
71 // try to find func(ttable,inst_vars) in the register
72 func
74 } catch (NotFound const&) {
76 ttable.basename());
77 }
78
79 // perform the partial instantiation
80 return func(&ttable, inst_vars);
81 }
82
83} /* End of namespace gum */
84
85#endif /* GUM_PARTIAL_INSTANTIATION_PATTERN_ALLOWED */
The class for generic Hash Tables.
Definition hashTable.h:637
<agrum/base/multidim/multiDimImplementation.h>
static PartialInstantiationRegister4MultiDim & Register()
A named constructor that constructs one and only one Register per data type.
MultiDimImplementation< GUM_SCALAR > *(*)(const MultiDimImplementation< GUM_SCALAR > *, const HashTable< const DiscreteVariable *, Idx > &) PartialInstantiationPtr
The type of functions used by the register.
PartialInstantiationPtr get(const std::string &instantiation_func_name, const std::string &type_multidim) const
Returns the specialized partial instantiation operator assigned to a given type of MultiDimImplementa...
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
#define GUM_MULTI_DIM_PARTIAL_INSTANTIATION_NAME
a specialized partial instantiation function for multiDimArrays