nullvec 0.1.0

Rust nullable vector, which can contain null(missing) values as element
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108


/// Basic trait which must be implemented to primitive types
/// being stored to Nullable and NullVec
pub trait NullStorable: Default {
    /// Whether the primitive value can be null.
    ///
    /// If this is `false`, `is_null` never return true.
    fn has_primitive_null() -> bool {
        false
    }

    /// Whether the value should be regarded as null.
    /// Must be inverse of `is_not_null`.
    fn is_null(&self) -> bool {
        false
    }

    /// Whether the value should be regarded as null.
    /// Must be inverse of `is_null`.
    fn is_not_null(&self) -> bool {
        true
    }
}

/// /////////////////////////////////////////////////////////////////////////////
/// Indexing
/// /////////////////////////////////////////////////////////////////////////////

/// Indexing methods for non-labeled Array / Indexer
pub trait Slicer: Sized {
    type Scalar;

    /// Return the length of myself
    fn len(&self) -> usize;

    /// Return a single element specified with the location
    ///
    /// # Panics
    ///
    /// - if specified locations outs of bounds
    fn iloc(&self, location: &usize) -> Self::Scalar;

    /// Return a single element specified with the location
    unsafe fn iloc_unchecked(&self, location: &usize) -> Self::Scalar;

    /// Return multiple elements specified with the locations
    ///
    /// # Panics
    ///
    /// - if specified locations outs of bounds
    fn ilocs(&self, locations: &[usize]) -> Self;

    /// Return multiple elements specified with the locations
    unsafe fn ilocs_unchecked(&self, locations: &[usize]) -> Self;

    /// Return multiple elements specified with the locations
    ///
    /// If specified locations outs of bounds, corresponding element is filled with null
    fn ilocs_forced(&self, locations: &[usize]) -> Self;

    /// Return multilpe elements specified with bool flags
    fn blocs(&self, flags: &[bool]) -> Self;

    /// Return multiple elements specified with the locations
    fn reindex(&self, locations: &[usize]) -> Self {
        self.ilocs(locations)
    }

    unsafe fn reindex_unchecked(&self, locations: &[usize]) -> Self {
        self.ilocs_unchecked(locations)
    }

    fn reindex_forced(&self, locations: &[usize]) -> Self {
        self.ilocs_forced(locations)
    }
}

/// /////////////////////////////////////////////////////////////////////////////
/// Aggregation
/// /////////////////////////////////////////////////////////////////////////////

pub trait BasicAggregation {
    // result which can keep current dtype
    type Kept;
    // result for count (to usize or its container)
    type Counted;

    fn sum(&self) -> Self::Kept;
    fn count(&self) -> Self::Counted;
}

pub trait NumericAggregation {
    // result which is coerced (to f64 or its container)
    type Coerced;

    fn mean(&self) -> Self::Coerced;
    fn var(&self) -> Self::Coerced;
    fn unbiased_var(&self) -> Self::Coerced;
    fn std(&self) -> Self::Coerced;
    fn unbiased_std(&self) -> Self::Coerced;
}

pub trait ComparisonAggregation {
    type Kept;

    fn min(&self) -> Self::Kept;
    fn max(&self) -> Self::Kept;
}