black-jack 0.1.0

//! DataFrame object and associated functionality
//!
//!

use baggie::Baggie;
use num::*;
use serde::Deserialize;

use crate::prelude::*;

pub mod dataframe_groupby;
pub mod io;
pub use self::dataframe_groupby::*;
pub use self::io::*;

/// The container for `Series<T>` objects, allowing for additional functionality
#[derive(Default, Debug)]
pub struct DataFrame<I>
where
    I: PartialOrd + PartialEq + BlackJackData,
{
    index: Series<I>,
    meta: Vec<SeriesMeta>,
    data: Baggie<String>,
}

impl<I: PartialOrd + PartialEq + BlackJackData> DataFrame<I> {
    /// Create a new `DataFrame` struct
    ///
    /// ## Example
    /// ```
    /// use blackjack::prelude::*;
    ///
    /// let mut df: DataFrame<i32> = DataFrame::new();  // `i32` indicates index type of DataFrame
    /// ```
    pub fn new() -> Self {
        DataFrame {
            index: Series::default(),
            data: Baggie::new(),
            meta: vec![],
        }
    }

    /// Filter the dataframe by iterating over its `Row`s.
    ///
    /// ## Example
    ///
    /// ```
    /// # use blackjack::prelude::*;
    /// let mut s1 = Series::from(0..5);
    /// s1.set_name("col1");
    ///
    /// let mut s2 = Series::from(10..15);
    /// s2.set_name("col2");
    ///
    /// let mut s3 = Series::from_vec(vec![
    ///     "foo".to_string(),
    ///     "bar".to_string(),
    ///     "foo".to_string(),
    ///     "bar".to_string(),
    ///     "foo".to_string(),
    /// ]);
    /// s3.set_name("col3");
    ///
    /// let mut df = DataFrame::new();
    /// assert!(df.add_column(s1).is_ok());
    /// assert!(df.add_column(s2).is_ok());
    /// assert!(df.add_column(s3).is_ok());
    ///
    /// // Before filtering, we're len 5
    /// assert_eq!(df.len(), 5);
    ///
    /// df.filter_by_row(|row| row["col1"] == Datum::I32(&0));
    ///
    /// // After filtering, we're len 4 and first element of 'col1' is now 1
    /// assert_eq!(df.len(), 4);
    ///
    /// // Filter by string foo,
    /// df.filter_by_row(|row| row["col3"] != Datum::STR(&"foo".to_string()));
    /// assert_eq!(df.len(), 2);
    /// ```
    pub fn filter_by_row<F>(&mut self, condition: F) -> ()
    where
        F: Fn(&Row<'_>) -> bool,
    {
        let positions_to_drop = self
            .iter_rows()
            .enumerate()
            .filter(|(_idx, row)| condition(row))
            .map(|(idx, _)| idx)
            .collect::<Vec<usize>>();

        self.drop_positions(positions_to_drop.into_iter())
    }

    /// Drop positions within the `Series`
    ///
    /// ## Example
    /// ```
    /// # use blackjack::prelude::*;
    ///
    /// let mut df = DataFrame::new();
    /// assert!(df.add_column(Series::from(0..10)).is_ok());
    ///
    /// assert_eq!(df.len(), 10);
    /// df.drop_positions(0..5);  // Iterator of `usize` items
    /// assert_eq!(df.len(), 5);
    /// ```
    pub fn drop_positions(&mut self, positions: impl Iterator<Item = usize>) -> () {
        let positions = positions.into_iter().collect::<Vec<usize>>();
        for meta in self.meta.clone() {
            match meta.dtype {
                DType::F64 => {
                    let s: &mut Series<f64> = &mut self.get_column_mut(meta.name.as_str()).unwrap();
                    s.drop_positions(positions.clone())
                }
                DType::I64 => {
                    let s: &mut Series<i64> = &mut self.get_column_mut(meta.name.as_str()).unwrap();
                    s.drop_positions(positions.clone())
                }
                DType::F32 => {
                    let s: &mut Series<f32> = &mut self.get_column_mut(meta.name.as_str()).unwrap();
                    s.drop_positions(positions.clone())
                }
                DType::I32 => {
                    let s: &mut Series<i32> = &mut self.get_column_mut(meta.name.as_str()).unwrap();
                    s.drop_positions(positions.clone())
                }
                DType::STRING => {
                    let s: &mut Series<String> =
                        &mut self.get_column_mut(meta.name.as_str()).unwrap();
                    s.drop_positions(positions.clone())
                }
            };
        }
        self.index.drop_positions(positions);
    }

    /// Iterator over rows of a dataframe where each element contained is a reference
    ///
    /// ## Example
    /// ```
    /// # use blackjack::prelude::*;
    /// # let mut df = DataFrame::new();
    /// # let s1 = Series::from_vec(vec![0, 1, 2, 3]);
    /// # let s2 = Series::from_vec(vec![1, 2, 3, 4]);
    /// # assert!(df.add_column(s1).is_ok());
    /// # assert!(df.add_column(s2).is_ok());
    ///
    /// let rows = df.iter_rows().collect::<Vec<Row>>();
    /// assert_eq!(rows.len(), 4);  // Four rows
    /// assert!(rows.iter().all(|r| r.data.len() == 2));  // Each row has two elements
    /// ```
    pub fn iter_rows(&self) -> impl Iterator<Item = Row<'_>> {
        (0..self.len()).map(move |idx| {
            let mut row = Row::new();
            for meta in self.meta.iter() {
                match meta.dtype {
                    DType::F64 => {
                        let series: &Series<f64> = self.data.get(&meta.name).unwrap();
                        row.add(Element::new(meta.name.clone(), Datum::F64(&series[idx])))
                    }
                    DType::I64 => {
                        let series: &Series<i64> = self.data.get(&meta.name).unwrap();
                        row.add(Element::new(meta.name.clone(), Datum::I64(&series[idx])))
                    }
                    DType::F32 => {
                        let series: &Series<f32> = self.data.get(&meta.name).unwrap();
                        row.add(Element::new(meta.name.clone(), Datum::F32(&series[idx])))
                    }
                    DType::I32 => {
                        let series: &Series<i32> = self.data.get(&meta.name).unwrap();
                        row.add(Element::new(meta.name.clone(), Datum::I32(&series[idx])))
                    }
                    DType::STRING => {
                        let series: &Series<String> = self.data.get(&meta.name).unwrap();
                        row.add(Element::new(meta.name.clone(), Datum::STR(&series[idx])))
                    }
                }
            }
            row
        })
    }

    /// Select rows of the DataFrame based on positional index
    ///
    /// ## Example
    /// ```
    /// use blackjack::prelude::*;
    ///
    /// let mut df = DataFrame::new();
    ///  let s1 = Series::from_vec(vec![0, 1, 2, 3]);
    ///  let s2 = Series::from_vec(vec![1, 2, 3, 4]);
    ///
    ///  assert!(df.add_column(s1).is_ok());
    ///  assert!(df.add_column(s2).is_ok());
    ///
    ///  let rows = df.iloc(vec![1]).collect::<Vec<Row>>();
    ///
    ///  // First column is s1, second element is 1
    ///  if let Datum::I32(val) = rows[0].data[0].data {
    ///      assert_eq!(val, &1);
    ///  }
    ///
    ///  // second column is s2, second element is 2
    ///  if let Datum::I32(val) = rows[0].data[1].data {
    ///      assert_eq!(val, &2);
    ///  }
    /// ```
    pub fn iloc<Idx>(&self, idx: Idx) -> impl Iterator<Item = Row<'_>>
    where
        Idx: IntoIterator<Item = usize>,
    {
        let indexes = idx.into_iter().collect::<Vec<usize>>();

        self.iter_rows()
            .enumerate()
            .filter(move |(idx, _row)| indexes.contains(&idx))
            .map(|(_idx, row)| row)
    }

    /// Length of the dataframe
    ///
    /// ## Example
    /// ```
    /// use blackjack::prelude::*;
    ///
    /// let mut df = DataFrame::new();
    /// assert_eq!(df.len(), 0);
    ///
    /// let series: Series<i32> = Series::arange(0, 10);
    /// df.add_column(series).unwrap();
    ///
    /// assert_eq!(df.len(), 10);
    /// ```
    pub fn len(&self) -> usize {
        self.index.len()
    }

    /// Quickly identify if the dataframe is empty.
    pub fn is_empty(&self) -> bool {
        !self.len() > 0
    }

    /// Add a column to this dataframe.
    pub fn add_column<T: BlackJackData + 'static>(
        &mut self,
        series: Series<T>,
    ) -> Result<(), BlackJackError>
    where
        Vec<I>: std::iter::FromIterator<i32>,
    {
        let mut series = series;

        // Ensure length is a match if we have columns
        if self.len() > 0 && self.len() != series.len() {
            return Err(BlackJackError::LengthMismatch(format!(
                "DataFrame has length: {}, cannot add series of length: {}",
                self.len(),
                series.len()
            )));
        } else {
            self.index = Series::from_vec((0..series.len() as i32).collect::<Vec<I>>())
        }

        if let None = series.name() {
            series.set_name(&format!("col_{}", self.n_columns()))
        }

        let meta = SeriesMeta::from(&series);
        self.data.insert(meta.name.clone(), series);
        self.meta.push(meta);

        Ok(())
    }

    /// Retrieves a mutable reference to the column
    pub fn get_column_mut<'a, T>(&mut self, name: impl Into<&'a str>) -> Option<&mut Series<T>>
    where
        T: BlackJackData + 'static,
    {
        let name = name.into();
        for meta in &self.meta {
            if meta.name == name {
                let series: Option<&mut Series<T>> = self.data.get_mut(&meta.name);
                return series;
            }
        }
        None
    }

    /// Retrieves a reference to a column
    pub fn get_column<'a, T>(&self, name: impl Into<&'a str>) -> Option<&Series<T>>
    where
        T: BlackJackData + 'static,
    {
        let name = name.into();
        for meta in &self.meta {
            if meta.name == name {
                let series: Option<&Series<T>> = self.data.get(&meta.name);
                return series;
            }
        }
        None
    }

    /// Get column, infer
    pub fn get_column_infer<'a>(&self, name: impl Into<&'a str>) -> Option<GenericSeriesContainer> {
        let name = name.into();
        if self.data.contains_key(name) {
            let meta: &SeriesMeta = self.meta.iter().filter(|m| m.name == name).last()?;
            let container = match meta.dtype {
                DType::I64 => {
                    GenericSeriesContainer::I64(self.data.get::<Series<i64>, _>(name)?.clone())
                }
                DType::F64 => {
                    GenericSeriesContainer::F64(self.data.get::<Series<f64>, _>(name)?.clone())
                }
                DType::I32 => {
                    GenericSeriesContainer::I32(self.data.get::<Series<i32>, _>(name)?.clone())
                }
                DType::F32 => {
                    GenericSeriesContainer::F32(self.data.get::<Series<f32>, _>(name)?.clone())
                }
                DType::STRING => GenericSeriesContainer::STRING(
                    self.data.get::<Series<String>, _>(name).unwrap().clone(),
                ),
            };
            Some(container)
        } else {
            None
        }
    }

    /// Get a list of column names in this dataframe as an iterator
    pub fn columns(&self) -> impl Iterator<Item = &str> {
        self.data.keys().map(|c| c.as_str())
    }

    /// Get the number of columns for this dataframe
    pub fn n_columns(&self) -> usize {
        self.data.len()
    }

    /// Group by method for grouping [`Series`] in a [`DataFrame`]
    /// by key.
    pub fn groupby<T>(&self, keys: &Series<T>) -> DataFrameGroupBy<T>
    where
        for<'de> T: BlackJackData + Deserialize<'de> + ToPrimitive + 'static,
    {
        let groups = self
            .columns()
            .map(|col_name| {
                let series = self.get_column(col_name).unwrap();
                series.groupby(keys)
            })
            .collect::<Vec<SeriesGroupBy<T>>>();

        DataFrameGroupBy::new(groups)
    }
}