multipers 2.2.3__cp311-cp311-win_amd64.whl → 2.3.1__cp311-cp311-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/{ml/convolutions.py → filtrations/density.py} +563 -520
  15. multipers/filtrations/filtrations.py +289 -0
  16. multipers/filtrations.pxd +224 -224
  17. multipers/function_rips.cp311-win_amd64.pyd +0 -0
  18. multipers/function_rips.pyx +105 -105
  19. multipers/grids.cp311-win_amd64.pyd +0 -0
  20. multipers/grids.pyx +350 -350
  21. multipers/gudhi/Persistence_slices_interface.h +132 -132
  22. multipers/gudhi/Simplex_tree_interface.h +239 -245
  23. multipers/gudhi/Simplex_tree_multi_interface.h +516 -561
  24. multipers/gudhi/cubical_to_boundary.h +59 -59
  25. multipers/gudhi/gudhi/Bitmap_cubical_complex.h +450 -450
  26. multipers/gudhi/gudhi/Bitmap_cubical_complex_base.h +1070 -1070
  27. multipers/gudhi/gudhi/Bitmap_cubical_complex_periodic_boundary_conditions_base.h +579 -579
  28. multipers/gudhi/gudhi/Debug_utils.h +45 -45
  29. multipers/gudhi/gudhi/Fields/Multi_field.h +484 -484
  30. multipers/gudhi/gudhi/Fields/Multi_field_operators.h +455 -455
  31. multipers/gudhi/gudhi/Fields/Multi_field_shared.h +450 -450
  32. multipers/gudhi/gudhi/Fields/Multi_field_small.h +531 -531
  33. multipers/gudhi/gudhi/Fields/Multi_field_small_operators.h +507 -507
  34. multipers/gudhi/gudhi/Fields/Multi_field_small_shared.h +531 -531
  35. multipers/gudhi/gudhi/Fields/Z2_field.h +355 -355
  36. multipers/gudhi/gudhi/Fields/Z2_field_operators.h +376 -376
  37. multipers/gudhi/gudhi/Fields/Zp_field.h +420 -420
  38. multipers/gudhi/gudhi/Fields/Zp_field_operators.h +400 -400
  39. multipers/gudhi/gudhi/Fields/Zp_field_shared.h +418 -418
  40. multipers/gudhi/gudhi/Flag_complex_edge_collapser.h +337 -337
  41. multipers/gudhi/gudhi/Matrix.h +2107 -2107
  42. multipers/gudhi/gudhi/Multi_critical_filtration.h +1038 -1038
  43. multipers/gudhi/gudhi/Multi_persistence/Box.h +171 -171
  44. multipers/gudhi/gudhi/Multi_persistence/Line.h +282 -282
  45. multipers/gudhi/gudhi/Off_reader.h +173 -173
  46. multipers/gudhi/gudhi/One_critical_filtration.h +1433 -1431
  47. multipers/gudhi/gudhi/Persistence_matrix/Base_matrix.h +769 -769
  48. multipers/gudhi/gudhi/Persistence_matrix/Base_matrix_with_column_compression.h +686 -686
  49. multipers/gudhi/gudhi/Persistence_matrix/Boundary_matrix.h +842 -842
  50. multipers/gudhi/gudhi/Persistence_matrix/Chain_matrix.h +1350 -1350
  51. multipers/gudhi/gudhi/Persistence_matrix/Id_to_index_overlay.h +1105 -1105
  52. multipers/gudhi/gudhi/Persistence_matrix/Position_to_index_overlay.h +859 -859
  53. multipers/gudhi/gudhi/Persistence_matrix/RU_matrix.h +910 -910
  54. multipers/gudhi/gudhi/Persistence_matrix/allocators/entry_constructors.h +139 -139
  55. multipers/gudhi/gudhi/Persistence_matrix/base_pairing.h +230 -230
  56. multipers/gudhi/gudhi/Persistence_matrix/base_swap.h +211 -211
  57. multipers/gudhi/gudhi/Persistence_matrix/boundary_cell_position_to_id_mapper.h +60 -60
  58. multipers/gudhi/gudhi/Persistence_matrix/boundary_face_position_to_id_mapper.h +60 -60
  59. multipers/gudhi/gudhi/Persistence_matrix/chain_pairing.h +136 -136
  60. multipers/gudhi/gudhi/Persistence_matrix/chain_rep_cycles.h +190 -190
  61. multipers/gudhi/gudhi/Persistence_matrix/chain_vine_swap.h +616 -616
  62. multipers/gudhi/gudhi/Persistence_matrix/columns/chain_column_extra_properties.h +150 -150
  63. multipers/gudhi/gudhi/Persistence_matrix/columns/column_dimension_holder.h +106 -106
  64. multipers/gudhi/gudhi/Persistence_matrix/columns/column_utilities.h +219 -219
  65. multipers/gudhi/gudhi/Persistence_matrix/columns/entry_types.h +327 -327
  66. multipers/gudhi/gudhi/Persistence_matrix/columns/heap_column.h +1140 -1140
  67. multipers/gudhi/gudhi/Persistence_matrix/columns/intrusive_list_column.h +934 -934
  68. multipers/gudhi/gudhi/Persistence_matrix/columns/intrusive_set_column.h +934 -934
  69. multipers/gudhi/gudhi/Persistence_matrix/columns/list_column.h +980 -980
  70. multipers/gudhi/gudhi/Persistence_matrix/columns/naive_vector_column.h +1092 -1092
  71. multipers/gudhi/gudhi/Persistence_matrix/columns/row_access.h +192 -192
  72. multipers/gudhi/gudhi/Persistence_matrix/columns/set_column.h +921 -921
  73. multipers/gudhi/gudhi/Persistence_matrix/columns/small_vector_column.h +1093 -1093
  74. multipers/gudhi/gudhi/Persistence_matrix/columns/unordered_set_column.h +1012 -1012
  75. multipers/gudhi/gudhi/Persistence_matrix/columns/vector_column.h +1244 -1244
  76. multipers/gudhi/gudhi/Persistence_matrix/matrix_dimension_holders.h +186 -186
  77. multipers/gudhi/gudhi/Persistence_matrix/matrix_row_access.h +164 -164
  78. multipers/gudhi/gudhi/Persistence_matrix/ru_pairing.h +156 -156
  79. multipers/gudhi/gudhi/Persistence_matrix/ru_rep_cycles.h +376 -376
  80. multipers/gudhi/gudhi/Persistence_matrix/ru_vine_swap.h +540 -540
  81. multipers/gudhi/gudhi/Persistent_cohomology/Field_Zp.h +118 -118
  82. multipers/gudhi/gudhi/Persistent_cohomology/Multi_field.h +173 -173
  83. multipers/gudhi/gudhi/Persistent_cohomology/Persistent_cohomology_column.h +128 -128
  84. multipers/gudhi/gudhi/Persistent_cohomology.h +745 -745
  85. multipers/gudhi/gudhi/Points_off_io.h +171 -171
  86. multipers/gudhi/gudhi/Simple_object_pool.h +69 -69
  87. multipers/gudhi/gudhi/Simplex_tree/Simplex_tree_iterators.h +463 -463
  88. multipers/gudhi/gudhi/Simplex_tree/Simplex_tree_node_explicit_storage.h +83 -83
  89. multipers/gudhi/gudhi/Simplex_tree/Simplex_tree_siblings.h +106 -106
  90. multipers/gudhi/gudhi/Simplex_tree/Simplex_tree_star_simplex_iterators.h +277 -277
  91. multipers/gudhi/gudhi/Simplex_tree/hooks_simplex_base.h +62 -62
  92. multipers/gudhi/gudhi/Simplex_tree/indexing_tag.h +27 -27
  93. multipers/gudhi/gudhi/Simplex_tree/serialization_utils.h +62 -62
  94. multipers/gudhi/gudhi/Simplex_tree/simplex_tree_options.h +157 -157
  95. multipers/gudhi/gudhi/Simplex_tree.h +2794 -2794
  96. multipers/gudhi/gudhi/Simplex_tree_multi.h +152 -163
  97. multipers/gudhi/gudhi/distance_functions.h +62 -62
  98. multipers/gudhi/gudhi/graph_simplicial_complex.h +104 -104
  99. multipers/gudhi/gudhi/persistence_interval.h +253 -253
  100. multipers/gudhi/gudhi/persistence_matrix_options.h +170 -170
  101. multipers/gudhi/gudhi/reader_utils.h +367 -367
  102. multipers/gudhi/mma_interface_coh.h +256 -255
  103. multipers/gudhi/mma_interface_h0.h +223 -231
  104. multipers/gudhi/mma_interface_matrix.h +291 -282
  105. multipers/gudhi/naive_merge_tree.h +536 -575
  106. multipers/gudhi/scc_io.h +310 -289
  107. multipers/gudhi/truc.h +957 -888
  108. multipers/io.cp311-win_amd64.pyd +0 -0
  109. multipers/io.pyx +714 -711
  110. multipers/ml/accuracies.py +90 -90
  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.cp311-win_amd64.pyd +0 -0
  120. multipers/mma_structures.pxd +127 -127
  121. multipers/mma_structures.pyx +4 -8
  122. multipers/mma_structures.pyx.tp +1083 -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 +2298 -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.cp311-win_amd64.pyd +0 -0
  148. multipers/multiparameter_module_approximation.pyx +218 -217
  149. multipers/pickle.py +90 -53
  150. multipers/plots.py +342 -334
  151. multipers/point_measure.cp311-win_amd64.pyd +0 -0
  152. multipers/point_measure.pyx +322 -320
  153. multipers/simplex_tree_multi.cp311-win_amd64.pyd +0 -0
  154. multipers/simplex_tree_multi.pxd +133 -133
  155. multipers/simplex_tree_multi.pyx +115 -48
  156. multipers/simplex_tree_multi.pyx.tp +1947 -1935
  157. multipers/slicer.cp311-win_amd64.pyd +0 -0
  158. multipers/slicer.pxd +301 -120
  159. multipers/slicer.pxd.tp +218 -214
  160. multipers/slicer.pyx +1570 -507
  161. multipers/slicer.pyx.tp +931 -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.1.dist-info}/LICENSE +21 -21
  169. {multipers-2.2.3.dist-info → multipers-2.3.1.dist-info}/METADATA +21 -11
  170. multipers-2.3.1.dist-info/RECORD +182 -0
  171. {multipers-2.2.3.dist-info → multipers-2.3.1.dist-info}/WHEEL +1 -1
  172. multipers/tests/test_diff_helper.py +0 -73
  173. multipers/tests/test_hilbert_function.py +0 -82
  174. multipers/tests/test_mma.py +0 -83
  175. multipers/tests/test_point_clouds.py +0 -49
  176. multipers/tests/test_python-cpp_conversion.py +0 -82
  177. multipers/tests/test_signed_betti.py +0 -181
  178. multipers/tests/test_signed_measure.py +0 -89
  179. multipers/tests/test_simplextreemulti.py +0 -221
  180. multipers/tests/test_slicer.py +0 -221
  181. multipers-2.2.3.dist-info/RECORD +0 -189
  182. {multipers-2.2.3.dist-info → multipers-2.3.1.dist-info}/top_level.txt +0 -0
@@ -1,400 +1,400 @@
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
4
- *
5
- * Copyright (C) 2024 Inria
6
- *
7
- * Modification(s):
8
- * - YYYY/MM Author: Description of the modification
9
- */
10
-
11
- /**
12
- * @file Zp_field_operators.h
13
- * @author Hannah Schreiber
14
- * @brief Contains the @ref Gudhi::persistence_fields::Zp_field_operators class.
15
- */
16
-
17
- #ifndef MATRIX_FIELD_ZP_OPERATOR_H_
18
- #define MATRIX_FIELD_ZP_OPERATOR_H_
19
-
20
- #include <stdexcept>
21
- #include <utility>
22
- #include <vector>
23
- #include <limits.h>
24
-
25
- namespace Gudhi {
26
- /// Field namespace
27
- namespace persistence_fields {
28
-
29
- /**
30
- * @class Zp_field_operators Zp_field_operators.h gudhi/Fields/Zp_field_operators.h
31
- * @ingroup persistence_fields
32
- *
33
- * @brief Class defining operators for the \f$ \mathbb{F}_p \f$ field for any prime number \f$ p \f$.
34
- *
35
- * @tparam Unsigned_integer_type A native unsigned integer type: unsigned int, long unsigned int, etc.
36
- * Will be used as the field element type.
37
- */
38
- template <typename Unsigned_integer_type = unsigned int,
39
- class = std::enable_if_t<std::is_unsigned_v<Unsigned_integer_type> > >
40
- class Zp_field_operators
41
- {
42
- public:
43
- using Element = Unsigned_integer_type; /**< Type for the elements in the field. */
44
- using Characteristic = Element; /**< Type for the field characteristic. */
45
- template <class T>
46
- using isSignedInteger = std::enable_if_t<std::is_signed_v<T> >;
47
-
48
- /**
49
- * @brief Default constructor. If a non-zero characteristic is given, initializes the field with it.
50
- * The characteristic can later be changed again or initialized with @ref set_characteristic.
51
- *
52
- * @param characteristic Prime number corresponding to the desired characteristic of the field.
53
- */
54
- Zp_field_operators(Characteristic characteristic = 0) : characteristic_(0) {
55
- if (characteristic != 0) set_characteristic(characteristic);
56
- }
57
- /**
58
- * @brief Copy constructor.
59
- *
60
- * @param toCopy Operators to copy.
61
- */
62
- Zp_field_operators(const Zp_field_operators& toCopy)
63
- : characteristic_(toCopy.characteristic_), inverse_(toCopy.inverse_) {}
64
- /**
65
- * @brief Move constructor.
66
- *
67
- * @param toMove Operators to move.
68
- */
69
- Zp_field_operators(Zp_field_operators&& toMove) noexcept
70
- : characteristic_(std::exchange(toMove.characteristic_, 0)), inverse_(std::move(toMove.inverse_)) {}
71
-
72
- /**
73
- * @brief Sets the characteristic of the field.
74
- *
75
- * @param characteristic Prime number corresponding to the desired characteristic of the field.
76
- */
77
- void set_characteristic(Characteristic characteristic) {
78
- if (characteristic <= 1)
79
- throw std::invalid_argument("Characteristic must be strictly positive and a prime number.");
80
-
81
- inverse_.resize(characteristic);
82
- inverse_[0] = 0;
83
- for (unsigned int i = 1; i < characteristic; ++i) {
84
- unsigned int inv = 1;
85
- unsigned int mult = inv * i;
86
- while ((mult % characteristic) != 1) {
87
- ++inv;
88
- if (mult == characteristic) throw std::invalid_argument("Characteristic must be a prime number.");
89
- mult = inv * i;
90
- }
91
- inverse_[i] = inv;
92
- }
93
-
94
- characteristic_ = characteristic;
95
- }
96
- /**
97
- * @brief Returns the current characteristic.
98
- *
99
- * @return The value of the current characteristic.
100
- */
101
- const Characteristic& get_characteristic() const { return characteristic_; }
102
-
103
- /**
104
- * @brief Returns the value of an integer in the field.
105
- * That is the positive value of the integer modulo the current characteristic.
106
- *
107
- * @param e Unsigned integer to return the value from.
108
- * @return @p e modulo the current characteristic, such that the result is positive.
109
- */
110
- Element get_value(Element e) const { return e < characteristic_ ? e : e % characteristic_; }
111
- /**
112
- * @brief Returns the value of an integer in the field.
113
- * That is the positive value of the integer modulo the current characteristic.
114
- *
115
- * @tparam Signed_integer_type A native signed integer type: int, long int, etc.
116
- * @param e Integer to return the value from.
117
- * @return @p e modulo the current characteristic, such that the result is positive.
118
- */
119
- template <typename Signed_integer_type, class = isSignedInteger<Signed_integer_type> >
120
- Element get_value(Signed_integer_type e) const {
121
- if (e < -static_cast<Signed_integer_type>(characteristic_)) e = e % characteristic_;
122
- if (e < 0) return e += characteristic_;
123
- return e < static_cast<Signed_integer_type>(characteristic_) ? e : e % characteristic_;
124
- }
125
-
126
- /**
127
- * @brief Returns the sum of two elements in the field.
128
- *
129
- * @param e1 First element.
130
- * @param e2 Second element.
131
- * @return `(e1 + e2) % characteristic`, such that the result is positive.
132
- */
133
- Element add(Element e1, Element e2) const {
134
- return _add(get_value(e1), get_value(e2), characteristic_);
135
- }
136
-
137
- /**
138
- * @brief Stores in the first element the sum of two given elements in the field, that is
139
- * `(e1 + e2) % characteristic`, such that the result is positive.
140
- *
141
- * @param e1 First element.
142
- * @param e2 Second element.
143
- */
144
- void add_inplace(Element& e1, Element e2) const {
145
- e1 = _add(get_value(e1), get_value(e2), characteristic_);
146
- }
147
-
148
- /**
149
- * @brief Returns the subtraction in the field of the first element by the second element.
150
- *
151
- * @param e1 First element.
152
- * @param e2 Second element.
153
- * @return `(e1 - e2) % characteristic`, such that the result is positive.
154
- */
155
- Element subtract(Element e1, Element e2) const {
156
- return _subtract(get_value(e1), get_value(e2), characteristic_);
157
- }
158
-
159
- /**
160
- * @brief Stores in the first element the subtraction in the field of the first element by the second element,
161
- * that is `(e1 - e2) % 2`, such that the result is positive.
162
- *
163
- * @param e1 First element.
164
- * @param e2 Second element.
165
- */
166
- void subtract_inplace_front(Element& e1, Element e2) const {
167
- e1 = _subtract(get_value(e1), get_value(e2), characteristic_);
168
- }
169
- /**
170
- * @brief Stores in the second element the subtraction in the field of the first element by the second element,
171
- * that is `(e1 - e2) % 2`, such that the result is positive.
172
- *
173
- * @param e1 First element.
174
- * @param e2 Second element.
175
- */
176
- void subtract_inplace_back(Element e1, Element& e2) const {
177
- e2 = _subtract(get_value(e1), get_value(e2), characteristic_);
178
- }
179
-
180
- /**
181
- * @brief Returns the multiplication of two elements in the field.
182
- *
183
- * @param e1 First element.
184
- * @param e2 Second element.
185
- * @return `(e1 * e2) % characteristic`, such that the result is positive.
186
- */
187
- Element multiply(Element e1, Element e2) const {
188
- return _multiply(get_value(e1), get_value(e2), characteristic_);
189
- }
190
-
191
- /**
192
- * @brief Stores in the first element the multiplication of two given elements in the field,
193
- * that is `(e1 * e2) % characteristic`, such that the result is positive.
194
- *
195
- * @param e1 First element.
196
- * @param e2 Second element.
197
- */
198
- void multiply_inplace(Element& e1, Element e2) const {
199
- e1 = _multiply(get_value(e1), get_value(e2), characteristic_);
200
- }
201
-
202
- /**
203
- * @brief Multiplies the first element with the second one and adds the third one. Returns the result in the field.
204
- *
205
- * @warning Not overflow safe.
206
- *
207
- * @param e First element.
208
- * @param m Second element.
209
- * @param a Third element.
210
- * @return `(e * m + a) % characteristic`, such that the result is positive.
211
- */
212
- Element multiply_and_add(Element e, Element m, Element a) const { return get_value(e * m + a); }
213
-
214
- /**
215
- * @brief Multiplies the first element with the second one and adds the third one, that is
216
- * `(e * m + a) % characteristic`, such that the result is positive. Stores the result in the first element.
217
- *
218
- * @warning Not overflow safe.
219
- *
220
- * @param e First element.
221
- * @param m Second element.
222
- * @param a Third element.
223
- */
224
- void multiply_and_add_inplace_front(Element& e, Element m, Element a) const {
225
- e = get_value(e * m + a);
226
- }
227
- /**
228
- * @brief Multiplies the first element with the second one and adds the third one, that is
229
- * `(e * m + a) % characteristic`, such that the result is positive. Stores the result in the third element.
230
- *
231
- * @warning Not overflow safe.
232
- *
233
- * @param e First element.
234
- * @param m Second element.
235
- * @param a Third element.
236
- */
237
- void multiply_and_add_inplace_back(Element e, Element m, Element& a) const {
238
- a = get_value(e * m + a);
239
- }
240
-
241
- /**
242
- * @brief Adds the first element to the second one and multiplies the third one with it.
243
- * Returns the result in the field.
244
- *
245
- * @warning Not overflow safe.
246
- *
247
- * @param e First element.
248
- * @param a Second element.
249
- * @param m Third element.
250
- * @return `((e + a) * m) % characteristic`, such that the result is positive.
251
- */
252
- Element add_and_multiply(Element e, Element a, Element m) const { return get_value((e + a) * m); }
253
-
254
- /**
255
- * @brief Adds the first element to the second one and multiplies the third one with it, that is
256
- * `((e + a) * m) % characteristic`, such that the result is positive. Stores the result in the first element.
257
- *
258
- * @warning Not overflow safe.
259
- *
260
- * @param e First element.
261
- * @param a Second element.
262
- * @param m Third element.
263
- */
264
- void add_and_multiply_inplace_front(Element& e, Element a, Element m) const {
265
- e = get_value((e + a) * m);
266
- }
267
- /**
268
- * @brief Adds the first element to the second one and multiplies the third one with it, that is
269
- * `((e + a) * m) % characteristic`, such that the result is positive. Stores the result in the third element.
270
- *
271
- * @warning Not overflow safe.
272
- *
273
- * @param e First element.
274
- * @param a Second element.
275
- * @param m Third element.
276
- */
277
- void add_and_multiply_inplace_back(Element e, Element a, Element& m) const {
278
- m = get_value((e + a) * m);
279
- }
280
-
281
- /**
282
- * @brief Returns true if the two given elements are equal in the field, false otherwise.
283
- *
284
- * @param e1 First element to compare.
285
- * @param e2 Second element to compare.
286
- * @return true If `e1 % characteristic == e2 % characteristic`.
287
- * @return false Otherwise.
288
- */
289
- bool are_equal(Element e1, Element e2) const { return get_value(e1) == get_value(e2); }
290
-
291
- /**
292
- * @brief Returns the inverse of the given element in the field.
293
- *
294
- * @param e Element to get the inverse from.
295
- * @return Inverse in the current field of `e % characteristic`.
296
- */
297
- Element get_inverse(Element e) const { return inverse_[get_value(e)]; }
298
- /**
299
- * @brief For interface purposes with multi-fields. Returns the inverse together with the second argument.
300
- *
301
- * @param e Element to get the inverse from.
302
- * @param productOfCharacteristics Some value.
303
- * @return Pair whose first element is the inverse of @p e and the second element is @p productOfCharacteristics.
304
- */
305
- std::pair<Element, Characteristic> get_partial_inverse(Element e,
306
- Characteristic productOfCharacteristics) const {
307
- return {get_inverse(e), productOfCharacteristics};
308
- }
309
-
310
- /**
311
- * @brief Returns the additive identity of the field.
312
- *
313
- * @return 0.
314
- */
315
- static constexpr Element get_additive_identity() { return 0; }
316
- /**
317
- * @brief Returns the multiplicative identity of the field.
318
- *
319
- * @return 1.
320
- */
321
- static constexpr Element get_multiplicative_identity() { return 1; }
322
- /**
323
- * @brief For interface purposes with multi-fields. Returns the multiplicative identity of the field.
324
- *
325
- * @param productOfCharacteristics Some value.
326
- * @return 1.
327
- */
328
- static constexpr Element get_partial_multiplicative_identity(
329
- [[maybe_unused]] Characteristic productOfCharacteristics) {
330
- return 1;
331
- }
332
-
333
- // static constexpr bool handles_only_z2() { return false; }
334
-
335
- /**
336
- * @brief Assign operator.
337
- */
338
- Zp_field_operators& operator=(Zp_field_operators other) {
339
- std::swap(characteristic_, other.characteristic_);
340
- inverse_.swap(other.inverse_);
341
- return *this;
342
- }
343
- /**
344
- * @brief Swap operator.
345
- */
346
- friend void swap(Zp_field_operators& f1, Zp_field_operators& f2) {
347
- std::swap(f1.characteristic_, f2.characteristic_);
348
- f1.inverse_.swap(f2.inverse_);
349
- }
350
-
351
- private:
352
- Characteristic characteristic_; /**< Current characteristic of the field. */
353
- std::vector<Element> inverse_; /**< All inverse elements. */
354
-
355
- static Element _add(Element e1, Element e2, Characteristic characteristic) {
356
- if (UINT_MAX - e1 < e2) {
357
- // automatic unsigned integer overflow behaviour will make it work
358
- e1 += e2;
359
- e1 -= characteristic;
360
- return e1;
361
- }
362
-
363
- e1 += e2;
364
- if (e1 >= characteristic) e1 -= characteristic;
365
-
366
- return e1;
367
- }
368
- static Element _subtract(Element e1, Element e2, Characteristic characteristic) {
369
- if (e1 < e2) {
370
- e1 += characteristic;
371
- }
372
- e1 -= e2;
373
-
374
- return e1;
375
- }
376
- static Element _multiply(Element e1, Element e2, Characteristic characteristic) {
377
- unsigned int a = e1;
378
- e1 = 0;
379
- unsigned int temp_b;
380
-
381
- while (a != 0) {
382
- if (a & 1) {
383
- if (e2 >= characteristic - e1) e1 -= characteristic;
384
- e1 += e2;
385
- }
386
- a >>= 1;
387
-
388
- temp_b = e2;
389
- if (e2 >= characteristic - e2) temp_b -= characteristic;
390
- e2 += temp_b;
391
- }
392
-
393
- return e1;
394
- }
395
- };
396
-
397
- } // namespace persistence_fields
398
- } // namespace Gudhi
399
-
400
- #endif // MATRIX_FIELD_ZP_OPERATOR_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
4
+ *
5
+ * Copyright (C) 2024 Inria
6
+ *
7
+ * Modification(s):
8
+ * - YYYY/MM Author: Description of the modification
9
+ */
10
+
11
+ /**
12
+ * @file Zp_field_operators.h
13
+ * @author Hannah Schreiber
14
+ * @brief Contains the @ref Gudhi::persistence_fields::Zp_field_operators class.
15
+ */
16
+
17
+ #ifndef MATRIX_FIELD_ZP_OPERATOR_H_
18
+ #define MATRIX_FIELD_ZP_OPERATOR_H_
19
+
20
+ #include <stdexcept>
21
+ #include <utility>
22
+ #include <vector>
23
+ #include <limits.h>
24
+
25
+ namespace Gudhi {
26
+ /// Field namespace
27
+ namespace persistence_fields {
28
+
29
+ /**
30
+ * @class Zp_field_operators Zp_field_operators.h gudhi/Fields/Zp_field_operators.h
31
+ * @ingroup persistence_fields
32
+ *
33
+ * @brief Class defining operators for the \f$ \mathbb{F}_p \f$ field for any prime number \f$ p \f$.
34
+ *
35
+ * @tparam Unsigned_integer_type A native unsigned integer type: unsigned int, long unsigned int, etc.
36
+ * Will be used as the field element type.
37
+ */
38
+ template <typename Unsigned_integer_type = unsigned int,
39
+ class = std::enable_if_t<std::is_unsigned_v<Unsigned_integer_type> > >
40
+ class Zp_field_operators
41
+ {
42
+ public:
43
+ using Element = Unsigned_integer_type; /**< Type for the elements in the field. */
44
+ using Characteristic = Element; /**< Type for the field characteristic. */
45
+ template <class T>
46
+ using isSignedInteger = std::enable_if_t<std::is_signed_v<T> >;
47
+
48
+ /**
49
+ * @brief Default constructor. If a non-zero characteristic is given, initializes the field with it.
50
+ * The characteristic can later be changed again or initialized with @ref set_characteristic.
51
+ *
52
+ * @param characteristic Prime number corresponding to the desired characteristic of the field.
53
+ */
54
+ Zp_field_operators(Characteristic characteristic = 0) : characteristic_(0) {
55
+ if (characteristic != 0) set_characteristic(characteristic);
56
+ }
57
+ /**
58
+ * @brief Copy constructor.
59
+ *
60
+ * @param toCopy Operators to copy.
61
+ */
62
+ Zp_field_operators(const Zp_field_operators& toCopy)
63
+ : characteristic_(toCopy.characteristic_), inverse_(toCopy.inverse_) {}
64
+ /**
65
+ * @brief Move constructor.
66
+ *
67
+ * @param toMove Operators to move.
68
+ */
69
+ Zp_field_operators(Zp_field_operators&& toMove) noexcept
70
+ : characteristic_(std::exchange(toMove.characteristic_, 0)), inverse_(std::move(toMove.inverse_)) {}
71
+
72
+ /**
73
+ * @brief Sets the characteristic of the field.
74
+ *
75
+ * @param characteristic Prime number corresponding to the desired characteristic of the field.
76
+ */
77
+ void set_characteristic(Characteristic characteristic) {
78
+ if (characteristic <= 1)
79
+ throw std::invalid_argument("Characteristic must be strictly positive and a prime number.");
80
+
81
+ inverse_.resize(characteristic);
82
+ inverse_[0] = 0;
83
+ for (unsigned int i = 1; i < characteristic; ++i) {
84
+ unsigned int inv = 1;
85
+ unsigned int mult = inv * i;
86
+ while ((mult % characteristic) != 1) {
87
+ ++inv;
88
+ if (mult == characteristic) throw std::invalid_argument("Characteristic must be a prime number.");
89
+ mult = inv * i;
90
+ }
91
+ inverse_[i] = inv;
92
+ }
93
+
94
+ characteristic_ = characteristic;
95
+ }
96
+ /**
97
+ * @brief Returns the current characteristic.
98
+ *
99
+ * @return The value of the current characteristic.
100
+ */
101
+ const Characteristic& get_characteristic() const { return characteristic_; }
102
+
103
+ /**
104
+ * @brief Returns the value of an integer in the field.
105
+ * That is the positive value of the integer modulo the current characteristic.
106
+ *
107
+ * @param e Unsigned integer to return the value from.
108
+ * @return @p e modulo the current characteristic, such that the result is positive.
109
+ */
110
+ Element get_value(Element e) const { return e < characteristic_ ? e : e % characteristic_; }
111
+ /**
112
+ * @brief Returns the value of an integer in the field.
113
+ * That is the positive value of the integer modulo the current characteristic.
114
+ *
115
+ * @tparam Signed_integer_type A native signed integer type: int, long int, etc.
116
+ * @param e Integer to return the value from.
117
+ * @return @p e modulo the current characteristic, such that the result is positive.
118
+ */
119
+ template <typename Signed_integer_type, class = isSignedInteger<Signed_integer_type> >
120
+ Element get_value(Signed_integer_type e) const {
121
+ if (e < -static_cast<Signed_integer_type>(characteristic_)) e = e % characteristic_;
122
+ if (e < 0) return e += characteristic_;
123
+ return e < static_cast<Signed_integer_type>(characteristic_) ? e : e % characteristic_;
124
+ }
125
+
126
+ /**
127
+ * @brief Returns the sum of two elements in the field.
128
+ *
129
+ * @param e1 First element.
130
+ * @param e2 Second element.
131
+ * @return `(e1 + e2) % characteristic`, such that the result is positive.
132
+ */
133
+ Element add(Element e1, Element e2) const {
134
+ return _add(get_value(e1), get_value(e2), characteristic_);
135
+ }
136
+
137
+ /**
138
+ * @brief Stores in the first element the sum of two given elements in the field, that is
139
+ * `(e1 + e2) % characteristic`, such that the result is positive.
140
+ *
141
+ * @param e1 First element.
142
+ * @param e2 Second element.
143
+ */
144
+ void add_inplace(Element& e1, Element e2) const {
145
+ e1 = _add(get_value(e1), get_value(e2), characteristic_);
146
+ }
147
+
148
+ /**
149
+ * @brief Returns the subtraction in the field of the first element by the second element.
150
+ *
151
+ * @param e1 First element.
152
+ * @param e2 Second element.
153
+ * @return `(e1 - e2) % characteristic`, such that the result is positive.
154
+ */
155
+ Element subtract(Element e1, Element e2) const {
156
+ return _subtract(get_value(e1), get_value(e2), characteristic_);
157
+ }
158
+
159
+ /**
160
+ * @brief Stores in the first element the subtraction in the field of the first element by the second element,
161
+ * that is `(e1 - e2) % 2`, such that the result is positive.
162
+ *
163
+ * @param e1 First element.
164
+ * @param e2 Second element.
165
+ */
166
+ void subtract_inplace_front(Element& e1, Element e2) const {
167
+ e1 = _subtract(get_value(e1), get_value(e2), characteristic_);
168
+ }
169
+ /**
170
+ * @brief Stores in the second element the subtraction in the field of the first element by the second element,
171
+ * that is `(e1 - e2) % 2`, such that the result is positive.
172
+ *
173
+ * @param e1 First element.
174
+ * @param e2 Second element.
175
+ */
176
+ void subtract_inplace_back(Element e1, Element& e2) const {
177
+ e2 = _subtract(get_value(e1), get_value(e2), characteristic_);
178
+ }
179
+
180
+ /**
181
+ * @brief Returns the multiplication of two elements in the field.
182
+ *
183
+ * @param e1 First element.
184
+ * @param e2 Second element.
185
+ * @return `(e1 * e2) % characteristic`, such that the result is positive.
186
+ */
187
+ Element multiply(Element e1, Element e2) const {
188
+ return _multiply(get_value(e1), get_value(e2), characteristic_);
189
+ }
190
+
191
+ /**
192
+ * @brief Stores in the first element the multiplication of two given elements in the field,
193
+ * that is `(e1 * e2) % characteristic`, such that the result is positive.
194
+ *
195
+ * @param e1 First element.
196
+ * @param e2 Second element.
197
+ */
198
+ void multiply_inplace(Element& e1, Element e2) const {
199
+ e1 = _multiply(get_value(e1), get_value(e2), characteristic_);
200
+ }
201
+
202
+ /**
203
+ * @brief Multiplies the first element with the second one and adds the third one. Returns the result in the field.
204
+ *
205
+ * @warning Not overflow safe.
206
+ *
207
+ * @param e First element.
208
+ * @param m Second element.
209
+ * @param a Third element.
210
+ * @return `(e * m + a) % characteristic`, such that the result is positive.
211
+ */
212
+ Element multiply_and_add(Element e, Element m, Element a) const { return get_value(e * m + a); }
213
+
214
+ /**
215
+ * @brief Multiplies the first element with the second one and adds the third one, that is
216
+ * `(e * m + a) % characteristic`, such that the result is positive. Stores the result in the first element.
217
+ *
218
+ * @warning Not overflow safe.
219
+ *
220
+ * @param e First element.
221
+ * @param m Second element.
222
+ * @param a Third element.
223
+ */
224
+ void multiply_and_add_inplace_front(Element& e, Element m, Element a) const {
225
+ e = get_value(e * m + a);
226
+ }
227
+ /**
228
+ * @brief Multiplies the first element with the second one and adds the third one, that is
229
+ * `(e * m + a) % characteristic`, such that the result is positive. Stores the result in the third element.
230
+ *
231
+ * @warning Not overflow safe.
232
+ *
233
+ * @param e First element.
234
+ * @param m Second element.
235
+ * @param a Third element.
236
+ */
237
+ void multiply_and_add_inplace_back(Element e, Element m, Element& a) const {
238
+ a = get_value(e * m + a);
239
+ }
240
+
241
+ /**
242
+ * @brief Adds the first element to the second one and multiplies the third one with it.
243
+ * Returns the result in the field.
244
+ *
245
+ * @warning Not overflow safe.
246
+ *
247
+ * @param e First element.
248
+ * @param a Second element.
249
+ * @param m Third element.
250
+ * @return `((e + a) * m) % characteristic`, such that the result is positive.
251
+ */
252
+ Element add_and_multiply(Element e, Element a, Element m) const { return get_value((e + a) * m); }
253
+
254
+ /**
255
+ * @brief Adds the first element to the second one and multiplies the third one with it, that is
256
+ * `((e + a) * m) % characteristic`, such that the result is positive. Stores the result in the first element.
257
+ *
258
+ * @warning Not overflow safe.
259
+ *
260
+ * @param e First element.
261
+ * @param a Second element.
262
+ * @param m Third element.
263
+ */
264
+ void add_and_multiply_inplace_front(Element& e, Element a, Element m) const {
265
+ e = get_value((e + a) * m);
266
+ }
267
+ /**
268
+ * @brief Adds the first element to the second one and multiplies the third one with it, that is
269
+ * `((e + a) * m) % characteristic`, such that the result is positive. Stores the result in the third element.
270
+ *
271
+ * @warning Not overflow safe.
272
+ *
273
+ * @param e First element.
274
+ * @param a Second element.
275
+ * @param m Third element.
276
+ */
277
+ void add_and_multiply_inplace_back(Element e, Element a, Element& m) const {
278
+ m = get_value((e + a) * m);
279
+ }
280
+
281
+ /**
282
+ * @brief Returns true if the two given elements are equal in the field, false otherwise.
283
+ *
284
+ * @param e1 First element to compare.
285
+ * @param e2 Second element to compare.
286
+ * @return true If `e1 % characteristic == e2 % characteristic`.
287
+ * @return false Otherwise.
288
+ */
289
+ bool are_equal(Element e1, Element e2) const { return get_value(e1) == get_value(e2); }
290
+
291
+ /**
292
+ * @brief Returns the inverse of the given element in the field.
293
+ *
294
+ * @param e Element to get the inverse from.
295
+ * @return Inverse in the current field of `e % characteristic`.
296
+ */
297
+ Element get_inverse(Element e) const { return inverse_[get_value(e)]; }
298
+ /**
299
+ * @brief For interface purposes with multi-fields. Returns the inverse together with the second argument.
300
+ *
301
+ * @param e Element to get the inverse from.
302
+ * @param productOfCharacteristics Some value.
303
+ * @return Pair whose first element is the inverse of @p e and the second element is @p productOfCharacteristics.
304
+ */
305
+ std::pair<Element, Characteristic> get_partial_inverse(Element e,
306
+ Characteristic productOfCharacteristics) const {
307
+ return {get_inverse(e), productOfCharacteristics};
308
+ }
309
+
310
+ /**
311
+ * @brief Returns the additive identity of the field.
312
+ *
313
+ * @return 0.
314
+ */
315
+ static constexpr Element get_additive_identity() { return 0; }
316
+ /**
317
+ * @brief Returns the multiplicative identity of the field.
318
+ *
319
+ * @return 1.
320
+ */
321
+ static constexpr Element get_multiplicative_identity() { return 1; }
322
+ /**
323
+ * @brief For interface purposes with multi-fields. Returns the multiplicative identity of the field.
324
+ *
325
+ * @param productOfCharacteristics Some value.
326
+ * @return 1.
327
+ */
328
+ static constexpr Element get_partial_multiplicative_identity(
329
+ [[maybe_unused]] Characteristic productOfCharacteristics) {
330
+ return 1;
331
+ }
332
+
333
+ // static constexpr bool handles_only_z2() { return false; }
334
+
335
+ /**
336
+ * @brief Assign operator.
337
+ */
338
+ Zp_field_operators& operator=(Zp_field_operators other) {
339
+ std::swap(characteristic_, other.characteristic_);
340
+ inverse_.swap(other.inverse_);
341
+ return *this;
342
+ }
343
+ /**
344
+ * @brief Swap operator.
345
+ */
346
+ friend void swap(Zp_field_operators& f1, Zp_field_operators& f2) {
347
+ std::swap(f1.characteristic_, f2.characteristic_);
348
+ f1.inverse_.swap(f2.inverse_);
349
+ }
350
+
351
+ private:
352
+ Characteristic characteristic_; /**< Current characteristic of the field. */
353
+ std::vector<Element> inverse_; /**< All inverse elements. */
354
+
355
+ static Element _add(Element e1, Element e2, Characteristic characteristic) {
356
+ if (UINT_MAX - e1 < e2) {
357
+ // automatic unsigned integer overflow behaviour will make it work
358
+ e1 += e2;
359
+ e1 -= characteristic;
360
+ return e1;
361
+ }
362
+
363
+ e1 += e2;
364
+ if (e1 >= characteristic) e1 -= characteristic;
365
+
366
+ return e1;
367
+ }
368
+ static Element _subtract(Element e1, Element e2, Characteristic characteristic) {
369
+ if (e1 < e2) {
370
+ e1 += characteristic;
371
+ }
372
+ e1 -= e2;
373
+
374
+ return e1;
375
+ }
376
+ static Element _multiply(Element e1, Element e2, Characteristic characteristic) {
377
+ unsigned int a = e1;
378
+ e1 = 0;
379
+ unsigned int temp_b;
380
+
381
+ while (a != 0) {
382
+ if (a & 1) {
383
+ if (e2 >= characteristic - e1) e1 -= characteristic;
384
+ e1 += e2;
385
+ }
386
+ a >>= 1;
387
+
388
+ temp_b = e2;
389
+ if (e2 >= characteristic - e2) temp_b -= characteristic;
390
+ e2 += temp_b;
391
+ }
392
+
393
+ return e1;
394
+ }
395
+ };
396
+
397
+ } // namespace persistence_fields
398
+ } // namespace Gudhi
399
+
400
+ #endif // MATRIX_FIELD_ZP_OPERATOR_H_