Merge pull request #498 from qfall/hotfix_clippy

Fix Overindentation marked by Clippy

Author: Marvin-Beckmann

benches/classic_crypto.rs

@@ -92,7 +92,7 @@ mod rsa_textbook {
     ///
     /// The following steps are made:
     /// 1. Generate two unequal primes `p` and `q` roughly of bit size `security_lvl / 2`
-    ///     (s.t. `N` is roughly of bit size `security_lvl`).
+    ///    (s.t. `N` is roughly of bit size `security_lvl`).
     /// 2. Compute `N = p * q`.
     /// 3. Compute Euler's Phi function `phi(N) = (p-1) * (q-1)`.
     /// 4. Choose `pk = 65537 = 0x10000000000000001` statically as public key (common as `enc` is very
@@ -153,7 +153,7 @@ mod rsa_textbook {
     /// Run textbook RSA encryption with 1024 bit security.
     /// 1. get (N, pk, sk) from a previously generated key pair with `gen(1024)`
     /// 2. run cycle of `dec(sk, enc(pk, msg)) == msg`,
-    ///     where `msg` is sampled uniformly at random in `[0, u64::MAX)`
+    ///    where `msg` is sampled uniformly at random in `[0, u64::MAX)`
     pub fn rsa_run_enc_dec() {
         let (modulus, pk, sk) = static_gen();
         let msg = Z::sample_uniform(0, u64::MAX).unwrap();
@@ -211,7 +211,7 @@ mod dh_ke {
     /// Run a Diffie-Hellman key exchange with precomputed public parameters with 1024 bit security.
     /// 1. get (p, g) from previously generated public parameters
     /// 2. run one cycle of `gen_key_pair` and `combine_to_shared_sk` on each end (2 times),
-    ///     i.e. one key exchange at both ends and compare the computed shared secrets
+    ///    i.e. one key exchange at both ends and compare the computed shared secrets
     pub fn dh_run() {
         let (modulus, generator) = static_gen_pp();
 

src/error.rs

@@ -15,19 +15,19 @@
 //!
 //! **For developers:**
 //! - How to add an error to an `enum`? First of all, find a name
-//!     that is not too specific for your current case s.t. it could be used in other
-//!     contexts afterwards as well. Then, find the spot according to your chosen error
-//!     name in a alphanumerically sorted way in the list of supported errors in the doc
-//!     comment and inside the `enum` itself.
-//!     Afterwards, add the error to the list of implemented error
-//!     types in the doc comment of the `enum` with a short description when it is thrown.
-//!     Probably use this description for the doc comment above the implementation of
-//!     error in the `enum`. Then, add `#[error(<error msg>)]` to define the error message
-//!     output once your error is thrown. Below, write down `<error name>(<input>),` to
-//!     define the error with its name and possibly some inputs. The input can be of the
-//!     form [`String`], but also another error, whose conversion must be declared via
-//!     `#[from] OtherError`. It is best to use the existing structure as a guide. For any
-//!     further information, check out the here used [`thiserror`]-crate.
+//!   that is not too specific for your current case s.t. it could be used in other
+//!   contexts afterwards as well. Then, find the spot according to your chosen error
+//!   name in a alphanumerically sorted way in the list of supported errors in the doc
+//!   comment and inside the `enum` itself.
+//!   Afterwards, add the error to the list of implemented error
+//!   types in the doc comment of the `enum` with a short description when it is thrown.
+//!   Probably use this description for the doc comment above the implementation of
+//!   error in the `enum`. Then, add `#[error(<error msg>)]` to define the error message
+//!   output once your error is thrown. Below, write down `<error name>(<input>),` to
+//!   define the error with its name and possibly some inputs. The input can be of the
+//!   form [`String`], but also another error, whose conversion must be declared via
+//!   `#[from] OtherError`. It is best to use the existing structure as a guide. For any
+//!   further information, check out the here used [`thiserror`]-crate.
 
 use std::ffi::NulError;
 use thiserror::Error;
@@ -37,35 +37,35 @@ use thiserror::Error;
 ///
 /// Implemented error types:
 /// - [`ConversionError`](MathError::ConversionError) is thrown if a conversion
-///     between types is not possible.
+///   between types is not possible.
 /// - [`DivisionByZeroError`](MathError::DivisionByZeroError) is thrown if it is
-///     tried to perform a division by `0`.
+///   tried to perform a division by `0`.
 /// - [`InvalidExponent`](MathError::InvalidExponent) is thrown if an invalid
-///     exponent is used for a `pow` function.
+///   exponent is used for a `pow` function.
 /// - [`InvalidIntegerInput`](MathError::InvalidIntegerInput) is thrown if an
-///     integer input is provided as parameter that does not meet the conditions
-///     of that function.
+///   integer input is provided as parameter that does not meet the conditions
+///   of that function.
 /// - [`InvalidInterval`](MathError::InvalidInterval) is thrown if an invalid
-///     interval, e.g. of negative size, is provided.
+///   interval, e.g. of negative size, is provided.
 /// - [`InvalidModulus`](MathError::InvalidModulus) is thrown if an integer is
-///     provided, which is smaller than `2`.
+///   provided, which is smaller than `2`.
 /// - [`NulError`](MathError::NulError) is thrown if a [`NulError`] is thrown,
-///     which currently only happens if an invalid string is given to construct
-///     a [`CString`](std::ffi::CString).
+///   which currently only happens if an invalid string is given to construct
+///   a [`CString`](std::ffi::CString).
 /// - [`MismatchingMatrixDimension`](MathError::MismatchingMatrixDimension) is
-///     thrown if arithmetic is done with matrices of mismatching dimensions.
+///   thrown if arithmetic is done with matrices of mismatching dimensions.
 /// - [`MismatchingModulus`](MathError::MismatchingModulus) is thrown if any
-///     function is called on two objects with different modulus where equal
-///     modulus is required.
+///   function is called on two objects with different modulus where equal
+///   modulus is required.
 /// - [`NonPositive`](MathError::NonPositive) is thrown if the function expects
-///     a positive number, but a number smaller than `1` is provided.
+///   a positive number, but a number smaller than `1` is provided.
 /// - [`NoSquareMatrix`](MathError::NoSquareMatrix) is thrown if a matrix is
-///     not square.
+///   not square.
 /// - [`OutOfBounds`](MathError::OutOfBounds) is thrown if a provided index
-///     is not in a desired range.
+///   is not in a desired range.
 /// - [`VectorFunctionCalledOnNonVector`](MathError::VectorFunctionCalledOnNonVector)
-///     is thrown if a function defined on vectors was called on a matrix instance
-///     that is not a vector.
+///   is thrown if a function defined on vectors was called on a matrix instance
+///   that is not a vector.
 ///
 /// # Examples
 /// ```
@@ -155,26 +155,26 @@ pub enum MathError {
 ///
 /// Implemented error types:
 /// - [`InvalidMatrix`](StringConversionError::InvalidMatrix) is thrown if an
-///     invalid string input of a matrix is given.
+///   invalid string input of a matrix is given.
 /// - [`InvalidStringToPolyInput`](StringConversionError::InvalidStringToPolyInput)
-///     is thrown if an invalid string is given to construct a polynomial.
+///   is thrown if an invalid string is given to construct a polynomial.
 /// - [`InvalidStringToPolyMissingWhitespace`](StringConversionError::InvalidStringToPolyMissingWhitespace)
-///     is thrown if an invalid string is given to construct a polynomial which
-///     did not contain two whitespaces.
+///   is thrown if an invalid string is given to construct a polynomial which
+///   did not contain two whitespaces.
 /// - [`InvalidStringToPolyModulusInput`](StringConversionError::InvalidStringToPolyModulusInput)
-///     is thrown if an invalid string is given
-///     to construct a [`PolyOverZq`](crate::integer_mod_q::PolyOverZq), i.e. it is
-///     not formatted correctly.
+///   is thrown if an invalid string is given
+///   to construct a [`PolyOverZq`](crate::integer_mod_q::PolyOverZq), i.e. it is
+///   not formatted correctly.
 /// - [`InvalidStringToPolyRingZqInput`](StringConversionError::InvalidStringToPolyRingZqInput)
-///     is thrown if an invalid string is given
-///     to construct a [`PolynomialRingZq`](crate::integer_mod_q::PolynomialRingZq), i.e. it is
-///     not formatted correctly.
+///   is thrown if an invalid string is given
+///   to construct a [`PolynomialRingZq`](crate::integer_mod_q::PolynomialRingZq), i.e. it is
+///   not formatted correctly.
 /// - [`InvalidStringToQInput`](StringConversionError::InvalidStringToQInput)
-///     is thrown if an invalid string is given to construct a [`Q`](crate::rational::Q).
+///   is thrown if an invalid string is given to construct a [`Q`](crate::rational::Q).
 /// - [`InvalidStringToZInput`](StringConversionError::InvalidStringToZInput)
-///     is thrown if an invalid string is given to construct a [`Z`](crate::integer::Z).
+///   is thrown if an invalid string is given to construct a [`Z`](crate::integer::Z).
 /// - [`InvalidStringToZqInput`](StringConversionError::InvalidStringToZqInput)
-///     is thrown if an invalid string is given to construct a [`Zq`](crate::integer_mod_q::Zq).
+///   is thrown if an invalid string is given to construct a [`Zq`](crate::integer_mod_q::Zq).
 ///
 /// # Examples
 /// ```

src/integer/mat_poly_over_z.rs

@@ -37,7 +37,7 @@ mod vector;
 ///
 /// Attributes:
 /// - `matrix`: holds [FLINT](https://flintlib.org/)'s [struct](fmpz_poly_mat_struct)
-///     of the [`PolyOverZ`](crate::integer::PolyOverZ) matrix
+///   of the [`PolyOverZ`](crate::integer::PolyOverZ) matrix
 ///
 /// # Examples
 /// ## Matrix usage

src/integer/mat_poly_over_z/arithmetic/add.rs

@@ -110,8 +110,8 @@ impl MatPolyOverZ {
     ///
     /// # Errors and Failures
     /// - Returns a [`MathError`] of type
-    ///     [`MathError::MismatchingMatrixDimension`] if the matrix dimensions
-    ///     mismatch.
+    ///   [`MathError::MismatchingMatrixDimension`] if the matrix dimensions
+    ///   mismatch.
     pub fn add_safe(&self, other: &Self) -> Result<MatPolyOverZ, MathError> {
         if self.get_num_rows() != other.get_num_rows()
             || self.get_num_columns() != other.get_num_columns()

src/integer/mat_poly_over_z/arithmetic/mul.rs

@@ -71,8 +71,8 @@ impl MatPolyOverZ {
     ///
     /// # Errors and Failures
     /// - Returns a [`MathError`] of type
-    ///     [`MathError::MismatchingMatrixDimension`] if the dimensions of `self`
-    ///     and `other` do not match for multiplication.
+    ///   [`MathError::MismatchingMatrixDimension`] if the dimensions of `self`
+    ///   and `other` do not match for multiplication.
     pub fn mul_safe(&self, other: &Self) -> Result<Self, MathError> {
         if self.get_num_columns() != other.get_num_rows() {
             return Err(MathError::MismatchingMatrixDimension(format!(

src/integer/mat_poly_over_z/arithmetic/sub.rs

@@ -70,8 +70,8 @@ impl MatPolyOverZ {
     /// ```
     /// # Errors
     /// - Returns a [`MathError`] of type
-    ///     [`MathError::MismatchingMatrixDimension`] if the matrix dimensions
-    ///     mismatch.
+    ///   [`MathError::MismatchingMatrixDimension`] if the matrix dimensions
+    ///   mismatch.
     pub fn sub_safe(&self, other: &Self) -> Result<MatPolyOverZ, MathError> {
         if self.get_num_rows() != other.get_num_rows()
             || self.get_num_columns() != other.get_num_columns()

src/integer/mat_poly_over_z/coefficient_embedding.rs

@@ -28,7 +28,7 @@ impl IntoCoefficientEmbedding<MatZ> for &MatPolyOverZ {
     ///
     /// Parameters:
     /// - `size`: determines the number of rows of the embedding. It has to be larger
-    ///     than the degree of the polynomial.
+    ///   than the degree of the polynomial.
     ///
     /// Returns a coefficient embedding as a matrix if `size` is large enough.
     ///
@@ -48,7 +48,7 @@ impl IntoCoefficientEmbedding<MatZ> for &MatPolyOverZ {
     ///
     /// # Panics ...
     /// - if `size` is not larger than the degree of the polynomial, i.e.
-    ///     not all coefficients can be embedded.
+    ///   not all coefficients can be embedded.
     fn into_coefficient_embedding(self, size: impl Into<i64>) -> MatZ {
         let size = size.into();
 

src/integer/mat_poly_over_z/concat.rs

@@ -39,8 +39,8 @@ impl Concatenate for &MatPolyOverZ {
     ///
     /// # Errors and Failures
     /// - Returns a [`MathError`] of type
-    ///     [`MismatchingMatrixDimension`](MathError::MismatchingMatrixDimension)
-    ///     if the matrices can not be concatenated due to mismatching dimensions.
+    ///   [`MismatchingMatrixDimension`](MathError::MismatchingMatrixDimension)
+    ///   if the matrices can not be concatenated due to mismatching dimensions.
     fn concat_vertical(self, other: Self) -> Result<Self::Output, crate::error::MathError> {
         if self.get_num_columns() != other.get_num_columns() {
             return Err(MathError::MismatchingMatrixDimension(format!(
@@ -82,8 +82,8 @@ impl Concatenate for &MatPolyOverZ {
     ///
     /// # Errors and Failures
     /// - Returns a [`MathError`] of type
-    ///     [`MismatchingMatrixDimension`](MathError::MismatchingMatrixDimension)
-    ///     if the matrices can not be concatenated due to mismatching dimensions.
+    ///   [`MismatchingMatrixDimension`](MathError::MismatchingMatrixDimension)
+    ///   if the matrices can not be concatenated due to mismatching dimensions.
     fn concat_horizontal(self, other: Self) -> Result<Self::Output, crate::error::MathError> {
         if self.get_num_rows() != other.get_num_rows() {
             return Err(MathError::MismatchingMatrixDimension(format!(

src/integer/mat_poly_over_z/default.rs

@@ -74,7 +74,7 @@ impl MatPolyOverZ {
     ///
     /// # Panics ...
     /// - if the provided number of rows and columns are not suited to create a matrix.
-    ///     For further information see [`MatPolyOverZ::new`].
+    ///   For further information see [`MatPolyOverZ::new`].
     pub fn identity(
         num_rows: impl TryInto<i64> + Display,
         num_cols: impl TryInto<i64> + Display,

src/integer/mat_poly_over_z/from.rs

@@ -32,8 +32,8 @@ impl FromStr for MatPolyOverZ {
     ///
     /// Parameters:
     /// - `string`: the matrix of form: `"[[poly_1, poly_2, poly_3],[poly_4, poly_5, poly_6]]"`
-    ///     for a 2x3 matrix where first three polynomials are in the first row
-    ///     and the second three are in the second row.
+    ///   for a 2x3 matrix where first three polynomials are in the first row
+    ///   and the second three are in the second row.
     ///
     /// Returns a [`MatPolyOverZ`] or an error if the matrix is not formatted in a suitable way,
     /// the number of rows or columns is too large (must fit into [`i64`]),
@@ -69,11 +69,11 @@ impl FromStr for MatPolyOverZ {
     ///     - if the number of rows or columns is too large (must fit into i64),
     ///     - if the number of entries in rows is unequal, or
     ///     - if an entry is not formatted correctly.
-    ///         For further information see [`PolyOverZ::from_str`].
+    ///       For further information see [`PolyOverZ::from_str`].
     ///
     /// # Panics ...
     /// - if the provided number of rows and columns are not suited to create a matrix.
-    ///     For further information see [`MatPolyOverZ::new`].
+    ///   For further information see [`MatPolyOverZ::new`].
     fn from_str(string: &str) -> Result<Self, MathError> {
         let string_matrix = parse_matrix_string(string)?;
         let (num_rows, num_cols) = find_matrix_dimensions(&string_matrix)?;