Struct preexplorer::SequenceBin

pub struct SequenceBin<T> where
    T: Display + Clone,  { /* fields omitted */ }

Sequence of histograms normalize to represent a probability density function through bins.

To renormalize the histograms (that cover a unit area by default), change the renormalization constant in the gnuplot script.
By trying out with gnuplot, you can find the perfect fit.

Examples

Quick plot.

use preexplorer::prelude::*;
let data = (0..10).map(|i| (i..10 + i));
let binwidth = 0.5;
pre::SequenceBin::new(data, binwidth).plot("my_identifier").unwrap();

Compare SequenceBin structs.

use preexplorer::prelude::*;
pre::SequenceBins::new(vec![
    pre::SequenceBin::new((0..10).map(|i| (i..10 + i)), 1),
    pre::SequenceBin::new((0..10).map(|i| (i..10 + i)), 0.5),
    ])
    .plot("my_identifier").unwrap();

Implementations

impl<T> SequenceBin<T> where
    T: Display + Clone, 

pub fn new<I, J, S>(data: I, binwidth: S) -> SequenceBin<T> where
    I: IntoIterator<Item = J>,
    J: IntoIterator<Item = T>,
    S: Into<f64>, 

Constructs a new SequenceBin<T>.

Remarks

To change the binwidth, please refer to the gnuplot script generated. By construction, a fixed binwidth is needed. This is okay in most of the cases, since it gives consistency and allows plotting constant values. If you want to change it, please go to the gnuplot script.

Negative binwidths are handled by gnuplot. This crate simply prints the binwidth in the correct place in the gnuplot script generated, so if you use a value less or equal to zero gnuplot will resolve this issue by using a default behaviour.

Examples

From a complicated computation.

use preexplorer::prelude::*;
let data = (0..10).map(|i| (i..10 + i));
let binwidth = 0.5;
let seq_bin = pre::SequenceBin::new(data, binwidth);

Trait Implementations

impl<T> Add<SequenceBin<T>> for SequenceBins<T> where
    T: Display + Clone, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: SequenceBin<T>) -> Self

Performs the + operation.

impl<T> Add<SequenceBin<T>> for SequenceBin<T> where
    T: Display + Clone, 

type Output = SequenceBins<T>

The resulting type after applying the + operator.

fn add(self, other: SequenceBin<T>) -> SequenceBins<T>

Performs the + operation.

impl<T> AddAssign<SequenceBin<T>> for SequenceBins<T> where
    T: Display + Clone, 

fn add_assign(&mut self, other: SequenceBin<T>)

Performs the += operation.

impl<T: Clone> Clone for SequenceBin<T> where
    T: Display + Clone, 

fn clone(&self) -> SequenceBin<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Configurable for SequenceBin<T> where
    T: Display + Clone, 

fn configuration_mut(&mut self) -> &mut Configuration

Mutable access to Configuration.

fn configuration(&self) -> &Configuration

Reference access to Configuration.

fn set_title<S: Display>(&mut self, title: S) -> &mut Self

Set title, which in comparisons correspond to legends.

fn set_logx<N: Into<f64>>(&mut self, logx: N) -> &mut Self

Set logaritmic scale in the x axis.

fn set_logy<N: Into<f64>>(&mut self, logy: N) -> &mut Self

Set logaritmic scale in the y axis.

fn set_xlog<N: Into<f64>>(&mut self, logx: N) -> &mut Self

Set logaritmic scale in the x axis.

fn set_ylog<N: Into<f64>>(&mut self, logy: N) -> &mut Self

Set logaritmic scale in the y axis.

fn set_labelx<S: Display>(&mut self, labelx: S) -> &mut Self

Set a label in the x axis.

fn set_labely<S: Display>(&mut self, labely: S) -> &mut Self

Set a label in the y axis.

fn set_xlabel<S: Display>(&mut self, labelx: S) -> &mut Self

Set a label in the x axis.

fn set_ylabel<S: Display>(&mut self, labely: S) -> &mut Self

Set a label in the y axis.

fn set_rangex<S, T>(&mut self, left: S, right: T) -> &mut Self where
    f64: From<S>,
    f64: From<T>, 

Set the range in the x axis. If left > right, then the x axis is inverted.

fn set_rangey<S, T>(&mut self, down: S, up: T) -> &mut Self where
    f64: From<S>,
    f64: From<T>, 

Set the range in the y axis. If down > up, then the y axis is inverted.

fn set_xrange<S, T>(&mut self, left: S, right: T) -> &mut Self where
    f64: From<S>,
    f64: From<T>, 

Set the range in the x axis. If left > right, then the x axis is inverted.

fn set_yrange<S, T>(&mut self, down: S, up: T) -> &mut Self where
    f64: From<S>,
    f64: From<T>, 

Set the range in the y axis. If down > up, then the y axis is inverted.

fn set_data_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> &mut Self

Set an extension for the data file.

fn set_plot_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> &mut Self

Set an extension for the data file.

fn set_header(&mut self, header: bool) -> &mut Self

Decide the presence of headers in the data file. If activated, then title, date and other information are included as a comment in the data file.

fn set_style<S>(&mut self, style: S) -> &mut Self where
    Style: From<S>, 

Choose the style for the plot. Too see all options, go to Style struct. If you set a style and then compare with other structs, then in the joint plot, the style shall be mantained for those structs that had a style not setted by default.

fn set_dashtype(&mut self, dashtype: usize) -> &mut Self

Choose the dashtype for the plot. Following the gnuplot standar, it has a cyclic behaviour.

fn set_date(&mut self, date: DateTime<Local>) -> &mut Self

Choose the date used when saving files.

fn set_id<S: Display>(&mut self, id: S) -> &mut Self

Set the unique id or file name with which both data and plot script will be saved. There is no default value and one must set it before plotting or saving.

fn set_custom<S: Display, T: Display>(&mut self, key: S, value: T) -> &mut Self

Include custom configuration fields into the Configuration struct. This is intended for all new configurations you want, specially if you are implementing the traits.

fn set_ticsx<T, S>(&mut self, ticsx: T) -> &mut Self where
    T: Into<Option<S>>,
    S: Display, 

Control tics in the x axis. Passing "" shows no tics. See gnuplot documentation for a correct format.

fn set_ticsy<T, S>(&mut self, ticsy: T) -> &mut Self where
    T: Into<Option<S>>,
    S: Display, 

Control tics in the y axis. Passing "" shows no tics. See gnuplot documentation for a correct format.

fn set_xtics<T, S>(&mut self, ticsx: T) -> &mut Self where
    T: Into<Option<S>>,
    S: Display, 

Control tics in the x axis. See gnuplot documentation for a correct format.

fn set_ytics<T, S>(&mut self, ticsy: T) -> &mut Self where
    T: Into<Option<S>>,
    S: Display, 

Control tics in the y axis. See gnuplot documentation for a correct format.

fn set_pause<T, S>(&mut self, pause: T) -> &mut Self where
    T: Into<Option<S>>,
    f64: From<S>, 

Control the time for which the plot is in the screen. The unit is seconds. Any negative number means “until a key is pressed”. To have no pause, pass 0, instead of None.

fn title(&self) -> Option<&String>

fn logx(&self) -> Option<f64>

fn logy(&self) -> Option<f64>

fn xlog(&self) -> Option<f64>

fn ylog(&self) -> Option<f64>

fn labelx(&self) -> Option<&String>

fn labely(&self) -> Option<&String>

fn xlabel(&self) -> Option<&String>

fn ylabel(&self) -> Option<&String>

fn rangex(&self) -> Option<(f64, f64)>

fn rangey(&self) -> Option<(f64, f64)>

fn xrange(&self) -> Option<(f64, f64)>

fn yrange(&self) -> Option<(f64, f64)>

fn plot_extension(&self) -> Option<&OsStr>

fn data_extension(&self) -> Option<&OsStr>

fn plot_path(&self) -> &Path

fn data_path(&self) -> &Path

fn header(&self) -> bool

fn style(&self) -> &Style

fn dashtype(&self) -> Option<usize>

fn date(&self) -> &DateTime<Local>

fn id(&self) -> Option<&String>

fn checked_id(&self) -> &String

fn custom<S: Display>(&self, key: S) -> Option<&String>

fn ticsx(&self) -> Option<&String>

fn xtics(&self) -> Option<&String>

fn ticsy(&self) -> Option<&String>

fn ytics(&self) -> Option<&String>

fn pause(&self) -> Option<f64>

impl<T: Debug> Debug for SequenceBin<T> where
    T: Display + Clone, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> From<SequenceBin<T>> for SequenceBins<T> where
    T: Display + Clone, 

fn from(sequence: SequenceBin<T>) -> Self

Performs the conversion.

impl<T: PartialEq> PartialEq<SequenceBin<T>> for SequenceBin<T> where
    T: Display + Clone, 

fn eq(&self, other: &SequenceBin<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SequenceBin<T>) -> bool

This method tests for !=.

impl<T> Plotable for SequenceBin<T> where
    T: Display + Clone, 

fn plot_script(&self) -> String

Construct a suitable plot script for the struct.

fn plot_later<S: Display>(
    &mut self,
    id: S
) -> Result<&mut Self, PreexplorerError>

Do everything except running the command of plotting. In other words:

fn plot<S: Display>(&mut self, id: S) -> Result<&mut Self, PreexplorerError>

Main command. In other words:

fn plot_with_script<S: Display, T: Display>(
    &mut self,
    id: S,
    script: T
) -> Result<&mut Self, PreexplorerError>

Plot with a custom script. In other words:

fn write_plot_script<S: Display>(
    &self,
    gnuplot_script: S
) -> Result<&Self, PreexplorerError>

Write plot script given by plot_script in the machine for posterior running.

fn opening_plot_script(&self) -> String

Helper method for implementing Plotable.

fn ending_plot_script(&self) -> String

Helper method for implementing Plotable.

impl<T> Saveable for SequenceBin<T> where
    T: Display + Clone, 

fn plotable_data(&self) -> String

Extract the data from the struct.

fn save(&self) -> Result<&Self, PreexplorerError>

Save the data in a file. The directory is target\\preexplorer\\data\\.

fn save_with_id<S: Display>(&self, id: S) -> Result<&Self, PreexplorerError>

Save the file with a given id. It does not change the current id to save the data.

impl<T> StructuralPartialEq for SequenceBin<T> where
    T: Display + Clone,