Crate simplify_polyline

simplify-polyline

A nearly line-by-line Rust port of the Javascript simplify-js library.

Examples

use simplify_polyline::*;

fn main() {
    let points = &[
        Point { x: 0.0, y: 0.0 }, Point { x: 1.0, y: 1.0 },
        Point { x: 2.0, y: 2.0 }, Point { x: 3.0, y: 3.0 },
        Point { x: 4.0, y: 4.0 }
    ];
    // alternatively, use the point! macro
    let points = &[
        point!(f64, 0.0, 0.0), point!(f64, 1.0, 1.0), point!(f64, 2.0, 2.0),
        point!(f64, 3.0, 3.0), point!(f64, 4.0, 4.0)
    ];
    // alternatively, use the points! macro
    let points = points![f64, (0.0, 0.0), (1.0, 1.0), (2.0, 2.0), (3.0, 3.0), (4.0, 4.0)];

    // low-quality simplification (fast)
    let new_points = simplify(points, 1.0, false);
    // low-quality simplification (slower)
    let new_points = simplify(points, 1.0, true);
}

Performance

Measurements taken with an AMD Ryzen 7 5800x, in Pop!_OS 22.04.

Test Case	simplify-polyline	simplify-js
1118 Points, Low Quality, Tolerance 1	16.584 μs	52.907 μs
1118 Points, High Quality, Tolerance 1	30.910 μs	85.653 μs
1118 Points, Low Quality, Tolerance 5	3.987 μs	12.840 μs
1118 Points, High Quality, Tolerance 5	23.215 μs	57.901 μs
73752 Points, Low Quality, Tolerance 1	82.251 μs	273.075 μs
73752 Points, High Quality, Tolerance 1	1974.004 μs	5376.344 μs
73752 Points, Low Quality, Tolerance 5	54.150 μs	181.554 μs
73752 Points, High Quality, Tolerance 5	1460.742 μs	3921.569 μs

Contributing

Running tests:

$ cargo test --features tests

Running benchmarks:

$ cargo +nightly bench --features tests

Macros

point

Creates a Point struct, used for input and output for simplify. A type should be specified as the first argument that implements the ExtendedNumOps trait.

points

Creates a &[Point] array, used for used for input and output for simplify. A type should be specified as the first argument that implements the ExtendedNumOps trait. Point values should be specified as length-2 tuples, where each value matches the input type, in (x, y) order.

Structs

Point

A two-diemensional point, where the value of each coordinate must implement the ExtendedNumOps trait.

Traits

ExtendedNumOps

Required traits a number type must implement to be used with simplify.

Functions

simplify

Simplifies a polyline within a given tolerance.