Struct Dataset

pub struct Dataset {
    pub events: Vec<Arc<Event>>,
}

A collection of Events.

Fields

events: Vec<Arc<Event>>

The Events contained in the Dataset

Implementations

impl Dataset

pub fn index_local(&self, index: usize) -> &Event

Get a reference to the Event at the given index in the Dataset (non-MPI version).

Notes

This method is not intended to be called in analyses but rather in writing methods that have mpi-feature-gated versions. Most users should just index into a Dataset as if it were any other Vec:

let ds: Dataset = Dataset::new(events);
let event_0 = ds[0];

impl Dataset

pub fn new_local(events: Vec<Arc<Event>>) -> Self

Create a new Dataset from a list of Events (non-MPI version).

Notes

This method is not intended to be called in analyses but rather in writing methods that have mpi-feature-gated versions. Most users should just call Dataset::new instead.

pub fn new(events: Vec<Arc<Event>>) -> Self

Create a new Dataset from a list of Events.

This method is prefered for external use because it contains proper MPI construction methods. Constructing a Dataset manually is possible, but may cause issues when interfacing with MPI and should be avoided unless you know what you are doing.

pub fn n_events_local(&self) -> usize

The number of Events in the Dataset (non-MPI version).

Notes

This method is not intended to be called in analyses but rather in writing methods that have mpi-feature-gated versions. Most users should just call Dataset::n_events instead.

pub fn n_events(&self) -> usize

The number of Events in the Dataset.

impl Dataset

pub fn weights_local(&self) -> Vec<Float>

Extract a list of weights over each Event in the Dataset (non-MPI version).

Notes

This method is not intended to be called in analyses but rather in writing methods that have mpi-feature-gated versions. Most users should just call Dataset::weights instead.

pub fn weights(&self) -> Vec<Float>

Extract a list of weights over each Event in the Dataset.

pub fn n_events_weighted_local(&self) -> Float

Returns the sum of the weights for each Event in the Dataset (non-MPI version).

Notes

This method is not intended to be called in analyses but rather in writing methods that have mpi-feature-gated versions. Most users should just call Dataset::n_events_weighted instead.

pub fn n_events_weighted(&self) -> Float

Returns the sum of the weights for each Event in the Dataset.

pub fn bootstrap_local(&self, seed: usize) -> Arc<Dataset>

Generate a new dataset with the same length by resampling the events in the original datset with replacement. This can be used to perform error analysis via the bootstrap method. (non-MPI version).

Notes

This method is not intended to be called in analyses but rather in writing methods that have mpi-feature-gated versions. Most users should just call Dataset::bootstrap instead.

pub fn bootstrap(&self, seed: usize) -> Arc<Dataset>

Generate a new dataset with the same length by resampling the events in the original datset with replacement. This can be used to perform error analysis via the bootstrap method.

pub fn filter(&self, expression: &VariableExpression) -> Arc<Dataset>

Filter the Dataset by a given VariableExpression, selecting events for which the expression returns true.

pub fn bin_by<V>( &self, variable: V, bins: usize, range: (Float, Float), ) -> BinnedDataset

where V: Variable,

Bin a Dataset by the value of the given Variable into a number of bins within the given range.

pub fn boost_to_rest_frame_of<T: AsRef<[usize]> + Sync>( &self, indices: T, ) -> Arc<Dataset>

Boost all the four-momenta in all Events to the rest frame of the given set of four-momenta by indices.

pub fn evaluate<V: Variable>(&self, variable: &V) -> Vec<Float>

Evaluate a Variable on every event in the Dataset.

Trait Implementations

impl Add<&Dataset> for &Dataset

type Output = Dataset

The resulting type after applying the + operator.

fn add(self, rhs: &Dataset) -> Self::Output

Performs the + operation.

impl Add<&Dataset> for Dataset

type Output = Dataset

The resulting type after applying the + operator.

fn add(self, rhs: &Dataset) -> Self::Output

Performs the + operation.

impl Add<Dataset> for &Dataset

type Output = Dataset

The resulting type after applying the + operator.

fn add(self, rhs: Dataset) -> Self::Output

Performs the + operation.

impl Add for Dataset

type Output = Dataset

The resulting type after applying the + operator.

fn add(self, rhs: Dataset) -> Self::Output

Performs the + operation.

impl Clone for Dataset

fn clone(&self) -> Dataset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dataset

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

Formats the value using the given formatter.

impl Default for Dataset

fn default() -> Dataset

Returns the “default value” for a type.

impl Index<usize> for Dataset

type Output = Event

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.