Overview

This section provides docstrings for all functions in the public API, split into sections. If you want a written description of some of the main features of this package, see the manual. We will describe the following:

Data Structures: Some of the main data structures used in this package.
Triangulations: Functions for creating and working with triangulations.
Triangulation Operations: Functions for modifying triangulations.
Voronoi Tessellations: Functions for creating and working with Voronoi tessellations.
Convex Hull: Functions for creating convex hulls.
Curves: Functions for defining curves for use with curve-bounded domains.
Iterators: Functions for iterating over triangulation and tessellation features.
Point Location: Functions for performing point location.
Predicates: Functions for computing geometric predicates.
Triangulation Statistics: Functions for computing statistics about triangulations.
Primitive Interfaces: Functions for defining primitive interfaces.
Other: Other functions that don't fit into the above categories.

We emphasise that a function having a docstring does NOT guarantee it being in the public API - only it being listed here will guarantee this.

We also note that, for more structs such as Triangulation and VoronoiTessellations, their fields are not intended to be in the public API. Rather, their associated accessor functions are intended to be used, e.g. prefer get_X(tri) instead of tri.X for tri::Triangulation.

Each section will first start with the list of all functions to be listed, and then the docstrings of those functions will be given. There will be some docstrings that fit into multiple categories, in which case one is chosen. Here is an index of all the functions listed in the above pages.