plotting 0.1.1

Plotting.
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

use crate::figure::Figure;
use crate::format::FormatBuilder;
use crate::trace::Trace;

/// Quickly create a 2D plot.
///
/// # Arguments
///
/// * `x` - x-axis data.
/// * `y` - y-axis data.
///
/// # Returns
///
/// Figure.
///
/// # Example
///
/// ```
/// use plotting::{quick_plot_2d, Figure};
///
/// // Plot y = x^2.
/// let fig: Figure = quick_plot_2d([1.0, 2.0, 3.0], [1.0, 4.0, 9.0]);
/// ```
///
/// ## Additional examples
///
/// Additional examples can be found at
/// <https://tamaskis.github.io/plotting/plot_2d/quick_2d_plot.html>.
pub fn quick_plot_2d(x: impl Into<Vec<f64>>, y: impl Into<Vec<f64>>) -> Figure {
    // Create the trace.
    let trace = Trace::new_2d(x.into(), y.into());

    // Formatting.
    let format = FormatBuilder::default().build().unwrap();

    // Create and return the figure.
    Figure::new(vec![trace], format)
}

/// Quickly create a 2D plot with axis labels and a title.
///
/// # Arguments
///
/// * `x` - x-axis data.
/// * `y` - y-axis data.
/// # `x_label` - x-axis label.
/// * `y_label` - y-axis label.
/// * `title` - Title.
///
/// # Returns
///
/// Figure.
///
/// # Example
///
/// ```
/// use plotting::{quick_plot_2d_with_labels, Figure};
///
/// // Plot y = x^2.
/// let fig: Figure = quick_plot_2d_with_labels(
///     [1.0, 2.0, 3.0],
///     [1.0, 4.0, 9.0],
///     "x",
///     "y",
///     "y = x^2",
/// );
/// ```
///
/// ## Additional examples
///
/// Additional examples can be found at
/// <https://tamaskis.github.io/plotting/plot_2d/quick_2d_plot_with_labels.html>.
pub fn quick_plot_2d_with_labels(
    x: impl Into<Vec<f64>>,
    y: impl Into<Vec<f64>>,
    x_label: impl Into<String>,
    y_label: impl Into<String>,
    title: impl Into<String>,
) -> Figure {
    // Create the trace.
    let trace = Trace::new_2d(x.into(), y.into());

    // Formatting.
    let format = FormatBuilder::default()
        .x_label(x_label.into())
        .y_label(y_label.into())
        .title(title.into())
        .build()
        .unwrap();

    // Create and return the figure.
    Figure::new(vec![trace], format)
}

/// Quickly create a 3D plot.
///
/// # Arguments
///
/// * `x` - x-axis data.
/// * `y` - y-axis data.
/// * `z` - z-axis data.
///
/// # Returns
///
/// Figure.
///
/// # Example
///
/// ```
/// use plotting::{quick_plot_3d, Figure};
///
/// let fig: Figure = quick_plot_3d([1.0, 2.0, 10.0], [1.0, 4.0, 9.0], [2.0, 5.0, 10.0]);
/// ```
///
/// ## Additional examples
///
/// Additional examples can be found at
/// <https://tamaskis.github.io/plotting/plot_3d/quick_3d_plot.html>.
pub fn quick_plot_3d(
    x: impl Into<Vec<f64>>,
    y: impl Into<Vec<f64>>,
    z: impl Into<Vec<f64>>,
) -> Figure {
    // Create the trace.
    let trace = Trace::new_3d(x.into(), y.into(), z.into());

    // Formatting.
    let format = FormatBuilder::default().build().unwrap();

    // Create and return the figure.
    Figure::new(vec![trace], format)
}

/// Quickly create a 3D plot with axis labels and a title.
///
/// # Arguments
///
/// * `x` - x-axis data.
/// * `y` - y-axis data.
/// * `z` - z-axis data.
/// # `x_label` - x-axis label.
/// * `y_label` - y-axis label.
/// * `z_label` - z-axis label.
/// * `title` - Title.
///
/// # Returns
///
/// Figure.
///
/// ## Example
///
/// ```
/// use plotting::{quick_plot_3d_with_labels, Figure};
///
/// let fig: Figure = quick_plot_3d_with_labels(
///     [1.0, 2.0, 10.0],
///     [1.0, 4.0, 9.0],
///     [2.0, 5.0, 10.0],
///     "x",
///     "y",
///     "z",
///     "z vs. x and y",
/// );
/// ```
///
/// ## Additional examples
///
/// Additional examples can be found at
/// <https://tamaskis.github.io/plotting/plot_3d/quick_3d_plot_with_labels.html>.
pub fn quick_plot_3d_with_labels(
    x: impl Into<Vec<f64>>,
    y: impl Into<Vec<f64>>,
    z: impl Into<Vec<f64>>,
    x_label: impl Into<String>,
    y_label: impl Into<String>,
    z_label: impl Into<String>,
    title: impl Into<String>,
) -> Figure {
    // Create the trace.
    let trace = Trace::new_3d(x.into(), y.into(), z.into());

    // Formatting.
    let format = FormatBuilder::default()
        .x_label(x_label.into())
        .y_label(y_label.into())
        .z_label(z_label.into())
        .title(title.into())
        .build()
        .unwrap();

    // Create and return the figure.
    Figure::new(vec![trace], format)
}

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

    #[test]
    fn test_quick_plot_2d() {
        let fig: Figure = quick_plot_2d([1.0, 2.0, 3.0], [1.0, 4.0, 9.0]);
        assert_eq!(fig.traces[0].x, [1.0, 2.0, 3.0]);
        assert_eq!(fig.traces[0].y, [1.0, 4.0, 9.0]);
        assert!(fig.format.title.is_none());
        assert!(fig.format.x_label.is_none());
        assert!(fig.format.y_label.is_none());
        assert!(fig.format.width.is_none());
        assert!(fig.format.height.is_none());
    }

    #[test]
    fn test_quick_plot_2d_with_labels() {
        let fig: Figure =
            quick_plot_2d_with_labels([1.0, 2.0, 3.0], [1.0, 4.0, 9.0], "x", "y", "y vs. x");
        assert_eq!(fig.traces[0].x, [1.0, 2.0, 3.0]);
        assert_eq!(fig.traces[0].y, [1.0, 4.0, 9.0]);
        assert_eq!(fig.format.title.unwrap(), "y vs. x");
        assert_eq!(fig.format.x_label.unwrap(), "x");
        assert_eq!(fig.format.y_label.unwrap(), "y");
        assert!(fig.format.width.is_none());
        assert!(fig.format.height.is_none());
    }

    #[test]
    fn test_quick_plot_3d() {
        let fig: Figure = quick_plot_3d([1.0, 2.0, 10.0], [1.0, 4.0, 9.0], [2.0, 5.0, 10.0]);
        assert_eq!(fig.traces[0].x, [1.0, 2.0, 10.0]);
        assert_eq!(fig.traces[0].y, [1.0, 4.0, 9.0]);
        assert_eq!(fig.traces[0].z.clone().unwrap(), [2.0, 5.0, 10.0]);
        assert!(fig.format.title.is_none());
        assert!(fig.format.x_label.is_none());
        assert!(fig.format.y_label.is_none());
        assert!(fig.format.z_label.is_none());
        assert!(fig.format.width.is_none());
        assert!(fig.format.height.is_none());
    }

    #[test]
    fn test_quick_plot_3d_with_labels() {
        let fig: Figure = quick_plot_3d_with_labels(
            [1.0, 2.0, 10.0],
            [1.0, 4.0, 9.0],
            [2.0, 5.0, 10.0],
            "x",
            "y",
            "z",
            "z vs. x and y",
        );
        assert_eq!(fig.traces[0].x, [1.0, 2.0, 10.0]);
        assert_eq!(fig.traces[0].y, [1.0, 4.0, 9.0]);
        assert_eq!(fig.traces[0].z.clone().unwrap(), [2.0, 5.0, 10.0]);
        assert_eq!(fig.format.title.unwrap(), "z vs. x and y");
        assert_eq!(fig.format.x_label.unwrap(), "x");
        assert_eq!(fig.format.y_label.unwrap(), "y");
        assert_eq!(fig.format.z_label.unwrap(), "z");
        assert!(fig.format.width.is_none());
        assert!(fig.format.height.is_none());
    }
}