aGrUM  0.21.0
a C++ library for (probabilistic) graphical models
completeProjectionPattern4MultiDimArray.h
Go to the documentation of this file.
1 /**
2  *
3  * Copyright (c) 2005-2021 by Pierre-Henri WUILLEMIN(@LIP6) & Christophe GONZALES(@AMU)
4  * info_at_agrum_dot_org
5  *
6  * This library is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with this library. If not, see <http://www.gnu.org/licenses/>.
18  *
19  */
20 
21 
22 /**
23  * @file
24  * @brief the pattern used by all the projections of multidim tables over all
25  * their variables
26  *
27  * @author Christophe GONZALES(@AMU) and Pierre-Henri WUILLEMIN(@LIP6)
28  */
29 
30 // check if we allowed these patterns to be used
31 #ifndef GUM_COMPLETE_PROJECTION_PATTERN_ALLOWED
32 
33 // #warning To use completeProjectionPattern, you must define
34 // GUM_COMPLETE_PROJECTION_PATTERN_ALLOWED
35 
36 #else
37 namespace gum {
38 
39  // a specialized function for projecting a multiDimArray over all its variables
40 
41 # ifdef GUM_MULTI_DIM_COMPLETE_PROJECTION_NAME
42 # define GUM_MULTI_DIM_COMPLETE_PROJECTION_TYPE GUM_SCALAR
43  template < typename GUM_SCALAR >
44  GUM_SCALAR GUM_MULTI_DIM_COMPLETE_PROJECTION_NAME(const MultiDimArray< GUM_SCALAR >* table,
45  Instantiation* instantiation)
46 # endif
47 
48  // clang-format off
49 
50 #ifdef GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER_NAME
51 #define GUM_MULTI_DIM_COMPLETE_PROJECTION_TYPE GUM_SCALAR *
52 #define GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER
53  template <typename GUM_SCALAR>
54  GUM_SCALAR* GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER_NAME(
55  const MultiDimArray<GUM_SCALAR*>* table,
56  Instantiation* instantiation )
57 #endif
58 
59 #ifdef GUM_MULTI_DIM_COMPLETE_PROJECTION_NAME_F
60 #define GUM_MULTI_DIM_COMPLETE_PROJECTION_TYPE GUM_SCALAR
61  template <typename GUM_SCALAR>
62  GUM_SCALAR GUM_MULTI_DIM_COMPLETE_PROJECTION_NAME_F(
63  const MultiDimArray<GUM_SCALAR>* table,
64  GUM_SCALAR ( *f )( const GUM_SCALAR&,
65  const GUM_SCALAR& ),
66  Instantiation* instantiation )
67 #endif
68 
69 #ifdef GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER_NAME_F
70 #define GUM_MULTI_DIM_COMPLETE_PROJECTION_TYPE GUM_SCALAR *
71 #define GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER
72  template <typename GUM_SCALAR>
73  GUM_SCALAR* GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER_NAME_F(
74  const MultiDimArray<GUM_SCALAR*>* table,
75  GUM_SCALAR* ( *f )( const GUM_SCALAR const*,
76  const GUM_SCALAR const* ),
77  Instantiation* instantiation )
78 #endif
79 
80 #ifdef GUM_MULTI_DIM_COMPLETE_PROJECTION_IMPL2ARRAY_NAME
81 #define GUM_MULTI_DIM_COMPLETE_PROJECTION_TYPE GUM_SCALAR
82  template <typename GUM_SCALAR>
83  GUM_SCALAR GUM_MULTI_DIM_COMPLETE_PROJECTION_IMPL2ARRAY_NAME(
84  const MultiDimImplementation<GUM_SCALAR>* ttable,
85  Instantiation* instantiation )
86 #endif
87 
88 #ifdef GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER_IMPL2ARRAY_NAME
89 #define GUM_MULTI_DIM_COMPLETE_PROJECTION_TYPE GUM_SCALAR *
90 #define GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER
91  template <typename GUM_SCALAR>
92  GUM_SCALAR*
93  GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER_IMPL2ARRAY_NAME(
94  const MultiDimImplementation<GUM_SCALAR*>* ttable,
95  Instantiation* instantiation )
96 #endif
97 
98  // clang-format on
99 
100  {
101 
102 # ifdef GUM_MULTI_DIM_COMPLETE_PROJECTION_IMPL2ARRAY_NAME
103  const auto table = reinterpret_cast< const MultiDimArray< GUM_SCALAR >* >(ttable);
104 # endif
105 
106 # ifdef GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER_IMPL2ARRAY_NAME
107  const auto table = reinterpret_cast< const MultiDimArray< GUM_SCALAR* >* >(ttable);
108 # endif
109 
110  // first, compute the domain size of the table:
111  Size nb_elt = table->domainSize();
112 
113  // now, parse the table and compute the projection. Start with the
114  // neutral element
115  GUM_MULTI_DIM_COMPLETE_PROJECTION_TYPE* ptable
116  = const_cast< GUM_MULTI_DIM_COMPLETE_PROJECTION_TYPE* >(&(table->unsafeGet(0)));
117  GUM_SCALAR current_val = GUM_MULTI_DIM_COMPLETE_PROJECTION_NEUTRAL;
118 
119  if (instantiation) {
120  GUM_SCALAR old_val = current_val;
121  GUM_MULTI_DIM_COMPLETE_PROJECTION_TYPE* current_ptr = ptable;
122  GUM_MULTI_DIM_COMPLETE_PROJECTION_TYPE* deb_ptr = ptable;
123 
124  for (Size i = 0; i < nb_elt; ++i, ++ptable) {
125 # ifdef GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER
126  GUM_MULTI_DIM_COMPLETE_PROJECTION(&current_val, *ptable);
127 # else
128  GUM_MULTI_DIM_COMPLETE_PROJECTION(current_val, *ptable);
129 # endif
130 
131  if (current_val != old_val) {
132  old_val = current_val;
133  current_ptr = ptable;
134  }
135  }
136 
137  // put the table's variables into the instantiation
138  instantiation->forgetMaster();
139  instantiation->clear();
140  const Sequence< const DiscreteVariable* >& table_vars = table->variablesSequence();
141 
142  for (const auto var: table_vars)
143  instantiation->add(*var);
144 
145  // return the result
146  table->fromOffset(*instantiation, Size(current_ptr - deb_ptr));
147 # ifdef GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER
148  return *current_ptr;
149 # else
150  return current_val;
151 # endif /* GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER */
152  } else {
153 # ifdef GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER
154  GUM_SCALAR old_val = current_val;
155  GUM_MULTI_DIM_COMPLETE_PROJECTION_TYPE* current_ptr = ptable;
156 
157  for (Size i = 0; i < nb_elt; ++i, ++ptable) {
158  GUM_MULTI_DIM_COMPLETE_PROJECTION(&current_val, *ptable);
159 
160  if (current_val != old_val) {
161  old_val = current_val;
162  current_ptr = ptable;
163  }
164  }
165 
166  return *current_ptr;
167 # else
168 
169  for (Size i = 0; i < nb_elt; ++i, ++ptable) {
170  GUM_MULTI_DIM_COMPLETE_PROJECTION(current_val, *ptable);
171  }
172 
173  return current_val;
174 # endif /* GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER */
175  }
176  }
177 
178 # undef GUM_MULTI_DIM_COMPLETE_PROJECTION_TYPE
179 
180 # ifdef GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER
181 # undef GUM_MULTI_DIM_COMPLETE_PROJECTION_POINTER
182 # endif
183 
184 } /* End of namespace gum */
185 
186 #endif /* GUM_COMPLETE_PROJECTION_PATTERN_ALLOWED */
aGrUM 0.21.0
Sat Jul 24 2021 11:12:28
© PHW&CG&others - 2021
DoXyGeN 1.8.13