Make gf2() cast values in non-strict mode

- so far, `gf2()` runs in a `strict` mode by default
  => `gf2(42)` results in a `ValueError`
- we adapt `gf2()` (a.k.a. `lalib.elements.galois.GF2Element`)
  such that it behaves more like the built-in `bool()`
  => `gf2(42)` returns `one`, like `bool(42)` returns `True`
- further, the `GF2Element` class is adjusted such that
  `one` and `zero` assume their counterparts to be
  `1`-like or `0`-like objects during binary operations;
  other values result in an error
  => for example, `one + 1` works but `one + 42` does not
  => so, when used in binary operations, `one` and `zero`
     continue to cast their counterparts in `strict` mode
- simplify the casting logic
- make `value` a positional-only argument in `gf2()`
  (like most of the built-in constructors)
- provide more usage examples in the docstrings
  clarifying when `strict` mode is used and when not
- propagate the above changes to the test suite:
  + adapt test cases with regard to the `strict` mode logic
  + add new test cases to `assert` how `gf2()`
    can process `str`ings directly
  + rename two test cases involving `complex` numbers
    to mimic the naming from the newly added test cases
This commit is contained in:
Alexander Hess 2024-10-16 14:23:59 +02:00
commit 06c26192ad
Signed by: alexander
GPG key ID: 344EA5AB10D868E0
5 changed files with 162 additions and 21 deletions

View file

@ -33,14 +33,14 @@ class TestCastAndValidateFieldElements:
utils.is_field_element(GF2, value)
@pytest.mark.parametrize("pre_value", [1, 0])
def test_complex_number_is_field_element(self, pre_value):
"""By design, `GF2` can process `complex` numbers."""
def test_one_or_zero_like_complex_number_is_field_element(self, pre_value):
"""`GF2` can process `complex` numbers."""
value = complex(pre_value, 0)
utils.is_field_element(GF2, value)
@pytest.mark.parametrize("pre_value", [+42, -42])
def test_complex_number_is_not_field_element(self, pre_value):
"""By design, `GF2` can process `complex` numbers ...
def test_non_one_or_zero_like_complex_number_is_not_field_element(self, pre_value):
"""`GF2` can process `complex` numbers ...
... but they must be `one`-like or `zero`-like
to become a `GF2` element.
@ -48,6 +48,17 @@ class TestCastAndValidateFieldElements:
value = complex(pre_value, 0)
utils.is_not_field_element(GF2, value)
@pytest.mark.parametrize("pre_value", [+42, -42])
def test_non_one_or_zero_like_complex_number_is_field_element(self, pre_value):
"""`GF2` can process all `complex` numbers in non-`strict` mode."""
value = complex(pre_value, 0)
left = GF2.cast(value, strict=False)
right = bool(value)
assert left == right
assert GF2.validate(value, strict=False)
@pytest.mark.parametrize("pre_value", ["NaN", "+inf", "-inf"])
def test_non_finite_complex_number_is_not_field_element(self, pre_value):
"""For now, we only allow finite numbers as field elements.
@ -58,6 +69,36 @@ class TestCastAndValidateFieldElements:
value = complex(pre_value)
utils.is_not_field_element(GF2, value)
@pytest.mark.parametrize("value", ["1", "0"])
def test_one_or_zero_like_numeric_str_is_field_element(self, value):
"""`GF2` can process `str`ings resemling `1`s and `0`s."""
utils.is_field_element(GF2, value)
@pytest.mark.parametrize("value", ["+42", "-42"])
def test_non_one_or_zero_like_numeric_str_is_not_field_element(self, value):
"""`GF2` can process `str`ings resembling numbers ...
... but they must be `1`-like or `0`-like.
"""
utils.is_not_field_element(GF2, value)
@pytest.mark.parametrize("value", ["+42", "-42"])
def test_non_one_or_zero_like_numeric_str_is_field_element(self, value):
"""`GF2` can process `str`ings resemling any number in non-`strict` mode."""
left = GF2.cast(value, strict=False)
right = bool(float(value))
assert left == right
assert GF2.validate(value, strict=False)
@pytest.mark.parametrize("value", ["NaN", "+inf", "-inf"])
def test_non_finite_numeric_str_is_not_field_element(self, value):
"""`GF2` can process `str`ings resemling numbers ...
... but they must represent finite numbers.
"""
utils.is_not_field_element(GF2, value)
class TestIsZero:
"""Test specifics for `GF2.zero` and `GF2.is_zero()`."""