Define common series encoder behavior

src/preprocessing/series_encoder.rs

@@ -75,6 +75,50 @@ impl<'a, CategoryType: 'a + Hash + Eq + Clone> CategoryMapper<CategoryType> {
     }
 }
 
+/// Defines common behavior for series encoders(e.g. OneHot, Ordinal)
+pub trait SeriesEncoder<CategoryType>:
+    where 
+        CategoryType:Hash + Eq + Clone
+{
+    /// Fit an encoder to a lable list
+    fn fit_to_iter(categories: impl Iterator<Item = CategoryType>) -> Self;
+    
+    /// Number of categories for categorical variable
+    fn num_categories(&self) -> usize;
+     
+    /// Build an encoder from a predefined (category -> class number) map
+     fn from_category_map(category_map: HashMap<CategoryType, usize>) -> Self;
+
+    /// Build an encoder from a predefined positional category-class num vector
+    fn from_positional_category_vec(categories: Vec<CategoryType>) -> Self;
+
+    /// Transform a single category type into a one-hot vector
+    fn transform_one<U: RealNumber, V: BaseVector<U>>(&self, category: &CategoryType) -> Option<V>;
+
+    /// Invert one-hot vector, back to the category
+    fn invert_one<U: RealNumber, V: BaseVector<U>>(&self,  one_hot: V) -> Result<CategoryType, Failed>;
+
+    /// Get categories ordered by encoder's category enumeration
+    fn get_categories(&self) -> &[CategoryType];
+
+    /// Take an iterator as a series to transform
+    fn transform_iter<U: RealNumber, V: BaseVector<U>>(
+        &self,
+        cat_it: impl Iterator<Item = CategoryType>,
+    ) -> Vec<Option<V>> {
+        cat_it.map(|l| self.transform_one(&l)).collect()
+    }
+
+    /// Transform a slice of category types into one-hot vectors
+    /// None is returned if unknown category is encountered
+    fn transfrom_series<U: RealNumber,V: BaseVector<U>>(
+        &self,
+        categories: &[CategoryType],
+    ) -> Vec<Option<V>> {
+        let v = categories.iter().cloned();
+        self.transform_iter(v)
+    }
+}
 /// Make a one-hot encoded vector from a categorical variable
 ///
 /// Example:
@@ -134,104 +178,47 @@ pub fn make_one_hot<T: RealNumber, V: BaseVector<T>>(
 /// ```
 #[derive(Debug, Clone)]
 pub struct SeriesOneHotEncoder<CategoryType> {
-    category_map: HashMap<CategoryType, usize>,
+    mapper: CategoryMapper<CategoryType>,
-    categories: Vec<CategoryType>,
-    /// Number of categories for categorical variable
-    pub num_categories: usize,
 }
 
-impl<'a, CategoryType: 'a + Hash + Eq + Clone> SeriesOneHotEncoder<CategoryType> {
+impl<CategoryType: Hash + Eq + Clone> SeriesEncoder<CategoryType> for SeriesOneHotEncoder<CategoryType> {
-    /// Fit an encoder to a lable list
-    pub fn fit_to_iter(categories: impl Iterator<Item = CategoryType>) -> Self {
-        let mut category_map: HashMap<CategoryType, usize> = HashMap::new();
-        let mut category_num = 0usize;
-        let mut unique_lables: Vec<CategoryType> = Vec::new();
 
-        for l in categories {
+    fn fit_to_iter(categories: impl Iterator<Item = CategoryType>) -> Self {
-            if !category_map.contains_key(&l) {
+        Self {mapper:CategoryMapper::fit_to_iter(categories)}
-                category_map.insert(l.clone(), category_num);
-                unique_lables.push(l.clone());
-                category_num += 1;
             }
-        }
-        Self {
-            category_map,
-            num_categories: category_num,
-            categories: unique_lables,
-        }
-    }
 
     /// Build an encoder from a predefined (category -> class number) map
-    pub fn from_category_map(category_map: HashMap<CategoryType, usize>) -> Self {
+    fn from_category_map(category_map: HashMap<CategoryType, usize>) -> Self {
-        let mut _unique_cat: Vec<(CategoryType, usize)> =
+        Self {mapper: CategoryMapper::from_category_map(category_map)}
-            category_map.iter().map(|(k, v)| (k.clone(), *v)).collect();
-        _unique_cat.sort_by(|a, b| a.1.cmp(&b.1));
-        let categories: Vec<CategoryType> = _unique_cat.into_iter().map(|a| a.0).collect();
-        Self {
-            num_categories: categories.len(),
-            categories,
-            category_map,
         }
-    }
 
     /// Build an encoder from a predefined positional category-class num vector
-    pub fn from_positional_category_vec(categories: Vec<CategoryType>) -> Self {
+    fn from_positional_category_vec(categories: Vec<CategoryType>) -> Self {
-        let category_map: HashMap<CategoryType, usize> = categories
+        Self {mapper:CategoryMapper::from_positional_category_vec(categories)}
-            .iter()
-            .enumerate()
-            .map(|(v, k)| (k.clone(), v))
-            .collect();
-        Self {
-            num_categories: categories.len(),
-            category_map,
-            categories,
         }
+
+    fn num_categories(&self) -> usize {
+        self.mapper.num_categories
     }
 
-    /// Take an iterator as a series to transform
+    fn get_categories(&self) -> &[CategoryType] {
-    pub fn transform_iter<U: RealNumber>(
+        self.mapper.get_categories()
-        &self,
-        cat_it: impl Iterator<Item = CategoryType>,
-    ) -> Vec<Option<Vec<U>>> {
-        cat_it.map(|l| self.transform_one(&l)).collect()
     }
 
-    /// Transform a slice of category types into one-hot vectors
+    fn invert_one<U: RealNumber, V: BaseVector<U>>(&self, one_hot: V) -> Result<CategoryType, Failed> 
-    /// None is returned if unknown category is encountered
+        {
-    pub fn transfrom_series<U: RealNumber>(
-        &self,
-        categories: &'a [CategoryType],
-    ) -> Vec<Option<Vec<U>>> {
-        let v = categories.iter().cloned();
-        self.transform_iter(v)
-    }
-
-    /// Transform a single category type into a one-hot vector
-    pub fn transform_one<U: RealNumber>(&self, category: &CategoryType) -> Option<Vec<U>> {
-        match self.category_map.get(category) {
-            None => None,
-            Some(&idx) => Some(make_one_hot(idx, self.num_categories)),
-        }
-    }
-
-    /// Get categories ordered by encoder's category enumeration
-    pub fn get_categories(&self) -> &Vec<CategoryType> {
-        &self.categories
-    }
-
-    /// Invert one-hot vector, back to the category
-    pub fn invert_one<U: RealNumber>(&self, one_hot: Vec<U>) -> Result<CategoryType, Failed> {
         let pos = U::from_f64(1f64).unwrap();
+    
+            let oh_it = (0..one_hot.len()).map(|idx| one_hot.get(idx));
 
-        let s: Vec<usize> = one_hot
+            let s: Vec<usize> = oh_it
-            .into_iter()
             .enumerate()
             .filter_map(|(idx, v)| if v == pos { Some(idx) } else { None })
             .collect();
 
         if s.len() == 1 {
             let idx = s[0];
-            return Ok(self.categories[idx].clone());
+                return Ok(self.mapper.get_cat(idx).clone());
         }
         let pos_entries = format!(
             "Expected a single positive entry, {} entires found",
@@ -239,6 +226,13 @@ impl<'a, CategoryType: 'a + Hash + Eq + Clone> SeriesOneHotEncoder<CategoryType>
         );
         Err(Failed::transform(&pos_entries[..]))
     }
+
+    fn transform_one<U: RealNumber, V: BaseVector<U>>(&self, category: &CategoryType) -> Option<V> {
+        match self.mapper.get_num(category) {
+            None => None,
+            Some(&idx) => Some(make_one_hot(idx, self.num_categories())),
+        }
+    }
 }
 
 #[cfg(test)]