Struct preexplorer::sequence::Sequence

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

Sequence of values.

Methods

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

pub fn new<I>(data: I) -> Sequence<T> where
    I: IntoIterator<Item = T>, 

Create a new Sequence.

Examples

From a complicated computation.

use preexplorer::prelude::*;
let data = (0..10).map(|i| i * i + 1);
let seq = pre::Sequence::new(data);

pub fn to_comparison(&self) -> Sequences<T>

Convert to Sequences quickly.

pub fn compare_with<J>(self, others: J) -> Sequences<T> where
    J: IntoIterator<Item = Sequence<T>>, 

Compare your Sequence with various Sequences.

Remarks

Titles of Sequences involved in a Sequences are presented as legends.

Examples

Compare many Sequences by gathering all first (in some IntoIterator).

use preexplorer::prelude::*;
let first_seq = (0..10).preexplore().title("legend").to_owned();
let many_seqs = (0..5).map(|_| (0..10).preexplore());
let mut sequences = first_seq.compare_with(many_seqs);
sequences.title("Main title");

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Comparison<Sequence<T>> for Sequences<T> where
    T: Display + Clone, 

fn add(&mut self, other: Sequence<T>) -> &mut Self

Add a basic struct to the comparison.

fn add_many<J: IntoIterator<Item = T>>(&mut self, others: J) -> &mut Self

Add many basic structs to the comparison.

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

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

Mutable access to Configuration.

fn configuration_as_ref(&self) -> &Configuration

Reference access to Configuration.

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

Set title, which in comparisons correspond to legends.

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

Set logaritmic scale in the x axis.

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

Set logaritmic scale in the y axis.

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

Set logaritmic scale in the x axis.

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

Set logaritmic scale in the y axis.

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

Set a label in the x axis.

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

Set a label in the y axis.

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

Set a label in the x axis.

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

Set a label in the y axis.

fn 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 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 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 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 data_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> &mut Self

Set an extension for the data file.

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

Set an extension for the data file.

fn 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 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 dashtype(&mut self, dashtype: usize) -> &mut Self

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

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

Choose the date used when saving files.

fn 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 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 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 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 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 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 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 get_title(&self) -> Option<&String>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn get_plot_path(&self) -> &Path

fn get_data_path(&self) -> &Path

fn get_header(&self) -> bool

fn get_style(&self) -> &Style

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

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

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

fn get_checked_id(&self) -> &String

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

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

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

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

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

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

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

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

Formats the value using the given formatter.

impl<T> From<Sequence<T>> for Sequences<T> where
    T: Display + Clone, 

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

Performs the conversion.

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

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

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

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

This method tests for !=.

impl<T> Plotable for Sequence<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, SavingError>

Do everything except running the command of plotting. In other words: 1. Assign id. 2. Save the data. 3. Save the plot script.

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

Main command. In other words: 1. Assign id. 2. Save the data. 3. Save the plot script. 4. Run (asynchronous) the plot script.

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

Plot with a custom script. In other words: 1. Assign id. 2. Save the data. 3. Save the custom plot script. 4. Run (asynchronous) the plot script.

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

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 Sequence<T> where
    T: Display + Clone, 

fn plotable_data(&self) -> String

Extract the data from the struct.

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

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

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

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

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