1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

// Traits
pub use crate::traits::{Configurable, Plotable, Saveable};
use core::fmt::Display;
use core::ops::Add;

pub mod bin;
pub mod comparison;
pub mod error;
pub mod violin;

pub use bin::{SequenceBin, SequenceBins};
pub use comparison::Sequences;
pub use error::{SequenceError, SequenceErrors};
pub use violin::{SequenceViolin, SequenceViolins};

/// Most basic explorable structure: a sequence of values.
///
/// # Remarks
///
/// With the [prelude] module, we can easily convert a [IntoIterator] struct
/// into [Sequence] for ease of use. The same can be achieved with the
/// [new] method.
///
/// # Examples
///
/// Quick plot.
/// ```no_run
/// use preexplorer::prelude::*;
/// (0..10).preexplore().plot("my_identifier").unwrap();
/// ```
///
/// Compare [Sequence] structs.
/// ```no_run
/// use preexplorer::prelude::*;
/// pre::Sequences::new([
///     (0..10).preexplore(),
///     (0..10).preexplore(),
///     ])
///     .plot("my_identifier").unwrap();
/// ```
///
/// [prelude]: prelude/index.html
/// [IntoIterator]: https://doc.rust-lang.org/core/iter/trait.IntoIterator.html
/// [Sequence]: struct.Sequence.html
/// [new]: struct.Sequence.html#method.new

#[derive(Debug, PartialEq, Clone)]
#[cfg_attr(feature = "use-serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Sequence<T>
where
    T: Display + Clone,
{
    data: Vec<T>,
    config: crate::configuration::Configuration,
}

impl<T> Sequence<T>
where
    T: Display + Clone,
{
    /// Constructs a new ``Sequence<T>``.
    ///
    /// # Examples
    ///
    /// From a complicated computation.
    /// ```
    /// use preexplorer::prelude::*;
    /// let data = (0..10).map(|i| i * i + 1);
    /// let seq = pre::Sequence::new(data);
    /// ```
    pub fn new<I>(data: I) -> Sequence<T>
    where
        I: IntoIterator<Item = T>,
    {
        let data: Vec<T> = data.into_iter().collect();
        let config = crate::configuration::Configuration::default();

        Sequence { data, config }
    }
}

impl<T> Add for Sequence<T>
where
    T: Display + Clone,
{
    type Output = crate::Sequences<T>;

    fn add(self, other: crate::Sequence<T>) -> crate::Sequences<T> {
        let mut cmp = self.into();
        cmp += other;
        cmp
    }
}

impl<T> Configurable for Sequence<T>
where
    T: Display + Clone,
{
    fn configuration_mut(&mut self) -> &mut crate::configuration::Configuration {
        &mut self.config
    }
    fn configuration(&self) -> &crate::configuration::Configuration {
        &self.config
    }
}

impl<T> Saveable for Sequence<T>
where
    T: Display + Clone,
{
    fn plotable_data(&self) -> String {
        // Initial warning
        if self.data.is_empty() {
            eprintln!("Warning: There is no data.");
        }

        let mut plotable_data = String::new();

        for (counter, value) in self.data.clone().into_iter().enumerate() {
            plotable_data.push_str(&format!("{}\t{}\n", counter, value));
        }

        plotable_data
    }
}

impl<T> Plotable for Sequence<T>
where
    T: Display + Clone,
{
    fn plot_script(&self) -> String {
        let mut gnuplot_script = self.opening_plot_script();

        let dashtype = self.dashtype().unwrap_or(1);
        gnuplot_script += &format!(
            "plot {:?} with {} dashtype {} \n",
            self.data_path(),
            self.style(),
            dashtype,
        );
        gnuplot_script += &self.ending_plot_script();

        gnuplot_script
    }
}

///////////////////////////////////////////////
#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn set_style() {
        let data = 0..2;
        let mut seq = Sequence::new(data);
        seq.set_style("points").unwrap();

        assert_eq!(
            &crate::configuration::plot::style::Style::Points,
            seq.style()
        );
    }
}