Struct tsxlib::index::HashableIndex

pub struct HashableIndex<TIndex: Serialize + Hash + Clone + Eq + Ord> {
    pub values: Vec<TIndex>,
}

a HashableIndex serves as the index for a timeseries, it requires that the index element be Serializatable (via serde), Hashable, Cloneable, Equatable, and Orderable.

Fields

values: Vec<TIndex>

Implementations

impl HashableIndex<NaiveDateTime>

pub fn from_int_stamps(stamps: Vec<i64>) -> HashableIndex<NaiveDateTime>

impl<TIndex: Serialize + Hash + Clone + Eq + Ord> HashableIndex<TIndex>

pub fn new(values: Vec<TIndex>) -> HashableIndex<TIndex>

Create new index from a vec of values of type TIndex

Example

use tsxlib::index::HashableIndex;

let values = vec![1, 2, 3, 4];
let index = HashableIndex::new(values);
assert_eq!(index.len(), 4);

pub fn is_monotonic(&self) -> bool

test the monotonicity test for an index

Example

use tsxlib::index::HashableIndex;

let vs = HashableIndex::new(vec![1, 2, 3, 4]);
let xs = HashableIndex::new(vec![1, 2, 3, 3]);
let ys = HashableIndex::new(vec![1, 2, 3, 2]);
assert_eq!(vs.is_monotonic(), true);
assert_eq!(xs.is_monotonic(), false);
assert_eq!(ys.is_monotonic(), false);

pub fn len(&self) -> usize

get length of the index

pub fn is_empty(&self) -> bool

is the index empty

pub fn last(&self) -> Option<&TIndex>

ref to the last value of an index

pub fn is_unique(&self) -> bool

very slow, tests if index is unique by generating a hashset of the index keys and then comparing lengths

pub fn iter(&self) -> Iter<'_, TIndex>

generate and iterator for the index

Trait Implementations

impl<TIndex: Clone + Serialize + Hash + Eq + Ord> Clone for HashableIndex<TIndex>

pub fn clone(&self) -> HashableIndex<TIndex>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TIndex: Debug + Serialize + Hash + Clone + Eq + Ord> Debug for HashableIndex<TIndex>

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

Formats the value using the given formatter.

impl<TIndex: Serialize + Hash + Clone + Eq + Ord> Index<usize> for HashableIndex<TIndex>

type Output = TIndex

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<TIndex: Serialize + Hash + Clone + Eq + Ord> PartialEq<HashableIndex<TIndex>> for HashableIndex<TIndex>

pub fn eq(&self, other: &Self) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl SampleableIndex<NaiveDateTime, Duration> for HashableIndex<NaiveDateTime>

Implementation of SampleableIndex for HashableIndex

pub fn sample_rates(&self) -> Vec<(usize, Duration)>

Infer index sample rate, returns a vector that represtest (number of times a sample rate is observed, the sample rate)

Example

use tsxlib::index::HashableIndex;
use tsxlib::index::SampleableIndex;
use tsxlib::timeutils;
use chrono::{NaiveDateTime,Duration};
 
let index = HashableIndex::new(vec![ timeutils::naive_datetime_from_millis(0), timeutils::naive_datetime_from_millis(5),timeutils::naive_datetime_from_millis(10), timeutils::naive_datetime_from_millis(15), timeutils::naive_datetime_from_millis(20), timeutils::naive_datetime_from_millis(25), timeutils::naive_datetime_from_millis(75)]);
let exp =  vec![(5,Duration::milliseconds(5)),(1,Duration::milliseconds(50))];
assert_eq!(index.sample_rates(), exp);

pub fn is_mono_intervaled(&self) -> bool

returns true if the index is spaced at equal itervals

Example

use tsxlib::index::HashableIndex;
use tsxlib::index::SampleableIndex;
use tsxlib::timeutils;
use chrono::{NaiveDateTime,Duration};
 
let index = HashableIndex::new(vec![ timeutils::naive_datetime_from_millis(0), timeutils::naive_datetime_from_millis(5),timeutils::naive_datetime_from_millis(10), timeutils::naive_datetime_from_millis(15), timeutils::naive_datetime_from_millis(20), timeutils::naive_datetime_from_millis(25), timeutils::naive_datetime_from_millis(75)]);
let index_mono = HashableIndex::new(vec![ timeutils::naive_datetime_from_millis(0), timeutils::naive_datetime_from_millis(5),timeutils::naive_datetime_from_millis(10), timeutils::naive_datetime_from_millis(15), timeutils::naive_datetime_from_millis(20), timeutils::naive_datetime_from_millis(25)]);
assert_eq!(index.is_mono_intervaled(), false);
assert_eq!(index_mono.is_mono_intervaled(), true);