Struct agnes::frame::DataFrame

pub struct DataFrame<FrameFields, FramedStore> { /* fields omitted */ }

A data frame. A reference to the underlying data store along with record-based filtering and sorting details. FrameFields is a FieldLookupCons cons-list which maps a single label to one or more underlying store labels.

Methods

impl<FrameFields, FramedStore> DataFrame<FrameFields, FramedStore> where
    FramedStore: NRows, 

pub fn len(&self) -> usize

Returns length (number of rows) in this DataFrame.

pub fn is_empty(&self) -> bool

Returns whether or not this DataFrame is empty.

Trait Implementations

impl<FrameFields, FramedStore> SelfValued for DataFrame<FrameFields, FramedStore>

Allow DataFrames to be pulled from LVCons as Values

impl<FrameFields, FramedStore> IntoView for DataFrame<FrameFields, FramedStore> where
    FrameFields: AssocFrameLookup, 

type Labels = <FrameFields as AssocFrameLookup>::Output

The Labels type parameter for the output DataView.

type Frames = LVCons<UTerm, Self, Nil>

The Frames type parameter for the output DataView.

type Output = DataView<Self::Labels, Self::Frames>

The output DataView (should always be DataView<Self::Labels, Self::Frames>).

fn into_view(self) -> Self::Output

Convert self into a DataView object.

impl<FrameFields, FramedStore> NRows for DataFrame<FrameFields, FramedStore> where
    FramedStore: NRows, 

fn nrows(&self) -> usize

Return the number of rows in this data structure.

impl<FrameIndex, FrameFields, FramedStore> AsFrameLookup<FrameIndex> for DataFrame<FrameFields, FramedStore> where
    FrameFields: AsFrameLookup<FrameIndex>, 

type Output = <FrameFields as AsFrameLookup<FrameIndex>>::Output

The computed FrameLookupCons.

impl<FrameFields, FramedStore> UpdatePermutation for DataFrame<FrameFields, FramedStore>

fn update_permutation(self, new_permutation: &[usize]) -> Self

Consumes this object returns a new object with a permutation updated according to the provided indices.

impl<FrameFields, FramedStore> FieldSelect for DataFrame<FrameFields, FramedStore>

fn field<Label>(&self) -> Self::Output where
    Self: SelectFieldByLabel<Label>, 

Returns a struct containing the data for the field specified by Label.

impl<FrameFields, FramedStore, Label> SelectFieldByLabel<Label> for DataFrame<FrameFields, FramedStore> where
    FrameFields: SelectAndFrame<Label, FramedStore>, 

type DType = <FrameFields as SelectAndFrame<Label, FramedStore>>::DType

Data type of accessed data.

type Output = Framed<Self::DType, <FrameFields as SelectAndFrame<Label, FramedStore>>::Field>

The return type for the select_field method.

fn select_field(&self) -> Self::Output

Returns an object that provides DataIndex access to the data in the field specified by Label.

impl<FrameFields, FramedStore> Clone for DataFrame<FrameFields, FramedStore>

fn clone(&self) -> DataFrame<FrameFields, FramedStore>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<StoreFields> From<DataStore<StoreFields>> for DataFrame<<StoreFields as SimpleFrameFields>::Fields, DataStore<StoreFields>> where
    StoreFields: AssocStorage + SimpleFrameFields, 

fn from(
    store: DataStore<StoreFields>
) -> DataFrame<<StoreFields as SimpleFrameFields>::Fields, DataStore<StoreFields>>

Performs the conversion.

impl<Labels, Frames> From<DataView<Labels, Frames>> for DataFrame<<Labels as SimpleFrameFields>::Fields, DataView<Labels, Frames>> where
    Labels: SimpleFrameFields, 

fn from(
    view: DataView<Labels, Frames>
) -> DataFrame<<Labels as SimpleFrameFields>::Fields, DataView<Labels, Frames>>

Performs the conversion.

impl<FrameFields: Debug, FramedStore: Debug> Debug for DataFrame<FrameFields, FramedStore>

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

Formats the value using the given formatter.