moc 0.19.2

Library made to create and manipulate HEALPix Multi-Order Coverages maps (MOCs), see https://ivoa.net/documents/MOC/
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

use std::cmp::Ordering;
use std::marker::PhantomData;
use std::ops::Range;

use crate::idx::Idx;
use crate::qty::MocQty;

/// A range of MOC cells, the range being expressed at the CellRange depth (and not at
/// the deepest possible depth like in a MocRange).
/// This is usefull for Qty having a DIM > 1, because at DIM = 1 a cell is only divided in 2
/// (so we get a super cell instead of a range).
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CellRange<T: Idx> {
  pub depth: u8,
  pub range: Range<T>,
}
impl<T: Idx> CellRange<T> {
  pub fn new(depth: u8, start: T, end: T) -> Self {
    CellRange::from_depth_range(depth, start..end)
  }
  pub fn from_depth_range(depth: u8, range: Range<T>) -> Self {
    CellRange { depth, range }
  }
  /// Comparison independent from the hierarchy, i.e. like a deepest level comparison.
  pub fn flat_cmp<Q: MocQty<T>>(&self, other: &Self) -> Ordering {
    match self.depth.cmp(&other.depth) {
      Ordering::Equal => self.range.start.cmp(&other.range.start),
      Ordering::Less => self
        .range
        .start
        .unsigned_shl(Q::shift(other.depth - self.depth) as u32)
        .cmp(&other.range.start),
      Ordering::Greater => self.range.start.cmp(
        &other
          .range
          .start
          .unsigned_shl(Q::shift(self.depth - other.depth) as u32),
      ),
    }
  }
}

/// The order we define corresponds to the order of the lower bound of the range at the deepest depth.
#[repr(transparent)] // To be able to transmute Vec<CellRange<T>> into Vec<MocCellRange<T, _>>
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MocCellRange<T: Idx, Q: MocQty<T>>(pub CellRange<T>, PhantomData<Q>);

impl<T: Idx, Q: MocQty<T>> Ord for MocCellRange<T, Q> {
  /// Comparison independent from the hierarchy, i.e. like a deepest level comparison.
  fn cmp(&self, other: &Self) -> Ordering {
    match self.0.depth.cmp(&other.0.depth) {
      Ordering::Equal => self.0.range.start.cmp(&other.0.range.start),
      Ordering::Less => self
        .0
        .range
        .start
        .unsigned_shl(Q::shift(other.0.depth - self.0.depth) as u32)
        .cmp(&other.0.range.start),
      Ordering::Greater => self.0.range.start.cmp(
        &other
          .0
          .range
          .start
          .unsigned_shl(Q::shift(self.0.depth - other.0.depth) as u32),
      ),
    }
  }
}
impl<T: Idx, Q: MocQty<T>> PartialOrd for MocCellRange<T, Q> {
  fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
    Some(self.cmp(other))
  }
}

impl<T: Idx, Q: MocQty<T>> From<CellRange<T>> for MocCellRange<T, Q> {
  fn from(cell_range: CellRange<T>) -> Self {
    Self(cell_range, PhantomData)
  }
}