Rename struct SliceChooseIter -> IndexedSamples

Author: dhardy

src/seq/mod.rs

@@ -40,6 +40,9 @@ mod index_;
 pub use crate::distr::weighted::Error as WeightError;
 pub use iterator::IteratorRandom;
 #[cfg(feature = "alloc")]
+pub use slice::IndexedSamples;
+#[allow(deprecated)]
+#[cfg(feature = "alloc")]
 pub use slice::SliceChooseIter;
 pub use slice::{IndexedMutRandom, IndexedRandom, SliceRandom};
 

src/seq/slice.rs

@@ -87,13 +87,13 @@ pub trait IndexedRandom: Index<usize> {
     /// }
     /// ```
     #[cfg(feature = "alloc")]
-    fn sample<R>(&self, rng: &mut R, amount: usize) -> SliceChooseIter<Self, Self::Output>
+    fn sample<R>(&self, rng: &mut R, amount: usize) -> IndexedSamples<Self, Self::Output>
     where
         Self::Output: Sized,
         R: Rng + ?Sized,
     {
         let amount = core::cmp::min(amount, self.len());
-        SliceChooseIter {
+        IndexedSamples {
             slice: self,
             _phantom: Default::default(),
             indices: index::sample(rng, self.len(), amount).into_iter(),
@@ -209,15 +209,15 @@ pub trait IndexedRandom: Index<usize> {
         rng: &mut R,
         amount: usize,
         weight: F,
-    ) -> Result<SliceChooseIter<Self, Self::Output>, WeightError>
+    ) -> Result<IndexedSamples<Self, Self::Output>, WeightError>
     where
         Self::Output: Sized,
         R: Rng + ?Sized,
         F: Fn(&Self::Output) -> X,
         X: Into<f64>,
     {
         let amount = core::cmp::min(amount, self.len());
-        Ok(SliceChooseIter {
+        Ok(IndexedSamples {
             slice: self,
             _phantom: Default::default(),
             indices: index::sample_weighted(
@@ -233,7 +233,7 @@ pub trait IndexedRandom: Index<usize> {
     /// Deprecated: use [`Self::sample`] instead
     #[cfg(feature = "alloc")]
     #[deprecated(since = "0.9.2", note = "Renamed to `sample`")]
-    fn choose_multiple<R>(&self, rng: &mut R, amount: usize) -> SliceChooseIter<Self, Self::Output>
+    fn choose_multiple<R>(&self, rng: &mut R, amount: usize) -> IndexedSamples<Self, Self::Output>
     where
         Self::Output: Sized,
         R: Rng + ?Sized,
@@ -259,7 +259,7 @@ pub trait IndexedRandom: Index<usize> {
         rng: &mut R,
         amount: usize,
         weight: F,
-    ) -> Result<SliceChooseIter<Self, Self::Output>, WeightError>
+    ) -> Result<IndexedSamples<Self, Self::Output>, WeightError>
     where
         Self::Output: Sized,
         R: Rng + ?Sized,
@@ -454,14 +454,14 @@ impl<T> SliceRandom for [T] {
 /// [`IndexedRandom::sample`](trait.IndexedRandom.html#tymethod.sample).
 #[cfg(feature = "alloc")]
 #[derive(Debug)]
-pub struct SliceChooseIter<'a, S: ?Sized + 'a, T: 'a> {
+pub struct IndexedSamples<'a, S: ?Sized + 'a, T: 'a> {
     slice: &'a S,
     _phantom: core::marker::PhantomData<T>,
     indices: index::IndexVecIntoIter,
 }
 
 #[cfg(feature = "alloc")]
-impl<'a, S: Index<usize, Output = T> + ?Sized + 'a, T: 'a> Iterator for SliceChooseIter<'a, S, T> {
+impl<'a, S: Index<usize, Output = T> + ?Sized + 'a, T: 'a> Iterator for IndexedSamples<'a, S, T> {
     type Item = &'a T;
 
     fn next(&mut self) -> Option<Self::Item> {
@@ -476,13 +476,18 @@ impl<'a, S: Index<usize, Output = T> + ?Sized + 'a, T: 'a> Iterator for SliceCho
 
 #[cfg(feature = "alloc")]
 impl<'a, S: Index<usize, Output = T> + ?Sized + 'a, T: 'a> ExactSizeIterator
-    for SliceChooseIter<'a, S, T>
+    for IndexedSamples<'a, S, T>
 {
     fn len(&self) -> usize {
         self.indices.len()
     }
 }
 
+/// Deprecated: renamed to [`IndexedSamples`]
+#[cfg(feature = "alloc")]
+#[deprecated(since = "0.9.2", note = "Renamed to `IndexedSamples`")]
+pub type SliceChooseIter<'a, S, T> = IndexedSamples<'a, S, T>;
+
 #[cfg(test)]
 mod test {
     use super::*;