Update comments in group-math

group-math/src/byte.rs

@@ -1,11 +1,15 @@
-//! Group of bytes which defines addition as XOR
+//! Group of bytes
+//!
+//! - Associative operation: Xor
+//! - Identity element: All zero
+//! - Inverse element: `x` itself
 
 use std::ops::{Add, AddAssign};
 
 use crate::Group;
 use utils::xor_inplace;
 
-/// See [`crate::byte`]
+/// See [`self`]
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct ByteGroup<const LAMBDA: usize>(pub [u8; LAMBDA]);
 

group-math/src/int.rs

@@ -1,4 +1,8 @@
-//! Group of a integer which defines addition as integer (wrapping) addition
+//! Group of an integer which defines addition as integer (wrapping) addition
+//!
+//! - Associative operation: Integer wrapping addition, `$(a + b) \mod 2^N$`
+//! - Identity element: 0
+//! - Inverse element: `-x`
 
 use std::mem::size_of;
 use std::ops::{Add, AddAssign};
@@ -7,7 +11,7 @@ use crate::Group;
 
 macro_rules! decl_int_group {
     ($t:ty, $t_impl:ident) => {
-        /// See [`crate::int`]
+        /// See [`self`]
         #[derive(Debug, Clone, PartialEq, Eq)]
         pub struct $t_impl(pub $t);
 

group-math/src/int_prime.rs

@@ -1,6 +1,10 @@
-//! Prime ring.
-//! `MOD` is a prime number as the cardinality of the prime ring.
-//! Some prime numbers that are the max ones less than or equal to `u*::MAX` is provided as `PRIME_MAX_LE_U*_MAX`.
+//! Group of an integer which is a `$p$`-group.
+//! `MOD` as the `$p$` is a prime number as the cardinality of the group.
+//! Some prime numbers that are the max ones less than or equal to `u*::MAX` are provided as `PRIME_MAX_LE_U*_MAX`.
+//!
+//! - Associative operation: Integer addition modulo `MOD`, `$(a + b) \mod MOD$`
+//! - Identity element: 0
+//! - Inverse element: `-x`
 
 use std::mem::size_of;
 use std::ops::{Add, AddAssign};
@@ -9,7 +13,7 @@ use crate::Group;
 
 macro_rules! decl_int_prime_group {
     ($t:ty, $t_impl:ident) => {
-        /// See [`crate::int_prime`]
+        /// See [`self`]
         #[derive(Debug, Clone, PartialEq, Eq)]
         pub struct $t_impl<const MOD: $t>(
             /// Always less than `MOD`

group-math/src/lib.rs

@@ -15,7 +15,8 @@ pub mod int_prime;
 
 /// Group (mathematics) that can be converted from a byte array
 ///
-/// `Into<[u8; LAMBDA]>` is not used so not included, but implemented by [`byte`] and [`int`]
+/// `Into<[u8; LAMBDA]>` is not used in any fss crate so not included.
+/// But it is implemented by all groups in the submodules.
 pub trait Group<const LAMBDA: usize>
 where
     Self: Add<Output = Self>