Struct DatasetBuilder 

pub struct DatasetBuilder<S: Schema> { /* private fields */ }

Builder for a dataset in flat.

// Note, explicit type annotation included for clarity.
// We encourage consumers to allow the compiler to infer the type implicitly.
let builder: DatasetBuilder<Schema1<f64>> = DatasetBuilder::new(Schemas::one("dim1"));

Implementations

impl<S: Schema> DatasetBuilder<S>

pub fn new(schema: S) -> DatasetBuilder<S>

Build a dataset based for the provided schema.

pub fn update(&mut self, vector: S::Dimensions)

Update this dataset with a data point vector. Use this method to add data via mutation.

See also: DatasetBuilder::add.

Example

use flat::*;

let schema = Schemas::one("Things");
let mut builder = DatasetBuilder::new(schema);
builder.update((0, ));
builder.update((0, ));
builder.update((1, ));
let dataset = builder.build();
let view = dataset.count();

let flat = DagChart::new(&view)
    .render(Render::default());
assert_eq!(
    format!("\n{}", flat.to_string()),
    r#"
Things  |Sum(Count)
0       |**
1       |*"#);

let flat = Histogram::new(&view, 2)
    .render(Render::default());
assert_eq!(
    format!("\n{}", flat.to_string()),
    r#"
Things  |Sum(Count)
[0, 1)  |**
[1, 2]  |*"#);

pub fn add(self, vector: S::Dimensions) -> Self

Add a data point vector to this dataset. Use this method to add via method chaining.

See also: DatasetBuilder::update.

Example

use flat::*;

let schema = Schemas::one("Things");
let dataset = DatasetBuilder::new(schema)
    .add((0, ))
    .add((0, ))
    .add((1, ))
    .build();
let view = dataset.count();

let flat = DagChart::new(&view)
    .render(Render::default());
assert_eq!(
    format!("\n{}", flat.to_string()),
    r#"
Things  |Sum(Count)
0       |**
1       |*"#);

let flat = Histogram::new(&view, 2)
    .render(Render::default());
assert_eq!(
    format!("\n{}", flat.to_string()),
    r#"
Things  |Sum(Count)
[0, 1)  |**
[1, 2]  |*"#);

pub fn build(self) -> Dataset<S>

Finalize the builder into a Dataset.