Example nit (#89)

* nit

* converted another

* converted another

* fix rmq.rs

---------

Co-authored-by: Luke Videckis <lukevideckis@gmail.com>
Co-authored-by: Cameron Custer <73217097+cameroncuster@users.noreply.github.com>

Author: lrvideckis

src/data_structures/rmq.rs

@@ -5,14 +5,14 @@
 /// use programming_team_code_rust::data_structures::rmq::RMQ;
 ///
 /// let a = [1, 3, 2, 4, 5];
-/// let rmq1 = RMQ::new(&a, |&x, &y| std::cmp::min(x, y));
-/// assert_eq!(rmq1.query(0..5), 1);
-/// assert_eq!(rmq1.query(1..4), 2);
+/// let rmq = RMQ::new(&a, |&x, &y| std::cmp::min(x, y));
+/// assert_eq!(rmq.query(0..5), 1);
+/// assert_eq!(rmq.query(1..4), 2);
 ///
 /// let outside_var = 5;
-/// let rmq2 = RMQ::new(&a, |&x, &y| if x + outside_var < y + outside_var { x } else { y });
-/// assert_eq!(rmq2.query(0..5), 1);
-/// assert_eq!(rmq2.query(1..4), 2);
+/// let rmq = RMQ::new(&a, |&x, &y| if x + outside_var < y + outside_var { x } else { y });
+/// assert_eq!(rmq.query(0..5), 1);
+/// assert_eq!(rmq.query(1..4), 2);
 /// ```
 pub struct RMQ<T, F> {
     t: Vec<Vec<T>>,

src/helpers/untested_rng.rs

@@ -7,18 +7,17 @@
 /// use std::time::{SystemTime, UNIX_EPOCH};
 /// use programming_team_code_rust::helpers::untested_rng::UntestedRNG;
 ///
-/// // fixed seed for debugging
-/// let mut rng1 = UntestedRNG::new(12345);
 /// // for submitting
-/// let mut rng2 = UntestedRNG::new(
+/// let mut rng = UntestedRNG::new(
 ///     SystemTime::now()
 ///         .duration_since(UNIX_EPOCH)
 ///         .unwrap()
 ///         .subsec_nanos() as u64,
 /// );
-///
-/// assert_eq!(rng1.get(), 13289605635609);
-/// assert_eq!(rng1.get_in_range(-3..4), 0);
+/// // fixed seed for debugging
+/// let mut rng = UntestedRNG::new(12345);
+/// assert_eq!(rng.get(), 13289605635609);
+/// assert_eq!(rng.get_in_range(-3..4), 0);
 /// ```
 struct UntestedRNG {
     state: u64,

src/strings/suf_ary.rs

@@ -33,31 +33,33 @@ use ac_library::string::{lcp_array_arbitrary, suffix_array_manual};
 /// //   ||
 /// // 2 nana   5
 ///
-/// let suf_ary1 = SufAry::new(&s.chars().map(|c| c as usize).collect::<Vec<_>>(), 255);
-/// let n = suf_ary1.sa.len();
-/// assert_eq!(suf_ary1.sa, [5, 3, 1, 0, 4, 2]);
-/// assert_eq!(suf_ary1.sa_inv, [3, 2, 5, 1, 4, 0]);
-/// assert_eq!(suf_ary1.lcp, [1, 3, 0, 0, 2]);
-///
+/// // build from Vec
 /// let a = [-4, 8, 1_000_000_000, 3];
 /// let (a_comp, max_val) = compress(&a);
-/// let suf_ary2 = SufAry::new(&a_comp, max_val);
+/// let suf_ary = SufAry::new(&a_comp, max_val);
+///
+/// // build from String
+/// let suf_ary = SufAry::new(&s.chars().map(|c| c as usize).collect::<Vec<usize>>(), 255);
+/// let n = suf_ary.sa.len();
+/// assert_eq!(suf_ary.sa, [5, 3, 1, 0, 4, 2]);
+/// assert_eq!(suf_ary.sa_inv, [3, 2, 5, 1, 4, 0]);
+/// assert_eq!(suf_ary.lcp, [1, 3, 0, 0, 2]);
 ///
-/// assert_eq!(suf_ary1.len_lcp(1, 3), 3);
-/// assert!(std::panic::catch_unwind(|| suf_ary1.len_lcp(1, n)).is_err());
+/// assert_eq!(suf_ary.len_lcp(1, 3), 3);
+/// assert!(std::panic::catch_unwind(|| suf_ary.len_lcp(1, n)).is_err());
 ///
-/// assert_eq!(suf_ary1.cmp_sufs(1, 3), Ordering::Greater);
-/// assert!(std::panic::catch_unwind(|| suf_ary1.cmp_sufs(n, 2)).is_err());
+/// assert_eq!(suf_ary.cmp_sufs(1, 3), Ordering::Greater);
+/// assert!(std::panic::catch_unwind(|| suf_ary.cmp_sufs(n, 2)).is_err());
 ///
-/// assert_eq!(suf_ary1.cmp_substrs(1..4, 3..6), Ordering::Equal);
-/// assert!(std::panic::catch_unwind(|| suf_ary1.cmp_substrs(3..4, n..n)).is_err());
+/// assert_eq!(suf_ary.cmp_substrs(1..4, 3..6), Ordering::Equal);
+/// assert!(std::panic::catch_unwind(|| suf_ary.cmp_substrs(3..4, n..n)).is_err());
 ///
-/// assert_eq!(suf_ary1.find_str(&"ana".chars().map(|c| c as usize).collect::<Vec<_>>()), 1..3);
-/// assert_eq!(suf_ary1.find_str(&[]), 0..n);
+/// assert_eq!(suf_ary.find_str(&"ana".chars().map(|c| c as usize).collect::<Vec<usize>>()), 1..3);
+/// assert_eq!(suf_ary.find_str(&[]), 0..n);
 ///
-/// assert_eq!(suf_ary1.find_substr(1..4), 1..3);
-/// assert_eq!(suf_ary1.find_substr(1..1), 0..n);
-/// assert!(std::panic::catch_unwind(|| suf_ary1.find_substr(n..n)).is_err());
+/// assert_eq!(suf_ary.find_substr(1..4), 1..3);
+/// assert_eq!(suf_ary.find_substr(1..1), 0..n);
+/// assert!(std::panic::catch_unwind(|| suf_ary.find_substr(n..n)).is_err());
 /// ```
 pub struct SufAry {
     n: usize,