Struct preexplorer::Sequence

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

Most basic explorable structure: a sequence of values.

Remarks

With the prelude module, we can easily convert a IntoIterator struct into Sequence for ease of use. The same can be achieved with the new method.

Examples

Quick plot.

use preexplorer::prelude::*;
(0..10).preexplore().plot("my_identifier").unwrap();

Compare Sequence structs.

use preexplorer::prelude::*;
pre::Sequences::new(vec![
    (0..10).preexplore(),
    (0..10).preexplore(),
    ])
    .plot("my_identifier").unwrap();

Implementations

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

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

Constructs a new Sequence<T>.

Examples

From a complicated computation.

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

Trait Implementations

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

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Sequences<T>

The resulting type after applying the + operator.

pub fn add(self, other: Sequence<T>) -> Sequences<T>

Performs the + operation.

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

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

Performs the += operation.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Mutable access to Configuration.

pub fn configuration(&self) -> &Configuration

Reference access to Configuration.

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

Set title, which in comparisons correspond to legends.

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

Set logaritmic scale in the x axis.

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

Set logaritmic scale in the y axis.

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

Set logaritmic scale in the x axis.

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

Set logaritmic scale in the y axis.

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

Set a label in the x axis.

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

Set a label in the y axis.

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

Set a label in the x axis.

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

Set a label in the y axis.

pub 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.

pub 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.

pub 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.

pub 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.

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

Set an extension for the data file.

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

Set an extension for the data file.

pub 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.

pub 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.

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

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

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

Choose the date used when saving files.

pub 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.

pub 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.

pub 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.

pub 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.

pub 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.

pub 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.

pub 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn plot_path(&self) -> &Path

pub fn data_path(&self) -> &Path

pub fn header(&self) -> bool

pub fn style(&self) -> &Style

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

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

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

pub fn checked_id(&self) -> &String

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

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

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

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

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

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

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

pub 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, 

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

Performs the conversion.

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

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

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

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

This method tests for !=.

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

pub fn plot_script(&self) -> String

Construct a suitable plot script for the struct.

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

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

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

Main command. In other words:

pub 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:

pub 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.

pub fn opening_plot_script(&self) -> String

Helper method for implementing Plotable.

pub fn ending_plot_script(&self) -> String

Helper method for implementing Plotable.

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

pub fn plotable_data(&self) -> String

Extract the data from the struct.

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

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

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