h3arrow 0.4.0

Integration of the H3 geospatial grid with the arrow memory model
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

use std::mem::transmute;

use arrow::array::{Float64Array, UInt64Array, UInt8Array};
use h3o::Resolution;

use crate::error::Error;

use super::{FromIteratorWithValidity, FromWithValidity};

pub struct ResolutionArray(UInt8Array);

impl TryFrom<UInt8Array> for ResolutionArray {
    type Error = Error;

    fn try_from(value: UInt8Array) -> Result<Self, Self::Error> {
        // validate the contained h3 cells
        value
            .iter()
            .flatten()
            .try_for_each(|h3index| Resolution::try_from(h3index).map(|_| ()))?;
        Ok(Self(value))
    }
}

impl ResolutionArray {
    /// Returns an iterator over the values and validity, Option.
    pub fn iter(&self) -> impl Iterator<Item = Option<Resolution>> + '_ {
        // as the array contents have been validated upon construction, we just transmute to the h3o type
        self.0
            .iter()
            .map(|v| v.map(|resolution_u8| unsafe { transmute::<u8, Resolution>(resolution_u8) }))
    }

    pub fn len(&self) -> usize {
        self.0.len()
    }

    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }

    pub fn slice(&self, offset: usize, length: usize) -> Self {
        Self(self.0.slice(offset, length))
    }

    pub fn area_rads2(&self) -> Float64Array {
        Float64Array::from_iter(self.iter().map(|v| v.map(|r| r.area_rads2())))
    }

    pub fn area_km2(&self) -> Float64Array {
        Float64Array::from_iter(self.iter().map(|v| v.map(|r| r.area_km2())))
    }

    pub fn area_m2(&self) -> Float64Array {
        Float64Array::from_iter(self.iter().map(|v| v.map(|r| r.area_m2())))
    }

    pub fn edge_length_rads(&self) -> Float64Array {
        Float64Array::from_iter(self.iter().map(|v| v.map(|r| r.edge_length_rads())))
    }

    pub fn edge_length_km(&self) -> Float64Array {
        Float64Array::from_iter(self.iter().map(|v| v.map(|r| r.edge_length_km())))
    }

    pub fn edge_length_m(&self) -> Float64Array {
        Float64Array::from_iter(self.iter().map(|v| v.map(|r| r.edge_length_m())))
    }

    pub fn cell_count(&self) -> UInt64Array {
        UInt64Array::from_iter(self.iter().map(|v| v.map(|r| r.cell_count())))
    }

    /// Return the next resolution, if any.
    pub fn succ(&self) -> Self {
        Self::from_iter(self.iter().map(|v| v.and_then(|r| r.succ())))
    }

    /// Return the previous resolution, if any.
    pub fn pred(&self) -> Self {
        Self::from_iter(self.iter().map(|v| v.and_then(|r| r.pred())))
    }

    pub fn into_inner(self) -> UInt8Array {
        self.0
    }
}

impl FromIterator<Resolution> for ResolutionArray {
    fn from_iter<T: IntoIterator<Item = Resolution>>(iter: T) -> Self {
        Self(UInt8Array::from_iter(
            iter.into_iter().map(|v| Some(u8::from(v))),
        ))
    }
}

impl FromIterator<Option<Resolution>> for ResolutionArray {
    fn from_iter<T: IntoIterator<Item = Option<Resolution>>>(iter: T) -> Self {
        Self(UInt8Array::from_iter(
            iter.into_iter().map(|v| v.map(u8::from)),
        ))
    }
}

impl From<Vec<Resolution>> for ResolutionArray {
    fn from(value: Vec<Resolution>) -> Self {
        Self::from_iter(value)
    }
}

impl From<Vec<Option<Resolution>>> for ResolutionArray {
    fn from(value: Vec<Option<Resolution>>) -> Self {
        Self::from_iter(value)
    }
}

impl From<ResolutionArray> for UInt8Array {
    fn from(value: ResolutionArray) -> Self {
        value.0
    }
}

impl FromIteratorWithValidity<u8> for ResolutionArray {
    fn from_iter_with_validity<T: IntoIterator<Item = u8>>(iter: T) -> Self {
        Self(UInt8Array::from_iter(
            iter.into_iter()
                .map(|v| Resolution::try_from(v).ok().map(u8::from)),
        ))
    }
}

impl FromIteratorWithValidity<Option<u8>> for ResolutionArray {
    fn from_iter_with_validity<T: IntoIterator<Item = Option<u8>>>(iter: T) -> Self {
        Self(UInt8Array::from_iter(iter.into_iter().map(|v| {
            v.and_then(|v| Resolution::try_from(v).ok().map(u8::from))
        })))
    }
}

impl FromWithValidity<Vec<u8>> for ResolutionArray {
    fn from_with_validity(value: Vec<u8>) -> Self {
        Self::from_iter_with_validity(value)
    }
}

impl FromWithValidity<Vec<Option<u8>>> for ResolutionArray {
    fn from_with_validity(value: Vec<Option<u8>>) -> Self {
        Self::from_iter_with_validity(value)
    }
}