Skip to content

Commit

Permalink
add comment to transform()
Browse files Browse the repository at this point in the history
  • Loading branch information
carrotflakes committed Jul 30, 2023
1 parent 21ce041 commit 6bc717c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/transform.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@ use std::iter::Sum;

use crate::Float;

/// You can also use overlapping_flatten() like this:
/// ```
/// buf.windows(window_size)
/// .step_by(slide_size)
/// .map(|b| process(&b))
/// .overlapping_flatten(window_size - slide_size)
/// .collect::<Vec<_>>()
/// ```
pub fn transform<T: Float + Sum>(
window_size: usize,
slide_size: usize,
Expand Down

0 comments on commit 6bc717c

Please sign in to comment.