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
use super::{matrix_to_list, vector_to_strings, GraphMaker};
use std::fmt::Write;
/// Generates a Histogram plot
///
/// # Example
///
/// ```
/// use plotpy::{Histogram, Plot, StrError};
///
/// fn main() -> Result<(), StrError> {
/// // set values
/// let values = vec![
/// vec![1, 1, 1, 2, 2, 2, 2, 2, 3, 3, 4, 5, 6], // first series
/// vec![-1, -1, 0, 1, 2, 3], // second series
/// vec![5, 6, 7, 8], // third series
/// ];
///
/// // set labels
/// let labels = ["first", "second", "third"];
///
/// // configure and draw histogram
/// let mut histogram = Histogram::new();
/// histogram.set_colors(&["#9de19a", "#e7eca3", "#98a7f2"])
/// .set_line_width(10.0)
/// .set_stacked(true)
/// .set_style("step");
/// histogram.draw(&values, &labels);
///
/// // add histogram to plot
/// let mut plot = Plot::new();
/// plot.add(&histogram)
/// .set_frame_border(true, false, true, false)
/// .grid_labels_legend("values", "count");
///
/// // save figure
/// plot.save("/tmp/plotpy/doc_tests/doc_histogram.svg")?;
/// Ok(())
/// }
/// ```
///
/// ![doc_histogram.svg](https://raw.githubusercontent.com/cpmech/plotpy/main/figures/doc_histogram.svg)
///
/// See also integration test in the **tests** directory.
///
/// Output from some integration tests:
///
/// ![integ_histogram_1.svg](https://raw.githubusercontent.com/cpmech/plotpy/main/figures/integ_histogram_1.svg)
pub struct Histogram {
colors: Vec<String>, // Colors for each bar
line_width: f64, // Line width
style: String, // Type of histogram; e.g. "bar"
stacked: bool, // Draws stacked histogram
no_fill: bool, // Skip filling bars
number_bins: usize, // Number of bins
buffer: String, // buffer
}
impl Histogram {
/// Creates a new Histogram object
pub fn new() -> Self {
Histogram {
colors: Vec::new(),
line_width: 0.0,
style: String::new(),
stacked: false,
no_fill: false,
number_bins: 0,
buffer: String::new(),
}
}
/// Draws histogram
///
/// # Input
///
/// * `values` - values
/// * `labels` - labels
///
/// # Notes
///
/// * The type `T` must be a number.
/// * The type `U` must be a String or &str.
///
pub fn draw<T, U>(&mut self, values: &Vec<Vec<T>>, labels: &[U])
where
T: std::fmt::Display,
U: std::fmt::Display,
{
let opt = self.options();
matrix_to_list(&mut self.buffer, "values", values);
vector_to_strings(&mut self.buffer, "labels", labels);
if self.colors.len() > 0 {
vector_to_strings(&mut self.buffer, "colors", self.colors.as_slice());
}
write!(&mut self.buffer, "plt.hist(values,label=labels{})\n", &opt).unwrap();
}
/// Sets the colors for each bar
pub fn set_colors(&mut self, colors: &[&str]) -> &mut Self {
self.colors = colors.iter().map(|color| color.to_string()).collect();
self
}
/// Sets the width of the lines
pub fn set_line_width(&mut self, width: f64) -> &mut Self {
self.line_width = width;
self
}
/// Sets the type of histogram
///
/// Options:
///
/// * `bar` is a traditional bar-type histogram. If multiple data are given the bars are arranged side by side.
/// * `barstacked` is a bar-type histogram where multiple data are stacked on top of each other.
/// * `step` generates a lineplot that is by default unfilled.
/// * `stepfilled` generates a lineplot that is by default filled.
/// * As defined in <https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.hist.html>
pub fn set_style(&mut self, style: &str) -> &mut Self {
self.style = String::from(style);
self
}
/// Sets option to draw stacked histogram
pub fn set_stacked(&mut self, flag: bool) -> &mut Self {
self.stacked = flag;
self
}
/// Sets option to skip filling bars
pub fn set_no_fill(&mut self, flag: bool) -> &mut Self {
self.no_fill = flag;
self
}
/// Sets the number of bins
pub fn set_number_bins(&mut self, bins: usize) -> &mut Self {
self.number_bins = bins;
self
}
/// Returns options for histogram
fn options(&self) -> String {
let mut opt = String::new();
if self.colors.len() > 0 {
write!(&mut opt, ",color=colors").unwrap();
}
if self.line_width > 0.0 {
write!(&mut opt, ",linewidth={}", self.line_width).unwrap();
}
if self.style != "" {
write!(&mut opt, ",histtype='{}'", self.style).unwrap();
}
if self.stacked {
write!(&mut opt, ",stacked=True").unwrap();
}
if self.no_fill {
write!(&mut opt, ",fill=False").unwrap();
}
if self.number_bins > 0 {
write!(&mut opt, ",bins={}", self.number_bins).unwrap();
}
opt
}
}
impl GraphMaker for Histogram {
fn get_buffer<'a>(&'a self) -> &'a String {
&self.buffer
}
fn clear_buffer(&mut self) {
self.buffer.clear();
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#[cfg(test)]
mod tests {
use super::Histogram;
use crate::GraphMaker;
#[test]
fn new_works() {
let histogram = Histogram::new();
assert_eq!(histogram.colors.len(), 0);
assert_eq!(histogram.line_width, 0.0);
assert_eq!(histogram.style.len(), 0);
assert_eq!(histogram.stacked, false);
assert_eq!(histogram.no_fill, false);
assert_eq!(histogram.number_bins, 0);
assert_eq!(histogram.buffer.len(), 0);
}
#[test]
fn options_works() {
let mut histogram = Histogram::new();
histogram
.set_colors(&vec!["red", "green"])
.set_line_width(10.0)
.set_style("step")
.set_stacked(true)
.set_no_fill(true)
.set_number_bins(8);
let opt = histogram.options();
assert_eq!(
opt,
",color=colors\
,linewidth=10\
,histtype='step'\
,stacked=True\
,fill=False\
,bins=8"
);
}
#[test]
fn draw_works() {
let values = vec![vec![1, 1, 1, 2, 2, 2, 2, 2, 3, 3], vec![5, 6, 7, 8]];
let labels = ["first", "second"];
let mut histogram = Histogram::new();
histogram.set_colors(&vec!["red", "green"]);
histogram.draw(&values, &labels);
let b: &str = "values=[[1,1,1,2,2,2,2,2,3,3,],[5,6,7,8,],]\n\
labels=['first','second',]\n\
colors=['red','green',]\n\
plt.hist(values,label=labels,color=colors)\n";
assert_eq!(histogram.buffer, b);
histogram.clear_buffer();
assert_eq!(histogram.buffer, "");
}
}