multipers 2.2.3__cp310-cp310-win_amd64.whl → 2.3.0__cp310-cp310-win_amd64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of multipers might be problematic. Click here for more details.

Files changed (182) hide show
  1. multipers/__init__.py +33 -31
  2. multipers/_signed_measure_meta.py +430 -430
  3. multipers/_slicer_meta.py +211 -212
  4. multipers/data/MOL2.py +458 -458
  5. multipers/data/UCR.py +18 -18
  6. multipers/data/graphs.py +466 -466
  7. multipers/data/immuno_regions.py +27 -27
  8. multipers/data/pytorch2simplextree.py +90 -90
  9. multipers/data/shape3d.py +101 -101
  10. multipers/data/synthetic.py +113 -111
  11. multipers/distances.py +198 -198
  12. multipers/filtration_conversions.pxd.tp +84 -84
  13. multipers/filtrations/__init__.py +18 -0
  14. multipers/filtrations/filtrations.py +289 -0
  15. multipers/filtrations.pxd +224 -224
  16. multipers/function_rips.cp310-win_amd64.pyd +0 -0
  17. multipers/function_rips.pyx +105 -105
  18. multipers/grids.cp310-win_amd64.pyd +0 -0
  19. multipers/grids.pyx +350 -350
  20. multipers/gudhi/Persistence_slices_interface.h +132 -132
  21. multipers/gudhi/Simplex_tree_interface.h +239 -245
  22. multipers/gudhi/Simplex_tree_multi_interface.h +516 -561
  23. multipers/gudhi/cubical_to_boundary.h +59 -59
  24. multipers/gudhi/gudhi/Bitmap_cubical_complex.h +450 -450
  25. multipers/gudhi/gudhi/Bitmap_cubical_complex_base.h +1070 -1070
  26. multipers/gudhi/gudhi/Bitmap_cubical_complex_periodic_boundary_conditions_base.h +579 -579
  27. multipers/gudhi/gudhi/Debug_utils.h +45 -45
  28. multipers/gudhi/gudhi/Fields/Multi_field.h +484 -484
  29. multipers/gudhi/gudhi/Fields/Multi_field_operators.h +455 -455
  30. multipers/gudhi/gudhi/Fields/Multi_field_shared.h +450 -450
  31. multipers/gudhi/gudhi/Fields/Multi_field_small.h +531 -531
  32. multipers/gudhi/gudhi/Fields/Multi_field_small_operators.h +507 -507
  33. multipers/gudhi/gudhi/Fields/Multi_field_small_shared.h +531 -531
  34. multipers/gudhi/gudhi/Fields/Z2_field.h +355 -355
  35. multipers/gudhi/gudhi/Fields/Z2_field_operators.h +376 -376
  36. multipers/gudhi/gudhi/Fields/Zp_field.h +420 -420
  37. multipers/gudhi/gudhi/Fields/Zp_field_operators.h +400 -400
  38. multipers/gudhi/gudhi/Fields/Zp_field_shared.h +418 -418
  39. multipers/gudhi/gudhi/Flag_complex_edge_collapser.h +337 -337
  40. multipers/gudhi/gudhi/Matrix.h +2107 -2107
  41. multipers/gudhi/gudhi/Multi_critical_filtration.h +1038 -1038
  42. multipers/gudhi/gudhi/Multi_persistence/Box.h +171 -171
  43. multipers/gudhi/gudhi/Multi_persistence/Line.h +282 -282
  44. multipers/gudhi/gudhi/Off_reader.h +173 -173
  45. multipers/gudhi/gudhi/One_critical_filtration.h +1432 -1431
  46. multipers/gudhi/gudhi/Persistence_matrix/Base_matrix.h +769 -769
  47. multipers/gudhi/gudhi/Persistence_matrix/Base_matrix_with_column_compression.h +686 -686
  48. multipers/gudhi/gudhi/Persistence_matrix/Boundary_matrix.h +842 -842
  49. multipers/gudhi/gudhi/Persistence_matrix/Chain_matrix.h +1350 -1350
  50. multipers/gudhi/gudhi/Persistence_matrix/Id_to_index_overlay.h +1105 -1105
  51. multipers/gudhi/gudhi/Persistence_matrix/Position_to_index_overlay.h +859 -859
  52. multipers/gudhi/gudhi/Persistence_matrix/RU_matrix.h +910 -910
  53. multipers/gudhi/gudhi/Persistence_matrix/allocators/entry_constructors.h +139 -139
  54. multipers/gudhi/gudhi/Persistence_matrix/base_pairing.h +230 -230
  55. multipers/gudhi/gudhi/Persistence_matrix/base_swap.h +211 -211
  56. multipers/gudhi/gudhi/Persistence_matrix/boundary_cell_position_to_id_mapper.h +60 -60
  57. multipers/gudhi/gudhi/Persistence_matrix/boundary_face_position_to_id_mapper.h +60 -60
  58. multipers/gudhi/gudhi/Persistence_matrix/chain_pairing.h +136 -136
  59. multipers/gudhi/gudhi/Persistence_matrix/chain_rep_cycles.h +190 -190
  60. multipers/gudhi/gudhi/Persistence_matrix/chain_vine_swap.h +616 -616
  61. multipers/gudhi/gudhi/Persistence_matrix/columns/chain_column_extra_properties.h +150 -150
  62. multipers/gudhi/gudhi/Persistence_matrix/columns/column_dimension_holder.h +106 -106
  63. multipers/gudhi/gudhi/Persistence_matrix/columns/column_utilities.h +219 -219
  64. multipers/gudhi/gudhi/Persistence_matrix/columns/entry_types.h +327 -327
  65. multipers/gudhi/gudhi/Persistence_matrix/columns/heap_column.h +1140 -1140
  66. multipers/gudhi/gudhi/Persistence_matrix/columns/intrusive_list_column.h +934 -934
  67. multipers/gudhi/gudhi/Persistence_matrix/columns/intrusive_set_column.h +934 -934
  68. multipers/gudhi/gudhi/Persistence_matrix/columns/list_column.h +980 -980
  69. multipers/gudhi/gudhi/Persistence_matrix/columns/naive_vector_column.h +1092 -1092
  70. multipers/gudhi/gudhi/Persistence_matrix/columns/row_access.h +192 -192
  71. multipers/gudhi/gudhi/Persistence_matrix/columns/set_column.h +921 -921
  72. multipers/gudhi/gudhi/Persistence_matrix/columns/small_vector_column.h +1093 -1093
  73. multipers/gudhi/gudhi/Persistence_matrix/columns/unordered_set_column.h +1012 -1012
  74. multipers/gudhi/gudhi/Persistence_matrix/columns/vector_column.h +1244 -1244
  75. multipers/gudhi/gudhi/Persistence_matrix/matrix_dimension_holders.h +186 -186
  76. multipers/gudhi/gudhi/Persistence_matrix/matrix_row_access.h +164 -164
  77. multipers/gudhi/gudhi/Persistence_matrix/ru_pairing.h +156 -156
  78. multipers/gudhi/gudhi/Persistence_matrix/ru_rep_cycles.h +376 -376
  79. multipers/gudhi/gudhi/Persistence_matrix/ru_vine_swap.h +540 -540
  80. multipers/gudhi/gudhi/Persistent_cohomology/Field_Zp.h +118 -118
  81. multipers/gudhi/gudhi/Persistent_cohomology/Multi_field.h +173 -173
  82. multipers/gudhi/gudhi/Persistent_cohomology/Persistent_cohomology_column.h +128 -128
  83. multipers/gudhi/gudhi/Persistent_cohomology.h +745 -745
  84. multipers/gudhi/gudhi/Points_off_io.h +171 -171
  85. multipers/gudhi/gudhi/Simple_object_pool.h +69 -69
  86. multipers/gudhi/gudhi/Simplex_tree/Simplex_tree_iterators.h +463 -463
  87. multipers/gudhi/gudhi/Simplex_tree/Simplex_tree_node_explicit_storage.h +83 -83
  88. multipers/gudhi/gudhi/Simplex_tree/Simplex_tree_siblings.h +106 -106
  89. multipers/gudhi/gudhi/Simplex_tree/Simplex_tree_star_simplex_iterators.h +277 -277
  90. multipers/gudhi/gudhi/Simplex_tree/hooks_simplex_base.h +62 -62
  91. multipers/gudhi/gudhi/Simplex_tree/indexing_tag.h +27 -27
  92. multipers/gudhi/gudhi/Simplex_tree/serialization_utils.h +62 -62
  93. multipers/gudhi/gudhi/Simplex_tree/simplex_tree_options.h +157 -157
  94. multipers/gudhi/gudhi/Simplex_tree.h +2794 -2794
  95. multipers/gudhi/gudhi/Simplex_tree_multi.h +152 -163
  96. multipers/gudhi/gudhi/distance_functions.h +62 -62
  97. multipers/gudhi/gudhi/graph_simplicial_complex.h +104 -104
  98. multipers/gudhi/gudhi/persistence_interval.h +253 -253
  99. multipers/gudhi/gudhi/persistence_matrix_options.h +170 -170
  100. multipers/gudhi/gudhi/reader_utils.h +367 -367
  101. multipers/gudhi/mma_interface_coh.h +256 -255
  102. multipers/gudhi/mma_interface_h0.h +223 -231
  103. multipers/gudhi/mma_interface_matrix.h +284 -282
  104. multipers/gudhi/naive_merge_tree.h +536 -575
  105. multipers/gudhi/scc_io.h +310 -289
  106. multipers/gudhi/truc.h +890 -888
  107. multipers/io.cp310-win_amd64.pyd +0 -0
  108. multipers/io.pyx +711 -711
  109. multipers/ml/accuracies.py +90 -90
  110. multipers/ml/convolutions.py +520 -520
  111. multipers/ml/invariants_with_persistable.py +79 -79
  112. multipers/ml/kernels.py +176 -176
  113. multipers/ml/mma.py +713 -714
  114. multipers/ml/one.py +472 -472
  115. multipers/ml/point_clouds.py +352 -346
  116. multipers/ml/signed_measures.py +1589 -1589
  117. multipers/ml/sliced_wasserstein.py +461 -461
  118. multipers/ml/tools.py +113 -113
  119. multipers/mma_structures.cp310-win_amd64.pyd +0 -0
  120. multipers/mma_structures.pxd +127 -127
  121. multipers/mma_structures.pyx +4 -4
  122. multipers/mma_structures.pyx.tp +1085 -1085
  123. multipers/multi_parameter_rank_invariant/diff_helpers.h +84 -93
  124. multipers/multi_parameter_rank_invariant/euler_characteristic.h +97 -97
  125. multipers/multi_parameter_rank_invariant/function_rips.h +322 -322
  126. multipers/multi_parameter_rank_invariant/hilbert_function.h +769 -769
  127. multipers/multi_parameter_rank_invariant/persistence_slices.h +148 -148
  128. multipers/multi_parameter_rank_invariant/rank_invariant.h +369 -369
  129. multipers/multiparameter_edge_collapse.py +41 -41
  130. multipers/multiparameter_module_approximation/approximation.h +2296 -2295
  131. multipers/multiparameter_module_approximation/combinatory.h +129 -129
  132. multipers/multiparameter_module_approximation/debug.h +107 -107
  133. multipers/multiparameter_module_approximation/format_python-cpp.h +286 -286
  134. multipers/multiparameter_module_approximation/heap_column.h +238 -238
  135. multipers/multiparameter_module_approximation/images.h +79 -79
  136. multipers/multiparameter_module_approximation/list_column.h +174 -174
  137. multipers/multiparameter_module_approximation/list_column_2.h +232 -232
  138. multipers/multiparameter_module_approximation/ru_matrix.h +347 -347
  139. multipers/multiparameter_module_approximation/set_column.h +135 -135
  140. multipers/multiparameter_module_approximation/structure_higher_dim_barcode.h +36 -36
  141. multipers/multiparameter_module_approximation/unordered_set_column.h +166 -166
  142. multipers/multiparameter_module_approximation/utilities.h +403 -419
  143. multipers/multiparameter_module_approximation/vector_column.h +223 -223
  144. multipers/multiparameter_module_approximation/vector_matrix.h +331 -331
  145. multipers/multiparameter_module_approximation/vineyards.h +464 -464
  146. multipers/multiparameter_module_approximation/vineyards_trajectories.h +649 -649
  147. multipers/multiparameter_module_approximation.cp310-win_amd64.pyd +0 -0
  148. multipers/multiparameter_module_approximation.pyx +216 -217
  149. multipers/pickle.py +90 -53
  150. multipers/plots.py +342 -334
  151. multipers/point_measure.cp310-win_amd64.pyd +0 -0
  152. multipers/point_measure.pyx +322 -320
  153. multipers/simplex_tree_multi.cp310-win_amd64.pyd +0 -0
  154. multipers/simplex_tree_multi.pxd +133 -133
  155. multipers/simplex_tree_multi.pyx +18 -15
  156. multipers/simplex_tree_multi.pyx.tp +1939 -1935
  157. multipers/slicer.cp310-win_amd64.pyd +0 -0
  158. multipers/slicer.pxd +81 -20
  159. multipers/slicer.pxd.tp +215 -214
  160. multipers/slicer.pyx +1091 -308
  161. multipers/slicer.pyx.tp +924 -914
  162. multipers/tensor/tensor.h +672 -672
  163. multipers/tensor.pxd +13 -13
  164. multipers/test.pyx +44 -44
  165. multipers/tests/__init__.py +57 -57
  166. multipers/torch/diff_grids.py +217 -217
  167. multipers/torch/rips_density.py +310 -304
  168. {multipers-2.2.3.dist-info → multipers-2.3.0.dist-info}/LICENSE +21 -21
  169. {multipers-2.2.3.dist-info → multipers-2.3.0.dist-info}/METADATA +21 -11
  170. multipers-2.3.0.dist-info/RECORD +182 -0
  171. multipers/tests/test_diff_helper.py +0 -73
  172. multipers/tests/test_hilbert_function.py +0 -82
  173. multipers/tests/test_mma.py +0 -83
  174. multipers/tests/test_point_clouds.py +0 -49
  175. multipers/tests/test_python-cpp_conversion.py +0 -82
  176. multipers/tests/test_signed_betti.py +0 -181
  177. multipers/tests/test_signed_measure.py +0 -89
  178. multipers/tests/test_simplextreemulti.py +0 -221
  179. multipers/tests/test_slicer.py +0 -221
  180. multipers-2.2.3.dist-info/RECORD +0 -189
  181. {multipers-2.2.3.dist-info → multipers-2.3.0.dist-info}/WHEEL +0 -0
  182. {multipers-2.2.3.dist-info → multipers-2.3.0.dist-info}/top_level.txt +0 -0
@@ -1,531 +1,531 @@
1
- /* This file is part of the Gudhi Library - https://gudhi.inria.fr/ - which is released under MIT.
2
- * See file LICENSE or go to https://gudhi.inria.fr/licensing/ for full license details.
3
- * Author(s): Hannah Schreiber, Clément Maria
4
- *
5
- * Copyright (C) 2022-24 Inria
6
- *
7
- * Modification(s):
8
- * - YYYY/MM Author: Description of the modification
9
- */
10
-
11
- /**
12
- * @file Multi_field_small_shared.h
13
- * @author Hannah Schreiber, Clément Maria
14
- * @brief Contains the @ref Gudhi::persistence_fields::Shared_multi_field_element_with_small_characteristics class.
15
- */
16
-
17
- #ifndef MATRIX_FIELD_MULTI_SMALL_SHARED_H_
18
- #define MATRIX_FIELD_MULTI_SMALL_SHARED_H_
19
-
20
- #include <utility>
21
- #include <vector>
22
- #include <limits.h>
23
- #include <stdexcept>
24
- #include <numeric>
25
-
26
- namespace Gudhi {
27
- namespace persistence_fields {
28
-
29
- /**
30
- * @class Shared_multi_field_element_with_small_characteristics Multi_field_small_shared.h \
31
- * gudhi/Fields/Multi_field_small_shared.h
32
- * @ingroup persistence_fields
33
- *
34
- * @brief Class representing an element of a multi-field, such that `productOfAllCharacteristics ^ 2` fits into
35
- * the given @p Unsigned_integer_type template argument. If each instantiation of the class can represent another
36
- * element, they all share the same characteristics. That is if the characteristics are set for one, they will be
37
- * set for all the others. The characteristics can be set before instantiating the elements with the static
38
- * @ref Shared_multi_field_element_with_small_characteristics::initialize method.
39
- *
40
- * @tparam Unsigned_integer_type A native unsigned integer type: unsigned int, long unsigned int, etc.
41
- * Will be used as the field element type.
42
- */
43
- template <typename Unsigned_integer_type = unsigned int,
44
- class = std::enable_if_t<std::is_unsigned_v<Unsigned_integer_type> > >
45
- class Shared_multi_field_element_with_small_characteristics {
46
- public:
47
- using Element = Unsigned_integer_type; /**< Type for the elements in the field. */
48
- using Characteristic = Element; /**< Type for the field characteristic. */
49
- template <class T>
50
- using isInteger = std::enable_if_t<std::is_integral_v<T> >;
51
-
52
- /**
53
- * @brief Default constructor. Sets the element to 0.
54
- */
55
- Shared_multi_field_element_with_small_characteristics() : element_(0) {}
56
- /**
57
- * @brief Constructor setting the element to the given value.
58
- *
59
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if negative.
60
- * @param element Value of the element.
61
- */
62
- template <typename Integer_type, class = isInteger<Integer_type> >
63
- Shared_multi_field_element_with_small_characteristics(Integer_type element) : element_(_get_value(element)) {}
64
- /**
65
- * @brief Copy constructor.
66
- *
67
- * @param toCopy Element to copy.
68
- */
69
- Shared_multi_field_element_with_small_characteristics(
70
- const Shared_multi_field_element_with_small_characteristics& toCopy)
71
- : element_(toCopy.element_) {}
72
- /**
73
- * @brief Move constructor.
74
- *
75
- * @param toMove Element to move.
76
- */
77
- Shared_multi_field_element_with_small_characteristics(
78
- Shared_multi_field_element_with_small_characteristics&& toMove) noexcept
79
- : element_(std::exchange(toMove.element_, 0)) {}
80
-
81
- /**
82
- * @brief Initialize the multi-field to the characteristics (primes) contained in the given interval.
83
- * Should be called first before constructing the field elements.
84
- * The characteristics must be small enough such that `productOfAllCharacteristics ^ 2` fits into an unsigned int.
85
- *
86
- * @param minimum Lowest value in the interval.
87
- * @param maximum Highest value in the interval.
88
- */
89
- static void initialize(unsigned int minimum, unsigned int maximum) {
90
- if (maximum < 2) throw std::invalid_argument("Characteristic must be strictly positive");
91
- if (minimum > maximum) throw std::invalid_argument("The given interval is not valid.");
92
- if (minimum == maximum && !_is_prime(minimum))
93
- throw std::invalid_argument("The given interval does not contain a prime number.");
94
-
95
- productOfAllCharacteristics_ = 1;
96
- primes_.clear();
97
- for (unsigned int i = minimum; i <= maximum; ++i) {
98
- if (_is_prime(i)) {
99
- primes_.push_back(i);
100
- productOfAllCharacteristics_ *= i;
101
- }
102
- }
103
-
104
- if (primes_.empty()) throw std::invalid_argument("The given interval does not contain a prime number.");
105
-
106
- partials_.resize(primes_.size());
107
- for (Characteristic i = 0; i < primes_.size(); ++i) {
108
- Characteristic p = primes_[i];
109
- Characteristic base = productOfAllCharacteristics_ / p;
110
- Characteristic exp = p - 1;
111
- partials_[i] = 1;
112
-
113
- while (exp > 0) {
114
- // If exp is odd, multiply with result
115
- if (exp & 1) partials_[i] = _multiply(partials_[i], base);
116
- // y must be even now
117
- exp = exp >> 1; // y = y/2
118
- base = _multiply(base, base);
119
- }
120
- }
121
-
122
- // If I understood the paper well, multiplicativeID_ always equals to 1. But in Clement's code,
123
- // multiplicativeID_ is computed (see commented loop below). TODO: verify with Clement.
124
- // for (unsigned int i = 0; i < partials_.size(); ++i){
125
- // multiplicativeID_ = (multiplicativeID_ + partials_[i]) % productOfAllCharacteristics_;
126
- // }
127
- }
128
-
129
- /**
130
- * @brief operator+=
131
- */
132
- friend void operator+=(Shared_multi_field_element_with_small_characteristics& f1,
133
- Shared_multi_field_element_with_small_characteristics const& f2) {
134
- f1.element_ = _add(f1.element_, f2.element_);
135
- }
136
- /**
137
- * @brief operator+
138
- */
139
- friend Shared_multi_field_element_with_small_characteristics operator+(
140
- Shared_multi_field_element_with_small_characteristics f1,
141
- Shared_multi_field_element_with_small_characteristics const& f2) {
142
- f1 += f2;
143
- return f1;
144
- }
145
- /**
146
- * @brief operator+=
147
- *
148
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
149
- */
150
- template <typename Integer_type, class = isInteger<Integer_type> >
151
- friend void operator+=(Shared_multi_field_element_with_small_characteristics& f, const Integer_type& v) {
152
- f.element_ = _add(f.element_, _get_value(v));
153
- }
154
- /**
155
- * @brief operator+
156
- *
157
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
158
- */
159
- template <typename Integer_type, class = isInteger<Integer_type> >
160
- friend Shared_multi_field_element_with_small_characteristics operator+(
161
- Shared_multi_field_element_with_small_characteristics f, const Integer_type& v) {
162
- f += v;
163
- return f;
164
- }
165
- /**
166
- * @brief operator+
167
- *
168
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
169
- */
170
- template <typename Integer_type, class = isInteger<Integer_type> >
171
- friend Integer_type operator+(const Integer_type& v, Shared_multi_field_element_with_small_characteristics f) {
172
- f += v;
173
- return f.element_;
174
- }
175
-
176
- /**
177
- * @brief operator-=
178
- */
179
- friend void operator-=(Shared_multi_field_element_with_small_characteristics& f1,
180
- Shared_multi_field_element_with_small_characteristics const& f2) {
181
- f1.element_ = _subtract(f1.element_, f2.element_);
182
- }
183
- /**
184
- * @brief operator-
185
- */
186
- friend Shared_multi_field_element_with_small_characteristics operator-(
187
- Shared_multi_field_element_with_small_characteristics f1,
188
- Shared_multi_field_element_with_small_characteristics const& f2) {
189
- f1 -= f2;
190
- return f1;
191
- }
192
- /**
193
- * @brief operator-=
194
- *
195
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
196
- */
197
- template <typename Integer_type, class = isInteger<Integer_type> >
198
- friend void operator-=(Shared_multi_field_element_with_small_characteristics& f, const Integer_type& v) {
199
- f.element_ = _subtract(f.element_, _get_value(v));
200
- }
201
- /**
202
- * @brief operator-
203
- *
204
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
205
- */
206
- template <typename Integer_type, class = isInteger<Integer_type> >
207
- friend Shared_multi_field_element_with_small_characteristics operator-(
208
- Shared_multi_field_element_with_small_characteristics f, const Integer_type& v) {
209
- f -= v;
210
- return f;
211
- }
212
- /**
213
- * @brief operator-
214
- *
215
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
216
- */
217
- template <typename Integer_type, class = isInteger<Integer_type> >
218
- friend Integer_type operator-(const Integer_type& v, const Shared_multi_field_element_with_small_characteristics& f) {
219
- return _subtract(_get_value(v), f.element_);
220
- }
221
-
222
- /**
223
- * @brief operator*=
224
- */
225
- friend void operator*=(Shared_multi_field_element_with_small_characteristics& f1,
226
- Shared_multi_field_element_with_small_characteristics const& f2) {
227
- f1.element_ = _multiply(f1.element_, f2.element_);
228
- }
229
- /**
230
- * @brief operator*
231
- */
232
- friend Shared_multi_field_element_with_small_characteristics operator*(
233
- Shared_multi_field_element_with_small_characteristics f1,
234
- Shared_multi_field_element_with_small_characteristics const& f2) {
235
- f1 *= f2;
236
- return f1;
237
- }
238
- /**
239
- * @brief operator*=
240
- *
241
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
242
- */
243
- template <typename Integer_type, class = isInteger<Integer_type> >
244
- friend void operator*=(Shared_multi_field_element_with_small_characteristics& f, const Integer_type& v) {
245
- f.element_ = _multiply(f.element_, _get_value(v));
246
- }
247
- /**
248
- * @brief operator*
249
- *
250
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
251
- */
252
- template <typename Integer_type, class = isInteger<Integer_type> >
253
- friend Shared_multi_field_element_with_small_characteristics operator*(
254
- Shared_multi_field_element_with_small_characteristics f, const Integer_type& v) {
255
- f *= v;
256
- return f;
257
- }
258
- /**
259
- * @brief operator*
260
- *
261
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
262
- */
263
- template <typename Integer_type, class = isInteger<Integer_type> >
264
- friend Integer_type operator*(const Integer_type& v, Shared_multi_field_element_with_small_characteristics f) {
265
- f *= v;
266
- return f.element_;
267
- }
268
-
269
- /**
270
- * @brief operator==
271
- */
272
- friend bool operator==(const Shared_multi_field_element_with_small_characteristics& f1,
273
- const Shared_multi_field_element_with_small_characteristics& f2) {
274
- return f1.element_ == f2.element_;
275
- }
276
- /**
277
- * @brief operator==
278
- *
279
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
280
- */
281
- template <typename Integer_type, class = isInteger<Integer_type> >
282
- friend bool operator==(const Integer_type& v, const Shared_multi_field_element_with_small_characteristics& f) {
283
- return _get_value(v) == f.element_;
284
- }
285
- /**
286
- * @brief operator==
287
- *
288
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
289
- */
290
- template <typename Integer_type, class = isInteger<Integer_type> >
291
- friend bool operator==(const Shared_multi_field_element_with_small_characteristics& f, const Integer_type& v) {
292
- return _get_value(v) == f.element_;
293
- }
294
- /**
295
- * @brief operator!=
296
- */
297
- friend bool operator!=(const Shared_multi_field_element_with_small_characteristics& f1,
298
- const Shared_multi_field_element_with_small_characteristics& f2) {
299
- return !(f1 == f2);
300
- }
301
- /**
302
- * @brief operator!=
303
- *
304
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
305
- */
306
- template <typename Integer_type, class = isInteger<Integer_type> >
307
- friend bool operator!=(const Integer_type v, const Shared_multi_field_element_with_small_characteristics& f) {
308
- return !(v == f);
309
- }
310
- /**
311
- * @brief operator!=
312
- *
313
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
314
- */
315
- template <typename Integer_type, class = isInteger<Integer_type> >
316
- friend bool operator!=(const Shared_multi_field_element_with_small_characteristics& f, const Integer_type v) {
317
- return !(v == f);
318
- }
319
-
320
- /**
321
- * @brief Assign operator.
322
- */
323
- Shared_multi_field_element_with_small_characteristics& operator=(
324
- Shared_multi_field_element_with_small_characteristics other) {
325
- std::swap(element_, other.element_);
326
- return *this;
327
- }
328
- /**
329
- * @brief Assign operator.
330
- *
331
- * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
332
- */
333
- template <typename Integer_type, class = isInteger<Integer_type> >
334
- Shared_multi_field_element_with_small_characteristics& operator=(const Integer_type& value) {
335
- element_ = _get_value(value);
336
- return *this;
337
- }
338
- /**
339
- * @brief Swap operator.
340
- */
341
- friend void swap(Shared_multi_field_element_with_small_characteristics& f1,
342
- Shared_multi_field_element_with_small_characteristics& f2) {
343
- std::swap(f1.element_, f2.element_);
344
- }
345
-
346
- /**
347
- * @brief Casts the element into an unsigned int.
348
- */
349
- operator unsigned int() const { return element_; }
350
-
351
- /**
352
- * @brief Returns the inverse of the element in the multi-field, see @cite boissonnat:hal-00922572.
353
- *
354
- * @return The inverse.
355
- */
356
- Shared_multi_field_element_with_small_characteristics get_inverse() const {
357
- return get_partial_inverse(productOfAllCharacteristics_).first;
358
- }
359
- /**
360
- * @brief Returns the inverse of the element with respect to a sub-product of the characteristics in the multi-field,
361
- * see @cite boissonnat:hal-00922572.
362
- *
363
- * @param productOfCharacteristics Sub-product of the characteristics.
364
- * @return Pair of the inverse and the characteristic the inverse corresponds to.
365
- */
366
- std::pair<Shared_multi_field_element_with_small_characteristics,Characteristic> get_partial_inverse(
367
- Characteristic productOfCharacteristics) const {
368
- Characteristic gcd = std::gcd(element_, productOfAllCharacteristics_);
369
-
370
- if (gcd == productOfCharacteristics)
371
- return {Shared_multi_field_element_with_small_characteristics(), multiplicativeID_}; // partial inverse is 0
372
-
373
- Characteristic QT = productOfCharacteristics / gcd;
374
-
375
- const Element inv_qt = _get_inverse(element_, QT);
376
-
377
- auto res = get_partial_multiplicative_identity(QT);
378
- res *= inv_qt;
379
-
380
- return {res, QT};
381
- }
382
-
383
- /**
384
- * @brief Returns the additive identity of a field.
385
- *
386
- * @return The additive identity of a field.
387
- */
388
- static Shared_multi_field_element_with_small_characteristics get_additive_identity() {
389
- return Shared_multi_field_element_with_small_characteristics();
390
- }
391
- /**
392
- * @brief Returns the multiplicative identity of a field.
393
- *
394
- * @return The multiplicative identity of a field.
395
- */
396
- static Shared_multi_field_element_with_small_characteristics get_multiplicative_identity() {
397
- return Shared_multi_field_element_with_small_characteristics(multiplicativeID_);
398
- }
399
- /**
400
- * @brief Returns the partial multiplicative identity of the multi-field from the given product.
401
- * See @cite boissonnat:hal-00922572 for more details.
402
- *
403
- * @param productOfCharacteristics Product of the different characteristics to take into account in the multi-field.
404
- * @return The partial multiplicative identity of the multi-field.
405
- */
406
- static Shared_multi_field_element_with_small_characteristics get_partial_multiplicative_identity(
407
- const Characteristic& productOfCharacteristics) {
408
- if (productOfCharacteristics == 0) {
409
- return Shared_multi_field_element_with_small_characteristics(multiplicativeID_);
410
- }
411
- Shared_multi_field_element_with_small_characteristics mult;
412
- for (Characteristic idx = 0; idx < primes_.size(); ++idx) {
413
- if ((productOfCharacteristics % primes_[idx]) == 0) {
414
- mult += partials_[idx];
415
- }
416
- }
417
- return mult;
418
- }
419
- /**
420
- * @brief Returns the product of all characteristics.
421
- *
422
- * @return The product of all characteristics.
423
- */
424
- static Characteristic get_characteristic() { return productOfAllCharacteristics_; }
425
-
426
- /**
427
- * @brief Returns the value of the element.
428
- *
429
- * @return Value of the element.
430
- */
431
- Element get_value() const { return element_; }
432
-
433
- // static constexpr bool handles_only_z2() { return false; }
434
-
435
- private:
436
- static constexpr bool _is_prime(const unsigned int p) {
437
- if (p <= 1) return false;
438
- if (p <= 3) return true;
439
- if (p % 2 == 0 || p % 3 == 0) return false;
440
-
441
- for (unsigned long i = 5; i * i <= p; i = i + 6)
442
- if (p % i == 0 || p % (i + 2) == 0) return false;
443
-
444
- return true;
445
- }
446
- static Element _multiply(Element a, Element b) {
447
- Element res = 0;
448
- Element temp_b = 0;
449
-
450
- if (b < a) std::swap(a, b);
451
-
452
- while (a != 0) {
453
- if (a & 1) {
454
- /* Add b to res, modulo m, without overflow */
455
- if (b >= productOfAllCharacteristics_ - res) res -= productOfAllCharacteristics_;
456
- res += b;
457
- }
458
- a >>= 1;
459
-
460
- /* Double b, modulo m */
461
- temp_b = b;
462
- if (b >= productOfAllCharacteristics_ - b) temp_b -= productOfAllCharacteristics_;
463
- b += temp_b;
464
- }
465
- return res;
466
- }
467
- static Element _add(Element element, Element v) {
468
- if (UINT_MAX - element < v) {
469
- // automatic unsigned integer overflow behaviour will make it work
470
- element += v;
471
- element -= productOfAllCharacteristics_;
472
- return element;
473
- }
474
-
475
- element += v;
476
- if (element >= productOfAllCharacteristics_) element -= productOfAllCharacteristics_;
477
-
478
- return element;
479
- }
480
- static Element _subtract(Element element, Element v) {
481
- if (element < v) {
482
- element += productOfAllCharacteristics_;
483
- }
484
- element -= v;
485
-
486
- return element;
487
- }
488
- static constexpr int _get_inverse(Element element, const Characteristic mod) {
489
- // to solve: Ax + My = 1
490
- int M = mod;
491
- int A = element;
492
- int y = 0, x = 1;
493
- // extended euclidean division
494
- while (A > 1) {
495
- int quotient = A / M;
496
- int temp = M;
497
-
498
- M = A % M, A = temp;
499
- temp = y;
500
-
501
- y = x - quotient * y;
502
- x = temp;
503
- }
504
-
505
- if (x < 0) x += mod;
506
-
507
- return x;
508
- }
509
-
510
- template <typename Integer_type, class = isInteger<Integer_type> >
511
- static constexpr Element _get_value(Integer_type e) {
512
- if constexpr (std::is_signed_v<Integer_type>){
513
- if (e < -static_cast<Integer_type>(productOfAllCharacteristics_)) e = e % productOfAllCharacteristics_;
514
- if (e < 0) return e += productOfAllCharacteristics_;
515
- return e < static_cast<Integer_type>(productOfAllCharacteristics_) ? e : e % productOfAllCharacteristics_;
516
- } else {
517
- return e < productOfAllCharacteristics_ ? e : e % productOfAllCharacteristics_;
518
- }
519
- }
520
-
521
- Element element_; /**< Element. */
522
- static inline std::vector<Characteristic> primes_; /**< All characteristics. */
523
- static inline Characteristic productOfAllCharacteristics_; /**< Product of all characteristics. */
524
- static inline std::vector<Characteristic> partials_; /**< Partial products of the characteristics. */
525
- static inline constexpr Element multiplicativeID_ = 1; /**< Multiplicative identity. */
526
- };
527
-
528
- } // namespace persistence_fields
529
- } // namespace Gudhi
530
-
531
- #endif // MATRIX_FIELD_MULTI_SMALL_SHARED_H_
1
+ /* This file is part of the Gudhi Library - https://gudhi.inria.fr/ - which is released under MIT.
2
+ * See file LICENSE or go to https://gudhi.inria.fr/licensing/ for full license details.
3
+ * Author(s): Hannah Schreiber, Clément Maria
4
+ *
5
+ * Copyright (C) 2022-24 Inria
6
+ *
7
+ * Modification(s):
8
+ * - YYYY/MM Author: Description of the modification
9
+ */
10
+
11
+ /**
12
+ * @file Multi_field_small_shared.h
13
+ * @author Hannah Schreiber, Clément Maria
14
+ * @brief Contains the @ref Gudhi::persistence_fields::Shared_multi_field_element_with_small_characteristics class.
15
+ */
16
+
17
+ #ifndef MATRIX_FIELD_MULTI_SMALL_SHARED_H_
18
+ #define MATRIX_FIELD_MULTI_SMALL_SHARED_H_
19
+
20
+ #include <utility>
21
+ #include <vector>
22
+ #include <limits.h>
23
+ #include <stdexcept>
24
+ #include <numeric>
25
+
26
+ namespace Gudhi {
27
+ namespace persistence_fields {
28
+
29
+ /**
30
+ * @class Shared_multi_field_element_with_small_characteristics Multi_field_small_shared.h \
31
+ * gudhi/Fields/Multi_field_small_shared.h
32
+ * @ingroup persistence_fields
33
+ *
34
+ * @brief Class representing an element of a multi-field, such that `productOfAllCharacteristics ^ 2` fits into
35
+ * the given @p Unsigned_integer_type template argument. If each instantiation of the class can represent another
36
+ * element, they all share the same characteristics. That is if the characteristics are set for one, they will be
37
+ * set for all the others. The characteristics can be set before instantiating the elements with the static
38
+ * @ref Shared_multi_field_element_with_small_characteristics::initialize method.
39
+ *
40
+ * @tparam Unsigned_integer_type A native unsigned integer type: unsigned int, long unsigned int, etc.
41
+ * Will be used as the field element type.
42
+ */
43
+ template <typename Unsigned_integer_type = unsigned int,
44
+ class = std::enable_if_t<std::is_unsigned_v<Unsigned_integer_type> > >
45
+ class Shared_multi_field_element_with_small_characteristics {
46
+ public:
47
+ using Element = Unsigned_integer_type; /**< Type for the elements in the field. */
48
+ using Characteristic = Element; /**< Type for the field characteristic. */
49
+ template <class T>
50
+ using isInteger = std::enable_if_t<std::is_integral_v<T> >;
51
+
52
+ /**
53
+ * @brief Default constructor. Sets the element to 0.
54
+ */
55
+ Shared_multi_field_element_with_small_characteristics() : element_(0) {}
56
+ /**
57
+ * @brief Constructor setting the element to the given value.
58
+ *
59
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if negative.
60
+ * @param element Value of the element.
61
+ */
62
+ template <typename Integer_type, class = isInteger<Integer_type> >
63
+ Shared_multi_field_element_with_small_characteristics(Integer_type element) : element_(_get_value(element)) {}
64
+ /**
65
+ * @brief Copy constructor.
66
+ *
67
+ * @param toCopy Element to copy.
68
+ */
69
+ Shared_multi_field_element_with_small_characteristics(
70
+ const Shared_multi_field_element_with_small_characteristics& toCopy)
71
+ : element_(toCopy.element_) {}
72
+ /**
73
+ * @brief Move constructor.
74
+ *
75
+ * @param toMove Element to move.
76
+ */
77
+ Shared_multi_field_element_with_small_characteristics(
78
+ Shared_multi_field_element_with_small_characteristics&& toMove) noexcept
79
+ : element_(std::exchange(toMove.element_, 0)) {}
80
+
81
+ /**
82
+ * @brief Initialize the multi-field to the characteristics (primes) contained in the given interval.
83
+ * Should be called first before constructing the field elements.
84
+ * The characteristics must be small enough such that `productOfAllCharacteristics ^ 2` fits into an unsigned int.
85
+ *
86
+ * @param minimum Lowest value in the interval.
87
+ * @param maximum Highest value in the interval.
88
+ */
89
+ static void initialize(unsigned int minimum, unsigned int maximum) {
90
+ if (maximum < 2) throw std::invalid_argument("Characteristic must be strictly positive");
91
+ if (minimum > maximum) throw std::invalid_argument("The given interval is not valid.");
92
+ if (minimum == maximum && !_is_prime(minimum))
93
+ throw std::invalid_argument("The given interval does not contain a prime number.");
94
+
95
+ productOfAllCharacteristics_ = 1;
96
+ primes_.clear();
97
+ for (unsigned int i = minimum; i <= maximum; ++i) {
98
+ if (_is_prime(i)) {
99
+ primes_.push_back(i);
100
+ productOfAllCharacteristics_ *= i;
101
+ }
102
+ }
103
+
104
+ if (primes_.empty()) throw std::invalid_argument("The given interval does not contain a prime number.");
105
+
106
+ partials_.resize(primes_.size());
107
+ for (Characteristic i = 0; i < primes_.size(); ++i) {
108
+ Characteristic p = primes_[i];
109
+ Characteristic base = productOfAllCharacteristics_ / p;
110
+ Characteristic exp = p - 1;
111
+ partials_[i] = 1;
112
+
113
+ while (exp > 0) {
114
+ // If exp is odd, multiply with result
115
+ if (exp & 1) partials_[i] = _multiply(partials_[i], base);
116
+ // y must be even now
117
+ exp = exp >> 1; // y = y/2
118
+ base = _multiply(base, base);
119
+ }
120
+ }
121
+
122
+ // If I understood the paper well, multiplicativeID_ always equals to 1. But in Clement's code,
123
+ // multiplicativeID_ is computed (see commented loop below). TODO: verify with Clement.
124
+ // for (unsigned int i = 0; i < partials_.size(); ++i){
125
+ // multiplicativeID_ = (multiplicativeID_ + partials_[i]) % productOfAllCharacteristics_;
126
+ // }
127
+ }
128
+
129
+ /**
130
+ * @brief operator+=
131
+ */
132
+ friend void operator+=(Shared_multi_field_element_with_small_characteristics& f1,
133
+ Shared_multi_field_element_with_small_characteristics const& f2) {
134
+ f1.element_ = _add(f1.element_, f2.element_);
135
+ }
136
+ /**
137
+ * @brief operator+
138
+ */
139
+ friend Shared_multi_field_element_with_small_characteristics operator+(
140
+ Shared_multi_field_element_with_small_characteristics f1,
141
+ Shared_multi_field_element_with_small_characteristics const& f2) {
142
+ f1 += f2;
143
+ return f1;
144
+ }
145
+ /**
146
+ * @brief operator+=
147
+ *
148
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
149
+ */
150
+ template <typename Integer_type, class = isInteger<Integer_type> >
151
+ friend void operator+=(Shared_multi_field_element_with_small_characteristics& f, const Integer_type& v) {
152
+ f.element_ = _add(f.element_, _get_value(v));
153
+ }
154
+ /**
155
+ * @brief operator+
156
+ *
157
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
158
+ */
159
+ template <typename Integer_type, class = isInteger<Integer_type> >
160
+ friend Shared_multi_field_element_with_small_characteristics operator+(
161
+ Shared_multi_field_element_with_small_characteristics f, const Integer_type& v) {
162
+ f += v;
163
+ return f;
164
+ }
165
+ /**
166
+ * @brief operator+
167
+ *
168
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
169
+ */
170
+ template <typename Integer_type, class = isInteger<Integer_type> >
171
+ friend Integer_type operator+(const Integer_type& v, Shared_multi_field_element_with_small_characteristics f) {
172
+ f += v;
173
+ return f.element_;
174
+ }
175
+
176
+ /**
177
+ * @brief operator-=
178
+ */
179
+ friend void operator-=(Shared_multi_field_element_with_small_characteristics& f1,
180
+ Shared_multi_field_element_with_small_characteristics const& f2) {
181
+ f1.element_ = _subtract(f1.element_, f2.element_);
182
+ }
183
+ /**
184
+ * @brief operator-
185
+ */
186
+ friend Shared_multi_field_element_with_small_characteristics operator-(
187
+ Shared_multi_field_element_with_small_characteristics f1,
188
+ Shared_multi_field_element_with_small_characteristics const& f2) {
189
+ f1 -= f2;
190
+ return f1;
191
+ }
192
+ /**
193
+ * @brief operator-=
194
+ *
195
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
196
+ */
197
+ template <typename Integer_type, class = isInteger<Integer_type> >
198
+ friend void operator-=(Shared_multi_field_element_with_small_characteristics& f, const Integer_type& v) {
199
+ f.element_ = _subtract(f.element_, _get_value(v));
200
+ }
201
+ /**
202
+ * @brief operator-
203
+ *
204
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
205
+ */
206
+ template <typename Integer_type, class = isInteger<Integer_type> >
207
+ friend Shared_multi_field_element_with_small_characteristics operator-(
208
+ Shared_multi_field_element_with_small_characteristics f, const Integer_type& v) {
209
+ f -= v;
210
+ return f;
211
+ }
212
+ /**
213
+ * @brief operator-
214
+ *
215
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
216
+ */
217
+ template <typename Integer_type, class = isInteger<Integer_type> >
218
+ friend Integer_type operator-(const Integer_type& v, const Shared_multi_field_element_with_small_characteristics& f) {
219
+ return _subtract(_get_value(v), f.element_);
220
+ }
221
+
222
+ /**
223
+ * @brief operator*=
224
+ */
225
+ friend void operator*=(Shared_multi_field_element_with_small_characteristics& f1,
226
+ Shared_multi_field_element_with_small_characteristics const& f2) {
227
+ f1.element_ = _multiply(f1.element_, f2.element_);
228
+ }
229
+ /**
230
+ * @brief operator*
231
+ */
232
+ friend Shared_multi_field_element_with_small_characteristics operator*(
233
+ Shared_multi_field_element_with_small_characteristics f1,
234
+ Shared_multi_field_element_with_small_characteristics const& f2) {
235
+ f1 *= f2;
236
+ return f1;
237
+ }
238
+ /**
239
+ * @brief operator*=
240
+ *
241
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
242
+ */
243
+ template <typename Integer_type, class = isInteger<Integer_type> >
244
+ friend void operator*=(Shared_multi_field_element_with_small_characteristics& f, const Integer_type& v) {
245
+ f.element_ = _multiply(f.element_, _get_value(v));
246
+ }
247
+ /**
248
+ * @brief operator*
249
+ *
250
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
251
+ */
252
+ template <typename Integer_type, class = isInteger<Integer_type> >
253
+ friend Shared_multi_field_element_with_small_characteristics operator*(
254
+ Shared_multi_field_element_with_small_characteristics f, const Integer_type& v) {
255
+ f *= v;
256
+ return f;
257
+ }
258
+ /**
259
+ * @brief operator*
260
+ *
261
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
262
+ */
263
+ template <typename Integer_type, class = isInteger<Integer_type> >
264
+ friend Integer_type operator*(const Integer_type& v, Shared_multi_field_element_with_small_characteristics f) {
265
+ f *= v;
266
+ return f.element_;
267
+ }
268
+
269
+ /**
270
+ * @brief operator==
271
+ */
272
+ friend bool operator==(const Shared_multi_field_element_with_small_characteristics& f1,
273
+ const Shared_multi_field_element_with_small_characteristics& f2) {
274
+ return f1.element_ == f2.element_;
275
+ }
276
+ /**
277
+ * @brief operator==
278
+ *
279
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
280
+ */
281
+ template <typename Integer_type, class = isInteger<Integer_type> >
282
+ friend bool operator==(const Integer_type& v, const Shared_multi_field_element_with_small_characteristics& f) {
283
+ return _get_value(v) == f.element_;
284
+ }
285
+ /**
286
+ * @brief operator==
287
+ *
288
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
289
+ */
290
+ template <typename Integer_type, class = isInteger<Integer_type> >
291
+ friend bool operator==(const Shared_multi_field_element_with_small_characteristics& f, const Integer_type& v) {
292
+ return _get_value(v) == f.element_;
293
+ }
294
+ /**
295
+ * @brief operator!=
296
+ */
297
+ friend bool operator!=(const Shared_multi_field_element_with_small_characteristics& f1,
298
+ const Shared_multi_field_element_with_small_characteristics& f2) {
299
+ return !(f1 == f2);
300
+ }
301
+ /**
302
+ * @brief operator!=
303
+ *
304
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
305
+ */
306
+ template <typename Integer_type, class = isInteger<Integer_type> >
307
+ friend bool operator!=(const Integer_type v, const Shared_multi_field_element_with_small_characteristics& f) {
308
+ return !(v == f);
309
+ }
310
+ /**
311
+ * @brief operator!=
312
+ *
313
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
314
+ */
315
+ template <typename Integer_type, class = isInteger<Integer_type> >
316
+ friend bool operator!=(const Shared_multi_field_element_with_small_characteristics& f, const Integer_type v) {
317
+ return !(v == f);
318
+ }
319
+
320
+ /**
321
+ * @brief Assign operator.
322
+ */
323
+ Shared_multi_field_element_with_small_characteristics& operator=(
324
+ Shared_multi_field_element_with_small_characteristics other) {
325
+ std::swap(element_, other.element_);
326
+ return *this;
327
+ }
328
+ /**
329
+ * @brief Assign operator.
330
+ *
331
+ * @tparam Integer_type A native integer type. Should be able to contain the characteristic if signed.
332
+ */
333
+ template <typename Integer_type, class = isInteger<Integer_type> >
334
+ Shared_multi_field_element_with_small_characteristics& operator=(const Integer_type& value) {
335
+ element_ = _get_value(value);
336
+ return *this;
337
+ }
338
+ /**
339
+ * @brief Swap operator.
340
+ */
341
+ friend void swap(Shared_multi_field_element_with_small_characteristics& f1,
342
+ Shared_multi_field_element_with_small_characteristics& f2) {
343
+ std::swap(f1.element_, f2.element_);
344
+ }
345
+
346
+ /**
347
+ * @brief Casts the element into an unsigned int.
348
+ */
349
+ operator unsigned int() const { return element_; }
350
+
351
+ /**
352
+ * @brief Returns the inverse of the element in the multi-field, see @cite boissonnat:hal-00922572.
353
+ *
354
+ * @return The inverse.
355
+ */
356
+ Shared_multi_field_element_with_small_characteristics get_inverse() const {
357
+ return get_partial_inverse(productOfAllCharacteristics_).first;
358
+ }
359
+ /**
360
+ * @brief Returns the inverse of the element with respect to a sub-product of the characteristics in the multi-field,
361
+ * see @cite boissonnat:hal-00922572.
362
+ *
363
+ * @param productOfCharacteristics Sub-product of the characteristics.
364
+ * @return Pair of the inverse and the characteristic the inverse corresponds to.
365
+ */
366
+ std::pair<Shared_multi_field_element_with_small_characteristics,Characteristic> get_partial_inverse(
367
+ Characteristic productOfCharacteristics) const {
368
+ Characteristic gcd = std::gcd(element_, productOfAllCharacteristics_);
369
+
370
+ if (gcd == productOfCharacteristics)
371
+ return {Shared_multi_field_element_with_small_characteristics(), multiplicativeID_}; // partial inverse is 0
372
+
373
+ Characteristic QT = productOfCharacteristics / gcd;
374
+
375
+ const Element inv_qt = _get_inverse(element_, QT);
376
+
377
+ auto res = get_partial_multiplicative_identity(QT);
378
+ res *= inv_qt;
379
+
380
+ return {res, QT};
381
+ }
382
+
383
+ /**
384
+ * @brief Returns the additive identity of a field.
385
+ *
386
+ * @return The additive identity of a field.
387
+ */
388
+ static Shared_multi_field_element_with_small_characteristics get_additive_identity() {
389
+ return Shared_multi_field_element_with_small_characteristics();
390
+ }
391
+ /**
392
+ * @brief Returns the multiplicative identity of a field.
393
+ *
394
+ * @return The multiplicative identity of a field.
395
+ */
396
+ static Shared_multi_field_element_with_small_characteristics get_multiplicative_identity() {
397
+ return Shared_multi_field_element_with_small_characteristics(multiplicativeID_);
398
+ }
399
+ /**
400
+ * @brief Returns the partial multiplicative identity of the multi-field from the given product.
401
+ * See @cite boissonnat:hal-00922572 for more details.
402
+ *
403
+ * @param productOfCharacteristics Product of the different characteristics to take into account in the multi-field.
404
+ * @return The partial multiplicative identity of the multi-field.
405
+ */
406
+ static Shared_multi_field_element_with_small_characteristics get_partial_multiplicative_identity(
407
+ const Characteristic& productOfCharacteristics) {
408
+ if (productOfCharacteristics == 0) {
409
+ return Shared_multi_field_element_with_small_characteristics(multiplicativeID_);
410
+ }
411
+ Shared_multi_field_element_with_small_characteristics mult;
412
+ for (Characteristic idx = 0; idx < primes_.size(); ++idx) {
413
+ if ((productOfCharacteristics % primes_[idx]) == 0) {
414
+ mult += partials_[idx];
415
+ }
416
+ }
417
+ return mult;
418
+ }
419
+ /**
420
+ * @brief Returns the product of all characteristics.
421
+ *
422
+ * @return The product of all characteristics.
423
+ */
424
+ static Characteristic get_characteristic() { return productOfAllCharacteristics_; }
425
+
426
+ /**
427
+ * @brief Returns the value of the element.
428
+ *
429
+ * @return Value of the element.
430
+ */
431
+ Element get_value() const { return element_; }
432
+
433
+ // static constexpr bool handles_only_z2() { return false; }
434
+
435
+ private:
436
+ static constexpr bool _is_prime(const unsigned int p) {
437
+ if (p <= 1) return false;
438
+ if (p <= 3) return true;
439
+ if (p % 2 == 0 || p % 3 == 0) return false;
440
+
441
+ for (unsigned long i = 5; i * i <= p; i = i + 6)
442
+ if (p % i == 0 || p % (i + 2) == 0) return false;
443
+
444
+ return true;
445
+ }
446
+ static Element _multiply(Element a, Element b) {
447
+ Element res = 0;
448
+ Element temp_b = 0;
449
+
450
+ if (b < a) std::swap(a, b);
451
+
452
+ while (a != 0) {
453
+ if (a & 1) {
454
+ /* Add b to res, modulo m, without overflow */
455
+ if (b >= productOfAllCharacteristics_ - res) res -= productOfAllCharacteristics_;
456
+ res += b;
457
+ }
458
+ a >>= 1;
459
+
460
+ /* Double b, modulo m */
461
+ temp_b = b;
462
+ if (b >= productOfAllCharacteristics_ - b) temp_b -= productOfAllCharacteristics_;
463
+ b += temp_b;
464
+ }
465
+ return res;
466
+ }
467
+ static Element _add(Element element, Element v) {
468
+ if (UINT_MAX - element < v) {
469
+ // automatic unsigned integer overflow behaviour will make it work
470
+ element += v;
471
+ element -= productOfAllCharacteristics_;
472
+ return element;
473
+ }
474
+
475
+ element += v;
476
+ if (element >= productOfAllCharacteristics_) element -= productOfAllCharacteristics_;
477
+
478
+ return element;
479
+ }
480
+ static Element _subtract(Element element, Element v) {
481
+ if (element < v) {
482
+ element += productOfAllCharacteristics_;
483
+ }
484
+ element -= v;
485
+
486
+ return element;
487
+ }
488
+ static constexpr int _get_inverse(Element element, const Characteristic mod) {
489
+ // to solve: Ax + My = 1
490
+ int M = mod;
491
+ int A = element;
492
+ int y = 0, x = 1;
493
+ // extended euclidean division
494
+ while (A > 1) {
495
+ int quotient = A / M;
496
+ int temp = M;
497
+
498
+ M = A % M, A = temp;
499
+ temp = y;
500
+
501
+ y = x - quotient * y;
502
+ x = temp;
503
+ }
504
+
505
+ if (x < 0) x += mod;
506
+
507
+ return x;
508
+ }
509
+
510
+ template <typename Integer_type, class = isInteger<Integer_type> >
511
+ static constexpr Element _get_value(Integer_type e) {
512
+ if constexpr (std::is_signed_v<Integer_type>){
513
+ if (e < -static_cast<Integer_type>(productOfAllCharacteristics_)) e = e % productOfAllCharacteristics_;
514
+ if (e < 0) return e += productOfAllCharacteristics_;
515
+ return e < static_cast<Integer_type>(productOfAllCharacteristics_) ? e : e % productOfAllCharacteristics_;
516
+ } else {
517
+ return e < productOfAllCharacteristics_ ? e : e % productOfAllCharacteristics_;
518
+ }
519
+ }
520
+
521
+ Element element_; /**< Element. */
522
+ static inline std::vector<Characteristic> primes_; /**< All characteristics. */
523
+ static inline Characteristic productOfAllCharacteristics_; /**< Product of all characteristics. */
524
+ static inline std::vector<Characteristic> partials_; /**< Partial products of the characteristics. */
525
+ static inline constexpr Element multiplicativeID_ = 1; /**< Multiplicative identity. */
526
+ };
527
+
528
+ } // namespace persistence_fields
529
+ } // namespace Gudhi
530
+
531
+ #endif // MATRIX_FIELD_MULTI_SMALL_SHARED_H_