From 47e02d3feb98097d6e0ba1d165a605e91c50132c Mon Sep 17 00:00:00 2001 From: Xin Hao Date: Fri, 24 May 2024 15:03:49 +0800 Subject: [PATCH] docs: enhance the example in the README --- README.md | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 55e1845..9b0de1e 100644 --- a/README.md +++ b/README.md @@ -39,31 +39,33 @@ Additionally, an optional 128-bit negacyclic FFT module is provided. ```rust use concrete_fft::c64; -use concrete_fft::ordered::{Plan, Method}; -use dyn_stack::{PodStack, GlobalPodBuffer, ReborrowMut}; +use concrete_fft::ordered::{Method, Plan}; +use dyn_stack::{GlobalPodBuffer, PodStack, ReborrowMut}; use num_complex::ComplexFloat; use std::time::Duration; -const N: usize = 4; -let plan = Plan::new(4, Method::Measure(Duration::from_millis(10))); -let mut scratch_memory = GlobalPodBuffer::new(plan.fft_scratch().unwrap()); -let mut stack = PodStack::new(&mut scratch_memory); +fn main() { + const N: usize = 4; + let plan = Plan::new(4, Method::Measure(Duration::from_millis(10))); + let mut scratch_memory = GlobalPodBuffer::new(plan.fft_scratch().unwrap()); + let mut stack = PodStack::new(&mut scratch_memory); -let data = [ - c64::new(1.0, 0.0), - c64::new(2.0, 0.0), - c64::new(3.0, 0.0), - c64::new(4.0, 0.0), -]; + let data = [ + c64::new(1.0, 0.0), + c64::new(2.0, 0.0), + c64::new(3.0, 0.0), + c64::new(4.0, 0.0), + ]; -let mut transformed_fwd = data; -plan.fwd(&mut transformed_fwd, stack.rb_mut()); + let mut transformed_fwd = data; + plan.fwd(&mut transformed_fwd, stack.rb_mut()); -let mut transformed_inv = transformed_fwd; -plan.inv(&mut transformed_inv, stack.rb_mut()); + let mut transformed_inv = transformed_fwd; + plan.inv(&mut transformed_inv, stack.rb_mut()); -for (actual, expected) in transformed_inv.iter().map(|z| z / N as f64).zip(data) { - assert!((expected - actual).abs() < 1e-9); + for (actual, expected) in transformed_inv.iter().map(|z| z / N as f64).zip(data) { + assert!((expected - actual).abs() < 1e-9); + } } ```