Skip to content

Commit 2d4130e

Browse files
committed
Update doc comments for rayon
1 parent 5939d88 commit 2d4130e

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/options.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@
99
#[derive(Debug, Clone)]
1010
pub struct Options {
1111
/// Whether to run the bit reversal step in 2 threads instead of one.
12-
/// This is beneficial only at large input sizes (i.e. gigabytes of data).
12+
/// This is beneficial only at medium to large sizes (i.e. megabytes of data).
1313
/// The exact threshold where it starts being beneficial varies depending on the hardware.
14+
///
15+
/// This option is ignored if the `parallel` feature is disabled.
1416
pub multithreaded_bit_reversal: bool,
1517

1618
/// Controls bit reversal behavior for DIF FFT algorithms.
@@ -37,6 +39,8 @@ pub struct Options {
3739
/// Do not split the input any further to run in parallel below this size
3840
///
3941
/// Set to `usize::MAX` to disable parallelism in the recursive FFT step.
42+
///
43+
/// This option is ignored if the `parallel` feature is disabled.
4044
pub smallest_parallel_chunk_size: usize,
4145
}
4246

0 commit comments

Comments
 (0)