Struct agnes::frame::Framed

pub struct Framed<T, DI> { /* fields omitted */ }

Structure to hold references to a data structure (e.g. DataStore) and a frame used to view that structure. Provides DataIndex for the underlying data structure, as viewed through the frame.

Methods

impl<T, DI> Framed<T, DI>

pub fn new(permutation: Rc<Permutation<Vec<usize>>>, data: DI) -> Framed<T, DI>

Create a new framed view of some data, as viewed through a particular DataFrame.

pub fn new_melt(
    permutation: Rc<Permutation<Vec<usize>>>,
    data: Vec<DI>
) -> Framed<T, DI>

Create a new framed view of some data, rotating over data in a Vec of DataIndex objects.

Trait Implementations

impl<T, DI> Typed for Framed<T, DI>

type DType = T

Associated data type with this type.

impl<T, DI> SelfValued for Framed<T, DI>

impl<T, DI> DataIndex for Framed<T, DI> where
    T: Debug,
    DI: DataIndex<DType = T> + Debug, 

type DType = T

The data type contained within this field.

fn get_datum(&self, idx: usize) -> Result<Value<&T>>

Returns the data (possibly NA) at the specified index, if it exists.

fn len(&self) -> usize

Returns the length of this data field.

fn is_empty(&self) -> bool

Returns whether or not this field is empty.

Important traits for DataIterator<'a, T>

impl<'a, T> Iterator for DataIterator<'a, T> where
    T: 'a,  type Item = Value<&'a T>;

fn iter(&self) -> DataIterator<Self::DType> where
    Self: Sized, 

Returns an iterator over the values in this field.

fn permute(self, permutation: &[usize]) -> Framed<Self::DType, Self> where
    Self: Sized, 

Returns a new DataIndex-implementing object which provides access to the values in this field as permuted by permutation. permutation is a slice of indices into this DataIndex.

fn to_vec(&self) -> Vec<Self::DType> where
    Self: Sized,
    Self::DType: Clone, 

Copies existing values in this field into a new Vec.

fn to_value_vec(&self) -> Vec<Value<Self::DType>> where
    Self: Sized,
    Self::DType: Clone, 

Copies values (missing or existing) in this field into a new Vec.

impl<T, DI> HashIndex for Framed<T, DI> where
    Value<&'a T>: Hash,
    Self: DataIndex<DType = T>, 

fn hash_index<H>(&self, idx: usize, state: &mut H) where
    H: Hasher, 

Compute the hash of the values within this list of data fields with the index idx, updating the hash state.

impl<T, DI> PartialEqIndex for Framed<T, DI> where
    Value<&'a T>: PartialEq,
    Self: DataIndex<DType = T>, 

fn eq_index(&self, other: &Self, idx: usize) -> bool

Returns equality of the values within this list of data fields with the index idx.

impl<T: Eq, DI: Eq> Eq for Framed<T, DI>

impl<T: PartialEq, DI: PartialEq> PartialEq<Framed<T, DI>> for Framed<T, DI>

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

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

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

This method tests for !=.

impl<T, DI> Clone for Framed<T, DI> where
    DI: Clone, 

fn clone(&self) -> Framed<T, DI>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> From<DataRef<T>> for Framed<T, DataRef<T>>

fn from(orig: DataRef<T>) -> Framed<T, DataRef<T>>

Performs the conversion.

impl<T> From<FieldData<T>> for Framed<T, DataRef<T>>

fn from(orig: FieldData<T>) -> Framed<T, DataRef<T>>

Performs the conversion.

impl<T: Debug, DI: Debug> Debug for Framed<T, DI>

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

Formats the value using the given formatter.

impl<T: Hash, DI: Hash> Hash for Framed<T, DI>

fn hash<__HTDI: Hasher>(&self, state: &mut __HTDI)

Feeds this value into the given [Hasher].

default fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T, DI> Serialize for Framed<T, DI> where
    T: Serialize,
    Self: DataIndex<DType = T>, 

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.