Struct plotpy::Curve

pub struct Curve { /* fields omitted */ }

Generates a curve (aka line-plot) given two arrays (x,y)

Notes

• This struct corresponds to the plot function of Matplotlib.
• You may plot a Scatter plot by setting line_style = “None”

Example

// import
use plotpy::{Curve, Plot};
use russell_lab::Vector;
use std::path::Path;

// directory to save figures
const OUT_DIR: &str = "/tmp/plotpy/doc_tests";

// generate (x,y) points
let x = Vector::linspace(-1.0, 1.0, 21);
let y = x.get_mapped(|v| 1.0 / (1.0 + f64::exp(-5.0 * v)));

// configure curve
let mut curve = Curve::new();
curve.set_label("logistic function")
    .set_line_alpha(0.8)
    .set_line_color("#5f9cd8")
    .set_line_style("-")
    .set_line_width(5.0)
    .set_marker_color("#eeea83")
    .set_marker_every(5)
    .set_marker_line_color("#da98d1")
    .set_marker_line_width(2.5)
    .set_marker_size(20.0)
    .set_marker_style("*");

// draw curve
curve.draw(&x, &y);

// add curve to plot
let mut plot = Plot::new();
plot.add(&curve)
    .set_num_ticks_y(11)
    .grid_labels_legend("x", "y");

// save figure
let path = Path::new(OUT_DIR).join("doc_curve.svg");
plot.save(&path)?;

Implementations

impl Curve

pub fn new() -> Self

Creates new Curve object

pub fn draw<'a, T, U>(&mut self, x: &'a T, y: &'a T) where
    T: AsVector<'a, U>,
    U: 'a + Display, 

Draws curve

Input

• x - abscissa values
• y - ordinate values

Notes

• The type U of the input array must be a number.

pub fn set_label(&mut self, label: &str) -> &mut Self

Sets the name of this curve in the legend

pub fn set_line_alpha(&mut self, alpha: f64) -> &mut Self

Sets the opacity of lines (0, 1]. A<1e-14 => A=1.0

pub fn set_line_color(&mut self, color: &str) -> &mut Self

Sets the color of lines

pub fn set_line_style(&mut self, style: &str) -> &mut Self

Sets the style of lines

Options:

• “-”, :“, “--”, “-.”, or “None”
• As defined in https://matplotlib.org/stable/gallery/lines_bars_and_markers/linestyles.html

pub fn set_line_width(&mut self, width: f64) -> &mut Self

Sets the width of lines

pub fn set_marker_color(&mut self, color: &str) -> &mut Self

Sets the color of markers

pub fn set_marker_every(&mut self, every: usize) -> &mut Self

Sets the increment of data points to use when drawing markers

pub fn set_marker_void(&mut self, flag: bool) -> &mut Self

Sets the option to draw a void marker (draw edge only)

pub fn set_marker_line_color(&mut self, color: &str) -> &mut Self

Sets the edge color of markers

pub fn set_marker_line_width(&mut self, width: f64) -> &mut Self

Sets the edge width of markers

pub fn set_marker_size(&mut self, size: f64) -> &mut Self

Sets the size of markers

pub fn set_marker_style(&mut self, style: &str) -> &mut Self

Sets the style of markers

Examples:

• “o”, “+”
• As defined in https://matplotlib.org/stable/api/markers_api.html

Trait Implementations

impl GraphMaker for Curve

fn get_buffer<'a>(&'a self) -> &'a String