Remove box_???_set_width functions in favour of BoxWidth PlotOption

Author: etfrogers

gnuplot/examples/box_and_whisker.rs

@@ -10,14 +10,22 @@ fn example(c: Common)
 
 	fg.axes2d()
 		.set_title("Box and whisker", &[])
-		.box_and_whisker_set_width(
+		.box_and_whisker(
+			[0.0f32, 1.0, 2.0].iter(),
+			[-1.0f32, 0.0, 1.0].iter(),
+			[-2.0f32, -1.0, 0.0].iter(),
+			[2.0f32, 3.0, 4.0].iter(),
+			[1.0f32, 2.0, 3.0].iter(),
+			&[],
+		)
+		.box_and_whisker(
 			[-0.6f32, 1.5, 2.5].iter(),
 			[-1.0f32, 0.0, 1.0].iter(),
 			[-2.0f32, -1.0, 0.0].iter(),
 			[2.0f32, 3.0, 4.0].iter(),
 			[1.0f32, 2.0, 3.0].iter(),
-			[0.5f32, 0.25, 0.125].iter(),
 			&[
+				BoxWidth([0.5f64, 0.25, 0.125].into()),
 				WhiskerBars(0.5),
 				Color("blue".into()),
 				LineWidth(2.0),

gnuplot/examples/example2.rs

@@ -2,7 +2,6 @@
 use crate::common::*;
 
 use gnuplot::*;
-use std::iter::repeat;
 
 mod common;
 
@@ -17,7 +16,6 @@ fn example(c: Common)
 	let x2 = x2.iter2();
 	let y2: Vec<i32> = x2.map(|&v| v * v).collect();
 	let y2 = y2.iter2();
-	let w = repeat(0.5f32);
 
 	let x3 = &[1i32, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];
 	let x3 = x3.iter2();
@@ -83,14 +81,14 @@ fn example(c: Common)
 				LineStyle(DotDash),
 			],
 		)
-		.boxes_set_width(
+		.boxes(
 			x,
 			y1,
-			w,
 			&[
 				LineWidth(2.0),
 				Color("gray".into()),
 				BorderColor("black".into()),
+				BoxWidth([0.5, 0.4, 0.55, 0.7, 0.2].into()),
 			],
 		);
 

gnuplot/examples/inverse_api.rs

@@ -42,6 +42,7 @@ impl PlotElement for Lines
 				WhiskerBars(v) => WhiskerBars(*v),
 				FillPattern(v) => FillPattern(*v),
 				Axes(v1, v2) => Axes(*v1, *v2),
+				BoxWidth(v) => BoxWidth(v.to_vec()),
 			});
 		}
 

gnuplot/examples/patterns.rs

@@ -12,9 +12,10 @@ fn example(c: Common)
 	ax.set_title("Patterns", &[]);
 	ax.set_legend(Graph(1.), Graph(0.95), &[MaxRows(3)], &[]);
 	ax.set_y_range(Auto, Fix(8.));
+	ax.set_box_width(0.5, false);
 	for i in 0..=8
 	{
-		ax.boxes_set_width(&[i], &[5], &[0.5], &[FillPattern(Auto)]);
+		ax.boxes(&[i], &[5], &[FillPattern(Auto)]);
 	}
 
 	for (i, &pattern) in [
@@ -31,10 +32,9 @@ fn example(c: Common)
 	.iter()
 	.enumerate()
 	{
-		ax.boxes_set_width(
+		ax.boxes(
 			&[i],
 			&[-5],
-			&[0.5],
 			&[
 				FillPattern(Fix(pattern)),
 				Caption(&format!("{:?}", pattern)),

gnuplot/src/axes2d.rs

@@ -667,8 +667,12 @@ impl Axes2D
 		self
 	}
 
-	/// Plot a 2D scatter-plot using boxes of automatic width. Box widths are set so that there are no gaps between successive boxes (i.e. each box may have a different width).
+	/// Plot a 2D box-plot.
+	/// Box widths are, by default set so that there are no gaps between successive boxes
+	/// (i.e. each box may have a different width). This may be adjusted with (set_box_width())[Axes2D::set_box_width()]
+	/// or by using the `BoxWidth` option.
 	/// Boxes start at the x-axis and go towards the y value of the datapoint.
+	///
 	/// # Arguments
 	/// * `x` - x values (center of the box)
 	/// * `y` - y values
@@ -679,6 +683,8 @@ impl Axes2D
 	///     * `BorderColor` - Sets the color of the border
 	///     * `Color` - Sets the color of the box fill
 	///     * `FillAlpha` - Sets the transparency of the box fill
+	///		* `BoxWidth` - Sets the width of each box. If not supplied, the width will use the
+	/// 		previously set box width, or be set to the spacing of the boxes
 	pub fn boxes<
 		'l,
 		Tx: DataType,
@@ -696,42 +702,13 @@ impl Axes2D
 		self
 	}
 
-	/// Plot a 2D scatter-plot using boxes of set (per box) width.
-	/// Boxes start at the x-axis and go towards the y value of the datapoint.
-	/// # Arguments
-	/// * `x` - x values (center of the box)
-	/// * `y` - y values
-	/// * `w` - Box width values
-	/// * `options` - Array of PlotOption<&str> controlling the appearance of the plot element. The relevant options are:
-	///     * `Caption` - Specifies the caption for this dataset. Use an empty string to hide it (default).
-	///     * `LineWidth` - Sets the width of the border
-	///     * `LineStyle` - Sets the style of the border
-	///     * `BorderColor` - Sets the color of the border
-	///     * `Color` - Sets the color of the box fill
-	///     * `FillAlpha` - Sets the transparency of the box fill
-	pub fn boxes_set_width<
-		'l,
-		Tx: DataType,
-		X: IntoIterator<Item = Tx>,
-		Ty: DataType,
-		Y: IntoIterator<Item = Ty>,
-		Tw: DataType,
-		W: IntoIterator<Item = Tw>,
-	>(
-		&'l mut self, x: X, y: Y, w: W, options: &[PlotOption<&str>],
-	) -> &'l mut Self
-	{
-		let (data, num_rows, num_cols) = generate_data!(options, x, y, w);
-		self.common.elems.push(PlotElement::new_plot(
-			Boxes, data, num_rows, num_cols, options,
-		));
-		self
-	}
-
 	/// Plot a 2D box-plot with error bars using boxes of automatic width.
-	/// Box widths are set so that there are no gaps between successive boxes (i.e. each box may have a different width).
+	/// Box widths are, by default set so that there are no gaps between successive boxes
+	/// (i.e. each box may have a different width). This may be adjusted with (set_box_width())[Axes2D::set_box_width()]
+	/// or by using the `BoxWidth` option.
 	/// Boxes start at the x-axis and go towards the y value of the datapoint.
 	/// Each box has an error bar from y - y_delta to y + y_delta.
+	///
 	/// # Arguments
 	/// * `x` - x values (center of the box)
 	/// * `y` - y values
@@ -743,6 +720,8 @@ impl Axes2D
 	///     * `BorderColor` - Sets the color of the border
 	///     * `Color` - Sets the color of the box fill
 	///     * `FillAlpha` - Sets the transparency of the box fill
+	///		* `BoxWidth` - Sets the width of each box. If not supplied, the width will use the
+	/// 		previously set box width, or be set to the spacing of the boxes
 	pub fn box_error_delta<
 		'l,
 		Tx: DataType,
@@ -766,49 +745,10 @@ impl Axes2D
 		self
 	}
 
-	/// Plot a 2D box-plot with error bars using boxes of specified width.
-	/// Box widths are set so that there are no gaps between successive boxes (i.e. each box may have a different width).
-	/// Boxes start at the x-axis and go towards the y value of the datapoint.
-	/// Each box has an error bar from y - y_delta to y + y_delta.
-	/// # Arguments
-	/// * `x` - x values (center of the box)
-	/// * `y` - y values
-	/// * `y_delta` - errors in y (error bars are plotted from y - y_delta to y + y_delta)
-	/// * `x_delta` - errors in x (interpreted as box width)
-	/// * `options` - Array of PlotOption<&str> controlling the appearance of the plot element. The relevant options are:
-	///     * `Caption` - Specifies the caption for this dataset. Use an empty string to hide it (default).
-	///     * `LineWidth` - Sets the width of the border
-	///     * `LineStyle` - Sets the style of the border
-	///     * `BorderColor` - Sets the color of the border
-	///     * `Color` - Sets the color of the box fill
-	///     * `FillAlpha` - Sets the transparency of the box fill
-	pub fn box_error_delta_set_width<
-		'l,
-		Tx: DataType,
-		X: IntoIterator<Item = Tx>,
-		Ty: DataType,
-		Y: IntoIterator<Item = Ty>,
-		Tye: DataType,
-		YE: IntoIterator<Item = Tye>,
-		Tw: DataType,
-		W: IntoIterator<Item = Tw>,
-	>(
-		&'l mut self, x: X, y: Y, y_error: YE, x_delta: W, options: &[PlotOption<&str>],
-	) -> &'l mut Self
-	{
-		let (data, num_rows, num_cols) = generate_data!(options, x, y, y_error, x_delta);
-		self.common.elems.push(PlotElement::new_plot(
-			BoxErrorBars,
-			data,
-			num_rows,
-			num_cols,
-			options,
-		));
-		self
-	}
-
-	/// Plot a 2D box-plot with error bars using boxes of automatic width.
-	/// Box widths are set so that there are no gaps between successive boxes (i.e. each box may have a different width).
+	/// Plot a 2D box-plot with error bars.
+	/// Box widths are, by default set so that there are no gaps between successive boxes
+	/// (i.e. each box may have a different width). This may be adjusted with (set_box_width())[Axes2D::set_box_width()]
+	/// or by using the `BoxWidth` option.
 	/// Boxes start at the x-axis and go towards the y value of the datapoint.
 	/// Each box has an error bar from y - y_low to y + y_high.
 	/// # Arguments
@@ -823,6 +763,8 @@ impl Axes2D
 	///     * `BorderColor` - Sets the color of the border
 	///     * `Color` - Sets the color of the box fill
 	///     * `FillAlpha` - Sets the transparency of the box fill
+	///		* `BoxWidth` - Sets the width of each box. If not supplied, the width will use the
+	/// 		previously set box width, or be set to the spacing of the boxes
 	pub fn box_error_low_high<
 		'l,
 		Tx: DataType,
@@ -851,51 +793,11 @@ impl Axes2D
 		self
 	}
 
-	/// Plot a 2D box-plot with error bars using boxes of specified width.
-	/// Box widths are set so that there are no gaps between successive boxes (i.e. each box may have a different width).
-	/// Boxes start at the x-axis and go towards the y value of the datapoint.
-	/// Each box has an error bar from y - y_low to y + y_high.
-	/// # Arguments
-	/// * `x` - x values (center of the box)
-	/// * `y` - y values
-	/// * `y_low` - minimum of error bar
-	/// * `y_high` - maximum of error bar
-	/// * `x_delta` - errors in x (interpreted as box width)
-	/// * `options` - Array of PlotOption<&str> controlling the appearance of the plot element. The relevant options are:
-	///     * `Caption` - Specifies the caption for this dataset. Use an empty string to hide it (default).
-	///     * `LineWidth` - Sets the width of the border
-	///     * `LineStyle` - Sets the style of the border
-	///     * `BorderColor` - Sets the color of the border
-	///     * `Color` - Sets the color of the box fill
-	///     * `FillAlpha` - Sets the transparency of the box fill
-	pub fn box_error_low_high_set_width<
-		'l,
-		Tx: DataType,
-		X: IntoIterator<Item = Tx>,
-		Ty: DataType,
-		Y: IntoIterator<Item = Ty>,
-		Tyl: DataType,
-		YL: IntoIterator<Item = Tyl>,
-		Tyh: DataType,
-		YH: IntoIterator<Item = Tyh>,
-		Tw: DataType,
-		W: IntoIterator<Item = Tw>,
-	>(
-		&'l mut self, x: X, y: Y, y_low: YL, y_high: YH, x_delta: W, options: &[PlotOption<&str>],
-	) -> &'l mut Self
-	{
-		let (data, num_rows, num_cols) = generate_data!(options, x, y, y_low, y_high, x_delta);
-		self.common.elems.push(PlotElement::new_plot(
-			BoxErrorBars,
-			data,
-			num_rows,
-			num_cols,
-			options,
-		));
-		self
-	}
-
-	/// Plot a 2D box-and-whisker plot using boxes of automatic width.
+	/// Plot a 2D box-and-whisker plot.
+	///
+	/// Box widths are, by default set so that there are no gaps between successive boxes
+	/// (i.e. each box may have a different width). This may be adjusted with (set_box_width())[Axes2D::set_box_width()]
+	/// or by using the `BoxWidth` option.
 	///
 	/// # Arguments
 	/// * `x` - x values (center of the box)
@@ -911,6 +813,8 @@ impl Axes2D
 	///     * `Color` - Sets the color of the box fill
 	///     * `FillAlpha` - Sets the transparency of the box fill
 	///     * `WhiskerBars` - Sets the width of the whisker bars
+	///		* `BoxWidth` - Sets the width of each box. If not supplied, the width will use the
+	/// 		previously set box width, or be set to the spacing of the boxes
 	pub fn box_and_whisker<
 		'l,
 		Tx: DataType,
@@ -940,61 +844,6 @@ impl Axes2D
 		self
 	}
 
-	/// Plot a 2D box-and-whisker plot using boxes of set width.
-	///
-	/// # Arguments
-	/// * `x` - x values (center of the box)
-	/// * `box_min` - minimum box y value
-	/// * `whisker_min` - minimum whisker y value
-	/// * `whisker_max` - maximum whisker y value
-	/// * `box_max` - maximum box y value
-	/// * `box_width` - width of the box (in x axis units)
-	/// * `options` - Array of PlotOption<&str> controlling the appearance of the plot element. The relevant options are:
-	///     * `Caption` - Specifies the caption for this dataset. Use an empty string to hide it (default).
-	///     * `LineWidth` - Sets the width of the border
-	///     * `LineStyle` - Sets the style of the border
-	///     * `BorderColor` - Sets the color of the border
-	///     * `Color` - Sets the color of the box fill
-	///     * `FillAlpha` - Sets the transparency of the box fill
-	///     * `WhiskerBars` - Sets the width of the whisker bars
-	pub fn box_and_whisker_set_width<
-		'l,
-		Tx: DataType,
-		X: IntoIterator<Item = Tx>,
-		TBoxMin: DataType,
-		BoxMin: IntoIterator<Item = TBoxMin>,
-		TWhiskerMin: DataType,
-		WhiskerMin: IntoIterator<Item = TWhiskerMin>,
-		TWhiskerMax: DataType,
-		WhiskerMax: IntoIterator<Item = TWhiskerMax>,
-		TBoxMax: DataType,
-		BoxMax: IntoIterator<Item = TBoxMax>,
-		TBoxWidth: DataType,
-		BoxWidth: IntoIterator<Item = TBoxWidth>,
-	>(
-		&'l mut self, x: X, box_min: BoxMin, whisker_min: WhiskerMin, whisker_max: WhiskerMax,
-		box_max: BoxMax, box_width: BoxWidth, options: &[PlotOption<&str>],
-	) -> &'l mut Self
-	{
-		let (data, num_rows, num_cols) = generate_data!(
-			options,
-			x,
-			box_min,
-			whisker_min,
-			whisker_max,
-			box_max,
-			box_width
-		);
-		self.common.elems.push(PlotElement::new_plot(
-			BoxAndWhisker,
-			data,
-			num_rows,
-			num_cols,
-			options,
-		));
-		self
-	}
-
 	/// Plot 2D rectangular boxes - usually used for error bars - using specified by width (x_delta) and height (y_delta).
 	///
 	/// # Arguments

gnuplot/src/options.rs

@@ -74,6 +74,8 @@ pub enum PlotOption<T>
 	WhiskerBars(f64),
 	/// Which axis pair to use for the plot element.
 	Axes(XAxis, YAxis),
+	/// Box width set per box for box plots: each element is the width of one box
+	BoxWidth(Vec<f64>),
 }
 
 impl<'l> OneWayOwned for PlotOption<&'l str>
@@ -97,6 +99,7 @@ impl<'l> OneWayOwned for PlotOption<&'l str>
 			WhiskerBars(v) => WhiskerBars(v),
 			FillPattern(v) => FillPattern(v),
 			Axes(x, y) => Axes(x, y),
+			BoxWidth(ref d) => BoxWidth(d.clone()),
 		}
 	}
 }