Skip to content

Commit

Permalink
Fix clippy::too_long_first_doc_paragraph
Browse files Browse the repository at this point in the history
  • Loading branch information
byeongkeunahn committed Aug 28, 2024
1 parent d9ed121 commit fb5dc62
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 1 deletion.
2 changes: 2 additions & 0 deletions basm-std/src/math/ntt/linear_recurrence.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ use super::{polymod_u64, polymul_u64};
use crate::math::{modadd, modmul, modsub};
use alloc::vec;

/// Logarithmic time linear recurrence solver.
///
/// Computes the `n`-th term `a[n]` of a linear recurrence specified by `first_terms` and `coeff`.
/// The recurrence is `a[k] = coeff[0] * a[k-1] + coeff[1] * a[k-2] + ... + coeff[m-1] * a[k-m-1]`
/// where `m` is the length of the `coeff` slice. Also, `a[i] = first_terms[i]` for `0 <= i < m`.
Expand Down
3 changes: 2 additions & 1 deletion basm-std/src/math/ntt/multiply.rs
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,8 @@ fn mac3_u64(acc: &mut [u64], b: &[u64], c: &[u64]) {
}

/// Multiplies two integers `x` and `y`.
/// Least significant digits come first.
///
/// In the input arrays `x` and `y`, least significant digits should come first.
/// If either of the inputs is empty, the result will be an empty Vec.
/// Otherwise the output will have length equal to `x.len() + y.len()`.
///
Expand Down
1 change: 1 addition & 0 deletions basm-std/src/math/ntt/polymul.rs
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,7 @@ pub fn polymul_ex_u64(out: &mut [u64], x: &[u64], y: &[u64], l: usize, r: usize,
}

/// Multiplies two polynomials given by coefficients `x` and `y`, modulo `modulo`.
///
/// If `modulo` equals 0, it is treated as `2**64`.
/// If either of the inputs is empty, the result will be an empty Vec.
/// Otherwise the output will have length equal to `x.len() + y.len() - 1`.
Expand Down
1 change: 1 addition & 0 deletions basm-std/src/math/sieve.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use alloc::vec;
use alloc::vec::Vec;

/// A dynamically growing linear sieve.
///
/// We ensure amortized O(1) runtime by growing in a similar way as `Vec<T>`
/// and by using a linear sieve algorithm.
/// The growth strategy is to increase the upper bound by 50% each time.
Expand Down

0 comments on commit fb5dc62

Please sign in to comment.