forked from GUDHI/gudhi-devel
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request GUDHI#669 from hschreiber/persistence_matrix
Persistence matrix module
- Loading branch information
Showing
87 changed files
with
35,123 additions
and
83 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| /* This file is part of the Gudhi Library - https://gudhi.inria.fr/ - which is released under MIT. | ||
| * See file LICENSE or go to https://gudhi.inria.fr/licensing/ for full license details. | ||
| * Author(s): Hannah Schreiber | ||
| * | ||
| * Copyright (C) 2024 Inria | ||
| * | ||
| * Modification(s): | ||
| * - YYYY/MM Author: Description of the modification | ||
| */ | ||
|
|
||
| /** | ||
| * @file FieldOperators.h | ||
| * @author Hannah Schreiber | ||
| * @brief Contains the concept for the matrix field operators. | ||
| */ | ||
|
|
||
| namespace Gudhi { | ||
| namespace persistence_matrix { | ||
|
|
||
| /** | ||
| * @ingroup persistence_matrix | ||
| * | ||
| * @brief Concept of the field operator classes needed for the class @ref Matrix. | ||
| * | ||
| * Implementations of this concept are @ref Gudhi::persistence_fields::Zp_field_operators, | ||
| * @ref Gudhi::persistence_fields::Z2_field_operators, | ||
| * @ref Gudhi::persistence_fields::Multi_field_operators and | ||
| * @ref Gudhi::persistence_fields::Multi_field_operators_with_small_characteristics. | ||
| */ | ||
| class FieldOperators | ||
| { | ||
| public: | ||
| using element_type = unspecified; /**< Type for the elements in the field. */ | ||
| using characteristic_type = unspecified; /**< Type for the field characteristic. */ | ||
|
|
||
| /** | ||
| * @brief Default constructor. If a non-zero characteristic is given, initializes the field with it. | ||
| * The characteristic can later be changed again or initialized with @ref set_characteristic. | ||
| * | ||
| * @param characteristic Prime number corresponding to the desired characteristic of the field. | ||
| */ | ||
| FieldOperators(characteristic_type characteristic = 0); | ||
|
|
||
| /** | ||
| * @brief Sets the characteristic of the field. Can eventually be omitted if the characteristic of the class | ||
| * is fixed. | ||
| * | ||
| * @param characteristic Prime number corresponding to the desired characteristic of the field. | ||
| */ | ||
| void set_characteristic(const characteristic_type& characteristic); | ||
| /** | ||
| * @brief Returns the current characteristic. | ||
| * | ||
| * @return The value of the current characteristic. | ||
| */ | ||
| const characteristic_type& get_characteristic() const; | ||
|
|
||
| /** | ||
| * @brief Returns the value of an integer in the field. | ||
| * That is the positive value of the integer modulo the current characteristic. | ||
| * | ||
| * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc. | ||
| * @param e Integer to return the value from. | ||
| * @return @p e modulo the current characteristic, such that the result is positive. | ||
| */ | ||
| template <typename Integer_type> | ||
| element_type get_value(Integer_type e) const; | ||
|
|
||
| // void get_value(element_type& e) const; | ||
|
|
||
| /** | ||
| * @brief Stores in the first element the sum of two given elements in the field, that is | ||
| * `(e1 + e2) % characteristic`, such that the result is positive. | ||
| * | ||
| * @param e1 First element. | ||
| * @param e2 Second element. | ||
| */ | ||
| void add_inplace(element_type& e1, const element_type& e2) const; | ||
|
|
||
| /** | ||
| * @brief Stores in the first element the multiplication of two given elements in the field, | ||
| * that is `(e1 * e2) % characteristic`, such that the result is positive. | ||
| * | ||
| * @param e1 First element. | ||
| * @param e2 Second element. | ||
| */ | ||
| void multiply_inplace(element_type& e1, const element_type& e2) const; | ||
|
|
||
| /** | ||
| * @brief Multiplies the first element with the second one and adds the third one, that is | ||
| * `(e * m + a) % characteristic`, such that the result is positive. Stores the result in the first element. | ||
| * | ||
| * @param e First element. | ||
| * @param m Second element. | ||
| * @param a Third element. | ||
| */ | ||
| void multiply_and_add_inplace_front(element_type& e, const element_type& m, const element_type& a) const; | ||
| /** | ||
| * @brief Multiplies the first element with the second one and adds the third one, that is | ||
| * `(e * m + a) % characteristic`, such that the result is positive. Stores the result in the third element. | ||
| * | ||
| * @param e First element. | ||
| * @param m Second element. | ||
| * @param a Third element. | ||
| */ | ||
| void multiply_and_add_inplace_back(const element_type& e, const element_type& m, element_type& a) const; | ||
|
|
||
| /** | ||
| * @brief Returns the inverse of the given element in the field. | ||
| * | ||
| * @param e Element to get the inverse from. | ||
| * @return Inverse in the current field of `e % characteristic`. | ||
| */ | ||
| element_type get_inverse(const element_type& e) const; | ||
|
|
||
| /** | ||
| * @brief Returns the additive identity of the field. | ||
| * | ||
| * @return The additive identity of the field. | ||
| */ | ||
| static const element_type& get_additive_identity(); | ||
| /** | ||
| * @brief Returns the multiplicative identity of the field. | ||
| * | ||
| * @return The multiplicative identity of the field. | ||
| */ | ||
| static const element_type& get_multiplicative_identity(); | ||
|
|
||
| /** | ||
| * @brief Assign operator. | ||
| */ | ||
| FieldOperators& operator=(FieldOperators other); | ||
| /** | ||
| * @brief Swap operator. | ||
| */ | ||
| friend void swap(FieldOperators& f1, FieldOperators& f2); | ||
| }; | ||
|
|
||
| } // namespace persistence_matrix | ||
| } // namespace Gudhi |
Oops, something went wrong.