complot 0.3.5

An idiomatic high-level wrapper to Rust plotters visualization crate
Documentation 
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308

use crate::{canvas, Axis, Config, Utils};
use colorous;
use plotters::prelude::*;
use std::{iter::FromIterator, path::Path};

/// Line plots
pub struct Plot;
impl Utils for Plot {}
/*impl FromIterator<f64> for Plot {
    fn from_iter<I: IntoIterator<Item = f64>>(iter: I) -> Self {
        let fig = SVGBackend::new("plot.svg", (768, 512)).into_drawing_area();
        fig.fill(&WHITE).unwrap();
        let xy: Vec<_> = iter
            .into_iter()
            .collect::<Vec<f64>>()
            .chunks(2)
            .map(|xy| (xy[0], xy[1]))
            .collect();
        let (x_max, y_max) = xy.iter().cloned().fold(
            (f64::NEG_INFINITY, f64::NEG_INFINITY),
            |(fx, fy), (x, y)| (fx.max(x), fy.max(y)),
        );
        let (x_min, y_min) = xy
            .iter()
            .cloned()
            .fold((f64::INFINITY, f64::INFINITY), |(fx, fy), (x, y)| {
                (fx.min(x), fy.min(y))
            });
        let mut ax = chart([x_min, x_max, y_min, y_max], &fig);
        ax.draw_series(xy.into_iter().map(|xy| Circle::new(xy, 3, RED.filled())))
            .unwrap();
        Plot {}
    }
}*/

/// Plots different lines (x,y1), (x,y2), ... with the data formated into an iterator
/// where each item is the tuple `(x[i], vec![y1[i], y2[i], ...])`,
/// the graph is written in the file `plot.svg`
/// ```
///(0..100).map(|k| {
///                   let o = 5.*std::f64::consts::PI*k as f64/100.;
///                   let (s,c) = o.sin_cos();
///                   (o,vec![s,c])
///                  }).collect::<complot::Plot>();
///```
impl FromIterator<(f64, Vec<f64>)> for Plot {
    fn from_iter<I: IntoIterator<Item = (f64, Vec<f64>)>>(iter: I) -> Self {
        let filename = "complot-plot";
        let path = if cfg!(feature = "png") {
            Path::new(filename).with_extension("png")
        } else {
            Path::new(filename).with_extension("svg")
        };

        let fig = canvas(path.to_str().unwrap(), (768, 512));
        //        fig.fill(&WHITE).unwrap();
        let xy: Vec<_> = iter.into_iter().collect();
        let (x_max, y_max) = Self::xy_max(&xy);
        let (x_min, y_min) = Self::xy_min(&xy);
        let mut chart = ChartBuilder::on(&fig)
            .set_label_area_size(LabelAreaPosition::Left, 50)
            .set_label_area_size(LabelAreaPosition::Bottom, 40)
            .margin(10)
            .build_cartesian_2d(x_min..x_max, y_min..y_max)
            .unwrap();
        chart.configure_mesh().draw().unwrap();
        let n_y = xy[0].1.len();
        let data: Vec<_> = xy
            .into_iter()
            .flat_map(|(x, y)| y.into_iter().map(|y| (x, y)).collect::<Vec<(f64, f64)>>())
            .collect();
        let mut colors = colorous::TABLEAU10.iter().cycle();
        for k in 0..n_y {
            let this_color = colors.next().unwrap().as_tuple();
            chart
                .draw_series(LineSeries::new(
                    data.iter().skip(k).step_by(n_y).cloned(),
                    RGBColor(this_color.0, this_color.1, this_color.2),
                ))
                .unwrap();
        }
        Plot {}
    }
}

type Result<T> = std::result::Result<T, Box<dyn std::error::Error>>;

impl<I: Iterator<Item = (f64, Vec<f64>)>> From<(I, Option<Config>)> for Plot {
    fn from((iter, config): (I, Option<Config>)) -> Self {
        fn inner<I: Iterator<Item = (f64, Vec<f64>)>>(
            (iter, config): (I, Option<Config>),
        ) -> Result<()> {
            let config = config.unwrap_or_default();
            let filename = config
                .filename
                .unwrap_or_else(|| "complot-plot".to_string());
            let path = if cfg!(feature = "png") {
                Path::new(&filename).with_extension("png")
            } else {
                Path::new(&filename).with_extension("svg")
            };

            let fig = canvas(path.to_str().unwrap(), (768, 512));
            fig.fill(&WHITE)?;
            let xy: Vec<_> = iter.collect();
            let (x_max, y_max) = Plot::xy_max(&xy);
            let (x_min, y_min) = Plot::xy_min(&xy);
            assert!(
                x_max > x_min,
                "Incorrect x axis range: {:?}",
                [x_min, x_max]
            );
            assert!(
                y_max > y_min,
                "Incorrect y axis range: {:?}",
                [y_min, y_max]
            );

            let mut chart = ChartBuilder::on(&fig)
                .set_label_area_size(LabelAreaPosition::Left, 50)
                .set_label_area_size(LabelAreaPosition::Bottom, 40)
                .margin(10)
                .build_cartesian_2d(x_min..x_max, y_min..y_max)?;
            let mut mesh = chart.configure_mesh();
            if let Some(value) = config.xaxis.label {
                mesh.x_desc(value);
            }
            if let Some(value) = config.yaxis.label {
                mesh.y_desc(value);
            }
            mesh.draw()?;

            let n_y = xy[0].1.len();
            let data: Vec<_> = xy
                .into_iter()
                .flat_map(|(x, y)| y.into_iter().map(|y| (x, y)).collect::<Vec<(f64, f64)>>())
                .collect();
            let mut colors = colorous::TABLEAU10.iter().cycle();
            if let Some(legend) = config.legend {
                for (k, key) in (0..n_y).zip(legend.into_iter()) {
                    let this_color = colors
                        .next()
                        .ok_or("Couldn't get another color.")?
                        .as_tuple();
                    let rgb = RGBColor(this_color.0, this_color.1, this_color.2);
                    chart
                        .draw_series(LineSeries::new(
                            data.iter().skip(k).step_by(n_y).cloned(),
                            &rgb,
                            //BLACK.mix(0.25),
                        ))?
                        .label(key)
                        .legend(move |(x, y)| PathElement::new(vec![(x, y), (x + 20, y)], &rgb));
                }
                chart
                    .configure_series_labels()
                    .border_style(&BLACK)
                    .background_style(&WHITE.mix(0.8))
                    .position(SeriesLabelPosition::UpperRight)
                    .draw()
                    .unwrap();
            } else {
                for k in 0..n_y {
                    let this_color = colors
                        .next()
                        .ok_or("Couldn't get another color.")?
                        .as_tuple();
                    chart.draw_series(LineSeries::new(
                        data.iter().skip(k).step_by(n_y).cloned(),
                        RGBColor(this_color.0, this_color.1, this_color.2),
                        //BLACK.mix(0.25),
                    ))?;
                }
            }
            Ok(())
        }
        if let Err(e) = inner((iter, config)) {
            println!("Complot failed in Plot: {}", e);
        }
        Plot {}
    }
}

/// Log-log plots
///
/// Like [`Plot`] but for `(log10(x),vec![log10(y),...])` items
pub struct LogLog;
impl Utils for LogLog {}
impl<I: Iterator<Item = (f64, Vec<f64>)>> From<(I, Option<Config>)> for LogLog {
    fn from((iter, config): (I, Option<Config>)) -> Self {
        let _: Plot = (
            iter.map(|(x, y)| {
                (
                    x.log10(),
                    y.into_iter().map(|y| y.log10()).collect::<Vec<f64>>(),
                )
            }),
            Some(match config {
                Some(config) => {
                    match (&config.filename, &config.xaxis.label, &config.yaxis.label) {
                        (None, None, None) => config.filename("complot-linlog.svg"),
                        (None, None, Some(label)) => {
                            let log10_label = format!("log10( {} )", label);
                            config
                                .filename("complot-linlog.svg")
                                .yaxis(Axis::new().label(log10_label))
                        }
                        (None, Some(label), None) => {
                            let log10_label = format!("log10( {} )", label);
                            config
                                .filename("complot-linlog.svg")
                                .xaxis(Axis::new().label(log10_label))
                        }
                        (None, Some(xlabel), Some(ylabel)) => {
                            let log10_xlabel = format!("log10( {} )", xlabel);
                            let log10_ylabel = format!("log10( {} )", ylabel);
                            config
                                .filename("complot-linlog.svg")
                                .xaxis(Axis::new().label(log10_xlabel))
                                .yaxis(Axis::new().label(log10_ylabel))
                        }
                        (Some(_), None, None) => config,
                        (Some(_), None, Some(label)) => {
                            let log10_label = format!("log10( {} )", label);
                            config.yaxis(Axis::new().label(log10_label))
                        }
                        (Some(_), Some(label), None) => {
                            let log10_label = format!("log10( {} )", label);
                            config.xaxis(Axis::new().label(log10_label))
                        }
                        (Some(_), Some(xlabel), Some(ylabel)) => {
                            let log10_xlabel = format!("log10( {} )", xlabel);
                            let log10_ylabel = format!("log10( {} )", ylabel);
                            config
                                .xaxis(Axis::new().label(log10_xlabel))
                                .yaxis(Axis::new().label(log10_ylabel))
                        }
                    }
                }
                None => Config::new().filename("complot-linlog.svg"),
            }),
        )
            .into();
        LogLog
    }
}
/// Log-Lin plots
///
/// Like [`Plot`] but for `(log10(x),vec![y,...])` items
pub struct LogLin;
impl Utils for LogLin {}
impl<I: Iterator<Item = (f64, Vec<f64>)>> From<(I, Option<Config>)> for LogLin {
    fn from((iter, config): (I, Option<Config>)) -> Self {
        let _: Plot = (
            iter.map(|(x, y)| (x.log10(), y)),
            Some(match config {
                Some(config) => match (&config.filename, &config.xaxis.label) {
                    (None, None) => config.filename("complot-linlog.svg"),
                    (None, Some(label)) => {
                        let log10_label = format!("log10( {} )", label);
                        config
                            .filename("complot-linlog.svg")
                            .yaxis(Axis::new().label(log10_label))
                    }
                    (Some(_), Some(label)) => {
                        let log10_label = format!("log10( {} )", label);
                        config.yaxis(Axis::new().label(log10_label))
                    }
                    (Some(_), None) => config,
                },
                None => Config::new().filename("complot-linlog.svg"),
            }),
        )
            .into();
        LogLin
    }
}
/// Lin-log plots
///
/// Like [`Plot`] but for `(x,vec![log10(y),...])` items
pub struct LinLog;
impl Utils for LinLog {}
impl<I: Iterator<Item = (f64, Vec<f64>)>> From<(I, Option<Config>)> for LinLog {
    fn from((iter, config): (I, Option<Config>)) -> Self {
        let _: Plot = (
            iter.map(|(x, y)| (x, y.into_iter().map(|y| y.log10()).collect::<Vec<f64>>())),
            Some(match config {
                Some(config) => match (&config.filename, &config.yaxis.label) {
                    (None, None) => config.filename("complot-linlog.svg"),
                    (None, Some(label)) => {
                        let log10_label = format!("log10( {} )", label);
                        config
                            .filename("complot-linlog.svg")
                            .yaxis(Axis::new().label(log10_label))
                    }
                    (Some(_), Some(label)) => {
                        let log10_label = format!("log10( {} )", label);
                        config.yaxis(Axis::new().label(log10_label))
                    }
                    (Some(_), None) => config,
                },
                None => Config::new().filename("complot-linlog.svg"),
            }),
        )
            .into();
        LinLog
    }
}