Class representing an element of a multi-field. If each instantiation of the class can represent another element, they all share the same characteristics. That is if the characteristics are set for one, they will be set for all the others. The characteristics can be set before instantiating the elements with the static Shared_multi_field_element::initialize method.
More...
#include <gudhi/Fields/Multi_field_shared.h>
|
void | operator+= (Shared_multi_field_element &f1, Shared_multi_field_element const &f2) |
| operator+=
|
|
Shared_multi_field_element | operator+ (Shared_multi_field_element f1, Shared_multi_field_element const &f2) |
| operator+
|
|
void | operator+= (Shared_multi_field_element &f, Element const v) |
| operator+=
|
|
Shared_multi_field_element | operator+ (Shared_multi_field_element f, Element const v) |
| operator+
|
|
Element | operator+ (Element v, Shared_multi_field_element const &f) |
| operator+
|
|
void | operator-= (Shared_multi_field_element &f1, Shared_multi_field_element const &f2) |
| operator-=
|
|
Shared_multi_field_element | operator- (Shared_multi_field_element f1, Shared_multi_field_element const &f2) |
| operator-
|
|
void | operator-= (Shared_multi_field_element &f, Element const v) |
| operator-=
|
|
Shared_multi_field_element | operator- (Shared_multi_field_element f, Element const v) |
| operator-
|
|
Element | operator- (Element v, Shared_multi_field_element const &f) |
| operator-
|
|
void | operator*= (Shared_multi_field_element &f1, Shared_multi_field_element const &f2) |
| operator*=
|
|
Shared_multi_field_element | operator* (Shared_multi_field_element f1, Shared_multi_field_element const &f2) |
| operator*
|
|
void | operator*= (Shared_multi_field_element &f, Element const v) |
| operator*=
|
|
Shared_multi_field_element | operator* (Shared_multi_field_element f, Element const v) |
| operator*
|
|
Element | operator* (Element v, Shared_multi_field_element const &f) |
| operator*
|
|
bool | operator== (const Shared_multi_field_element &f1, const Shared_multi_field_element &f2) |
| operator==
|
|
bool | operator== (const Element &v, const Shared_multi_field_element &f) |
| operator==
|
|
bool | operator== (const Shared_multi_field_element &f, const Element &v) |
| operator==
|
|
bool | operator!= (const Shared_multi_field_element &f1, const Shared_multi_field_element &f2) |
| operator!=
|
|
bool | operator!= (const Element &v, const Shared_multi_field_element &f) |
| operator!=
|
|
bool | operator!= (const Shared_multi_field_element &f, const Element &v) |
| operator!=
|
|
void | swap (Shared_multi_field_element &f1, Shared_multi_field_element &f2) |
| Swap operator.
|
|
Class representing an element of a multi-field. If each instantiation of the class can represent another element, they all share the same characteristics. That is if the characteristics are set for one, they will be set for all the others. The characteristics can be set before instantiating the elements with the static Shared_multi_field_element::initialize method.
◆ Characteristic
Type for the field characteristic.
◆ Element
Type for the elements in the field.
◆ Shared_multi_field_element() [1/3]
Gudhi::persistence_fields::Shared_multi_field_element::Shared_multi_field_element |
( |
Element |
element | ) |
|
|
inline |
Constructor setting the element to the given value.
- Parameters
-
element | Value of the element. |
◆ Shared_multi_field_element() [2/3]
Copy constructor.
- Parameters
-
◆ Shared_multi_field_element() [3/3]
Move constructor.
- Parameters
-
◆ get_additive_identity()
Returns the additive identity of a field.
- Returns
- The additive identity of a field.
◆ get_characteristic()
Returns the product of all characteristics.
- Returns
- The product of all characteristics.
◆ get_inverse()
Returns the inverse of the element in the multi-field, see [boissonnat:hal-00922572].
- Returns
- The inverse.
◆ get_multiplicative_identity()
Returns the multiplicative identity of a field.
- Returns
- The multiplicative identity of a field.
◆ get_partial_inverse()
Returns the inverse of the element with respect to a sub-product of the characteristics in the multi-field, see [boissonnat:hal-00922572].
- Parameters
-
productOfCharacteristics | Sub-product of the characteristics. |
- Returns
- Pair of the inverse and the characteristic the inverse corresponds to.
◆ get_partial_multiplicative_identity()
Returns the partial multiplicative identity of the multi-field from the given product. See [boissonnat:hal-00922572] for more details.
- Parameters
-
productOfCharacteristics | Product of the different characteristics to take into account in the multi-field. |
- Returns
- The partial multiplicative identity of the multi-field.
◆ get_value()
Returns the value of the element.
- Returns
- Value of the element.
◆ initialize()
void Gudhi::persistence_fields::Shared_multi_field_element::initialize |
( |
unsigned int |
minimum, |
|
|
unsigned int |
maximum |
|
) |
| |
|
inlinestatic |
Initialize the multi-field to the characteristics (primes) contained in the given interval. Should be called first before constructing the field elements.
- Parameters
-
minimum | Lowest value in the interval. |
maximum | Highest value in the interval. |
The documentation for this class was generated from the following file: