barrett/likewise
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

update docstrings

Browse source
This commit is contained in:
Barrett Ruth 2025-09-11 15:31:36 -05:00
parent e78319df2b
commit 66a392e610
3 changed files with 22 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/algorithms/lcs.rs
View file

@ -293,6 +293,10 @@ fn test_bad_range_regression() {
); );
} }
/// LCS diff algorithm with f32 epsilon comparison.
///
/// Diff `old`, between indices `old_range` and `new` between indices `new_range`.
/// Values are considered equal if their absolute difference is within `epsilon`.
pub fn diff_fp_deadline<D>( pub fn diff_fp_deadline<D>(
d: &mut D, d: &mut D,
old: &[f32], old: &[f32],
@ -308,6 +312,10 @@ where
crate::algorithms::myers::diff_fp_deadline(d, old, old_range, new, new_range, epsilon, deadline) crate::algorithms::myers::diff_fp_deadline(d, old, old_range, new, new_range, epsilon, deadline)
} }
/// LCS diff algorithm with f64 epsilon comparison.
///
/// Diff `old`, between indices `old_range` and `new` between indices `new_range`.
/// Values are considered equal if their absolute difference is within `epsilon`.
pub fn diff_fp_f64_deadline<D>( pub fn diff_fp_f64_deadline<D>(
d: &mut D, d: &mut D,
old: &[f64], old: &[f64],

6
src/algorithms/myers.rs
View file

@ -445,6 +445,9 @@ fn test_finish_called() {
} }
/// Myers' diff algorithm with f32 epsilon comparison. /// Myers' diff algorithm with f32 epsilon comparison.
///
/// Diff `old`, between indices `old_range` and `new` between indices `new_range`.
/// Values are considered equal if their absolute difference is within `epsilon`.
pub fn diff_fp_deadline<D>( pub fn diff_fp_deadline<D>(
d: &mut D, d: &mut D,
old: &[f32], old: &[f32],
@ -467,6 +470,9 @@ where
} }
/// Myers' diff algorithm with f64 epsilon comparison. /// Myers' diff algorithm with f64 epsilon comparison.
///
/// Diff `old`, between indices `old_range` and `new` between indices `new_range`.
/// Values are considered equal if their absolute difference is within `epsilon`.
pub fn diff_fp_f64_deadline<D>( pub fn diff_fp_f64_deadline<D>(
d: &mut D, d: &mut D,
old: &[f64], old: &[f64],

8
src/algorithms/patience.rs
View file

@ -197,6 +197,10 @@ fn test_finish_called() {
assert!(d.0); assert!(d.0);
} }
/// Patience diff algorithm with f32 epsilon comparison.
///
/// Diff `old`, between indices `old_range` and `new` between indices `new_range`.
/// Values are considered equal if their absolute difference is within `epsilon`.
pub fn diff_fp_deadline<D>( pub fn diff_fp_deadline<D>(
d: &mut D, d: &mut D,
old: &[f32], old: &[f32],
@ -212,6 +216,10 @@ where
crate::algorithms::myers::diff_fp_deadline(d, old, old_range, new, new_range, epsilon, deadline) crate::algorithms::myers::diff_fp_deadline(d, old, old_range, new, new_range, epsilon, deadline)
} }
/// Patience diff algorithm with f64 epsilon comparison.
///
/// Diff `old`, between indices `old_range` and `new` between indices `new_range`.
/// Values are considered equal if their absolute difference is within `epsilon`.
pub fn diff_fp_f64_deadline<D>( pub fn diff_fp_f64_deadline<D>(
d: &mut D, d: &mut D,
old: &[f64], old: &[f64],