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

// Copyright 2017 The Spade Developers.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! # Spade
//! Spade (SPAtial Data structurEs, obviously!) implements a few nifty data structures optimized for spatial access operations.
//!
//! # Features
//! * An n-dimensional r*-tree: `spade::rtree::RTree`
//! * A 2D Delaunay triangulation: `spade::delaunay::DelaunayTriangulation`
//!   * Supports integral and floating point coordinates as input
//!   * Uses exact predicates to avoid floating point rounding issues, see `spade::kernels::FloatKernel`
//!   * Natural neighbor interpolation
//!   * Can be backed up by an r*-tree to improve performance when inserting randomly distributed points
//!   * Supports vertex removal
//! * A 2D constrained Delaunay triangulation: `spade::delaunay::ConstrainedDelaunayTriangulation`
//! * Supports serde. Activate the `serde_serialize` feature to enable (de)serialization of r*-trees,
//! (constrained) Delaunay triangulations and primitives.
//!
//! # Supported point types
//! Spade works well with points from the `nalgebra` and `cgmath` packages. Also, fixed size arrays of size 2, 3 and 4 are
//! supported. Also own vector types can be defined.
//! Please note that, due to the way cargo resolves dependencies, there might be issues when using spade combined with cgmath 
//! or nalgebra: every time spade updates these libraries, the using code must be update too, even if spade would still work
//!  with the older version. To avoid this, consider switching to fixed size arrays as points until 
//! [public / private dependencies make their way into cargo](https://github.com/rust-lang/rust/issues/44663).



#![warn(missing_docs)]

extern crate num;
extern crate cgmath;
extern crate nalgebra;
extern crate clamp;
extern crate smallvec;
extern crate pdqselect;

#[cfg(feature = "serde_serialize")]
#[macro_use]
extern crate serde;

#[cfg(all(feature = "serde_serialize", test))]
extern crate serde_json;

#[cfg(test)]
#[macro_use]
extern crate approx;
#[cfg(test)]
extern crate rand;

#[cfg(test)]
mod testutils;

mod traits;
mod point_traits;
mod misc;
mod boundingrect;
mod bigvec;
mod exactpred;

pub mod delaunay;
pub mod kernels;
pub mod primitives;
pub mod rtree;

pub use traits::*;
pub use boundingrect::*;
pub use point_traits::{PointN, TwoDimensional, ThreeDimensional};