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.
DelaunayTriangulation.convex_hull
DelaunayTriangulation.convex_hull!
DelaunayTriangulation.AbstractParametricCurve
DelaunayTriangulation.BSpline
DelaunayTriangulation.BezierCurve
DelaunayTriangulation.CatmullRomSpline
DelaunayTriangulation.CircularArc
DelaunayTriangulation.EllipticalArc
DelaunayTriangulation.LineSegment
DelaunayTriangulation.angle_between
DelaunayTriangulation.arc_length
DelaunayTriangulation.curvature
DelaunayTriangulation.differentiate
DelaunayTriangulation.get_circle_intersection
DelaunayTriangulation.get_closest_point
DelaunayTriangulation.get_equidistant_split
DelaunayTriangulation.get_equivariation_split
DelaunayTriangulation.get_inverse
DelaunayTriangulation.marked_total_variation
DelaunayTriangulation.orientation_markers
DelaunayTriangulation.point_position_relative_to_curve
DelaunayTriangulation.thrice_differentiate
DelaunayTriangulation.total_variation
DelaunayTriangulation.twice_differentiate
DelaunayTriangulation.Adjacent
DelaunayTriangulation.Adjacent2Vertex
DelaunayTriangulation.ConvexHull
DelaunayTriangulation.Graph
DelaunayTriangulation.InsertionEventHistory
DelaunayTriangulation.PointLocationHistory
DelaunayTriangulation.Triangulation
DelaunayTriangulation.VoronoiTessellation
DelaunayTriangulation.each_boundary_edge
DelaunayTriangulation.each_edge
DelaunayTriangulation.each_generator
DelaunayTriangulation.each_ghost_edge
DelaunayTriangulation.each_ghost_triangle
DelaunayTriangulation.each_ghost_vertex
DelaunayTriangulation.each_point
DelaunayTriangulation.each_point_index
DelaunayTriangulation.each_polygon
DelaunayTriangulation.each_polygon_index
DelaunayTriangulation.each_polygon_vertex
DelaunayTriangulation.each_segment
DelaunayTriangulation.each_solid_edge
DelaunayTriangulation.each_solid_triangle
DelaunayTriangulation.each_solid_vertex
DelaunayTriangulation.each_triangle
DelaunayTriangulation.each_unbounded_polygon
DelaunayTriangulation.each_vertex
DelaunayTriangulation.num_edges
DelaunayTriangulation.num_ghost_edges
DelaunayTriangulation.num_ghost_triangles
DelaunayTriangulation.num_ghost_vertices
DelaunayTriangulation.num_solid_edges
DelaunayTriangulation.num_solid_triangles
DelaunayTriangulation.num_solid_vertices
DelaunayTriangulation.num_triangles
DelaunayTriangulation.num_vertices
DelaunayTriangulation.add_boundary_information!
DelaunayTriangulation.add_ghost_triangles!
DelaunayTriangulation.add_point!
DelaunayTriangulation.add_segment!
DelaunayTriangulation.add_triangle!
DelaunayTriangulation.clear_empty_features!
DelaunayTriangulation.complete_split_edge_and_legalise!
DelaunayTriangulation.complete_split_triangle_and_legalise!
DelaunayTriangulation.delete_ghost_triangles!
DelaunayTriangulation.delete_holes!
DelaunayTriangulation.delete_point!
DelaunayTriangulation.delete_triangle!
DelaunayTriangulation.flip_edge!
DelaunayTriangulation.get_surrounding_polygon
DelaunayTriangulation.legalise_edge!
DelaunayTriangulation.lock_convex_hull!
DelaunayTriangulation.split_edge!
DelaunayTriangulation.split_triangle!
DelaunayTriangulation.unlock_convex_hull!
DelaunayTriangulation.clip_polygon
DelaunayTriangulation.construct_polygon_hierarchy
DelaunayTriangulation.distance_to_polygon
DelaunayTriangulation.number_type
DelaunayTriangulation.pole_of_inaccessibility
DelaunayTriangulation.brute_force_search
DelaunayTriangulation.find_polygon
DelaunayTriangulation.find_triangle
DelaunayTriangulation.get_nearest_neighbour
DelaunayTriangulation.Certificate
DelaunayTriangulation.AbstractPredicateKernel
DelaunayTriangulation.AdaptiveKernel
DelaunayTriangulation.ExactKernel
DelaunayTriangulation.FastKernel
DelaunayTriangulation.angle_is_acute_predicate
DelaunayTriangulation.contains_segment
DelaunayTriangulation.contains_triangle
DelaunayTriangulation.edge_exists
DelaunayTriangulation.find_edge
DelaunayTriangulation.has_boundary_nodes
DelaunayTriangulation.has_ghost_triangles
DelaunayTriangulation.has_multiple_curves
DelaunayTriangulation.has_multiple_intersections
DelaunayTriangulation.has_multiple_sections
DelaunayTriangulation.has_no_intersections
DelaunayTriangulation.has_one_intersection
DelaunayTriangulation.incircle_predicate
DelaunayTriangulation.is_above
DelaunayTriangulation.is_acute
DelaunayTriangulation.is_below
DelaunayTriangulation.is_boundary_edge
DelaunayTriangulation.is_boundary_node
DelaunayTriangulation.is_boundary_triangle
DelaunayTriangulation.is_closer
DelaunayTriangulation.is_collinear
DelaunayTriangulation.is_constrained
DelaunayTriangulation.is_degenerate
DelaunayTriangulation.is_equidistant
DelaunayTriangulation.is_further
DelaunayTriangulation.is_ghost_edge
DelaunayTriangulation.is_ghost_triangle
DelaunayTriangulation.is_ghost_vertex
DelaunayTriangulation.is_illegal
DelaunayTriangulation.is_inside
DelaunayTriangulation.is_left
DelaunayTriangulation.is_legal
DelaunayTriangulation.is_multiple
DelaunayTriangulation.is_negatively_oriented
DelaunayTriangulation.is_negativelyoriented
DelaunayTriangulation.is_none
DelaunayTriangulation.is_obtuse
DelaunayTriangulation.is_on
DelaunayTriangulation.is_outside
DelaunayTriangulation.is_positively_oriented
DelaunayTriangulation.is_positivelyoriented
DelaunayTriangulation.is_right
DelaunayTriangulation.is_single
DelaunayTriangulation.is_touching
DelaunayTriangulation.is_weighted
DelaunayTriangulation.line_segment_intersection_type
DelaunayTriangulation.meet_predicate
DelaunayTriangulation.opposite_angle
DelaunayTriangulation.orient_predicate
DelaunayTriangulation.parallelorder_predicate
DelaunayTriangulation.point_closest_to_line
DelaunayTriangulation.point_position_on_line_segment
DelaunayTriangulation.point_position_relative_to_circle
DelaunayTriangulation.point_position_relative_to_circumcircle
DelaunayTriangulation.point_position_relative_to_diametral_circle
DelaunayTriangulation.point_position_relative_to_diametral_lens
DelaunayTriangulation.point_position_relative_to_line
DelaunayTriangulation.point_position_relative_to_oriented_outer_halfplane
DelaunayTriangulation.point_position_relative_to_triangle
DelaunayTriangulation.point_position_relative_to_witness_plane
DelaunayTriangulation.sameside_predicate
DelaunayTriangulation.triangle_line_segment_intersection
DelaunayTriangulation.triangle_orientation
DelaunayTriangulation.unoriented_edge_exists
DelaunayTriangulation.add_to_edges!
DelaunayTriangulation.add_to_triangles!
DelaunayTriangulation.compare_triangles
DelaunayTriangulation.compare_unoriented_edges
DelaunayTriangulation.construct_edge
DelaunayTriangulation.construct_triangle
DelaunayTriangulation.contains_edge
DelaunayTriangulation.contains_unoriented_edge
DelaunayTriangulation.delete_from_edges!
DelaunayTriangulation.delete_from_triangles!
DelaunayTriangulation.delete_unoriented_edge!
DelaunayTriangulation.each_boundary_node
DelaunayTriangulation.edge_type
DelaunayTriangulation.edge_vertices
DelaunayTriangulation.edges_are_disjoint
DelaunayTriangulation.get_point
DelaunayTriangulation.geti
DelaunayTriangulation.getj
DelaunayTriangulation.getk
DelaunayTriangulation.getpoint
DelaunayTriangulation.getx
DelaunayTriangulation.getxy
DelaunayTriangulation.gety
DelaunayTriangulation.initial
DelaunayTriangulation.is_planar
DelaunayTriangulation.is_point2
DelaunayTriangulation.num_boundary_edges
DelaunayTriangulation.pop_point!
DelaunayTriangulation.push_point!
DelaunayTriangulation.random_edge
DelaunayTriangulation.reverse_edge
DelaunayTriangulation.set_point!
DelaunayTriangulation.sort_triangle
DelaunayTriangulation.terminal
DelaunayTriangulation.triangle_edges
DelaunayTriangulation.triangle_type
DelaunayTriangulation.triangle_vertices
DelaunayTriangulation.IndividualTriangleStatistics
DelaunayTriangulation.TriangulationStatistics
DelaunayTriangulation.get_all_stat
DelaunayTriangulation.get_angles
DelaunayTriangulation.get_aspect_ratio
DelaunayTriangulation.get_circumcenter
DelaunayTriangulation.get_circumradius
DelaunayTriangulation.get_edge_midpoints
DelaunayTriangulation.get_individual_statistics
DelaunayTriangulation.get_inradius
DelaunayTriangulation.get_largest_angle
DelaunayTriangulation.get_largest_area
DelaunayTriangulation.get_largest_radius_edge_ratio
DelaunayTriangulation.get_lengths
DelaunayTriangulation.get_maximum_angle
DelaunayTriangulation.get_median_angle
DelaunayTriangulation.get_minimum_angle
DelaunayTriangulation.get_offcenter
DelaunayTriangulation.get_perimeter
DelaunayTriangulation.get_radius_edge_ratio
DelaunayTriangulation.get_sink
DelaunayTriangulation.get_smallest_angle
DelaunayTriangulation.get_smallest_area
DelaunayTriangulation.get_smallest_radius_edge_ratio
DelaunayTriangulation.num_boundary_segments
DelaunayTriangulation.num_convex_hull_vertices
DelaunayTriangulation.num_interior_segments
DelaunayTriangulation.num_segments
DelaunayTriangulation.statistics
DelaunayTriangulation.triangle_angles
DelaunayTriangulation.triangle_area
DelaunayTriangulation.triangle_aspect_ratio
DelaunayTriangulation.triangle_centroid
DelaunayTriangulation.triangle_circumcenter
DelaunayTriangulation.triangle_circumradius
DelaunayTriangulation.triangle_edge_midpoints
DelaunayTriangulation.triangle_inradius
DelaunayTriangulation.triangle_lengths
DelaunayTriangulation.triangle_offcenter
DelaunayTriangulation.triangle_orthocenter
DelaunayTriangulation.triangle_orthoradius_squared
DelaunayTriangulation.triangle_perimeter
DelaunayTriangulation.triangle_radius_edge_ratio
DelaunayTriangulation.triangle_sink
DelaunayTriangulation.ZeroWeight
DelaunayTriangulation.add_weight!
DelaunayTriangulation.all_ghost_vertices
DelaunayTriangulation.check_args
DelaunayTriangulation.compute_representative_points!
DelaunayTriangulation.contains_boundary_edge
DelaunayTriangulation.convert_boundary_points_to_indices
DelaunayTriangulation.delete_ghost_vertices_from_graph!
DelaunayTriangulation.dist
DelaunayTriangulation.get_adjacent
DelaunayTriangulation.get_adjacent2vertex
DelaunayTriangulation.get_all_boundary_nodes
DelaunayTriangulation.get_all_segments
DelaunayTriangulation.get_area
DelaunayTriangulation.get_boundary_curves
DelaunayTriangulation.get_boundary_edge_map
DelaunayTriangulation.get_boundary_nodes
DelaunayTriangulation.get_convex_hull
DelaunayTriangulation.get_convex_hull_vertices
DelaunayTriangulation.get_curve_index
DelaunayTriangulation.get_edges
DelaunayTriangulation.get_ghost_vertex_map
DelaunayTriangulation.get_ghost_vertex_range
DelaunayTriangulation.get_ghost_vertex_ranges
DelaunayTriangulation.get_graph
DelaunayTriangulation.get_insertion_order
DelaunayTriangulation.get_interior_segments
DelaunayTriangulation.get_left_boundary_node
DelaunayTriangulation.get_neighbours
DelaunayTriangulation.get_points
DelaunayTriangulation.get_representative_point_coordinates
DelaunayTriangulation.get_representative_point_list
DelaunayTriangulation.get_right_boundary_node
DelaunayTriangulation.get_section_index
DelaunayTriangulation.get_triangles
DelaunayTriangulation.get_vertices
DelaunayTriangulation.get_weight
DelaunayTriangulation.get_weights
DelaunayTriangulation.has_ghost_vertices
DelaunayTriangulation.has_vertex
DelaunayTriangulation.is_exterior_ghost_vertex
DelaunayTriangulation.is_interior_ghost_vertex
DelaunayTriangulation.iterated_neighbourhood
DelaunayTriangulation.map_ghost_vertex
DelaunayTriangulation.num_curves
DelaunayTriangulation.num_neighbours
DelaunayTriangulation.num_points
DelaunayTriangulation.num_sections
DelaunayTriangulation.refine!
DelaunayTriangulation.retriangulate
DelaunayTriangulation.triangulate
DelaunayTriangulation.triangulate_convex
DelaunayTriangulation.triangulate_rectangle
DelaunayTriangulation.validate_triangulation
DelaunayTriangulation.centroidal_smooth
DelaunayTriangulation.get_boundary_polygons
DelaunayTriangulation.get_centroid
DelaunayTriangulation.get_circumcenter_to_triangle
DelaunayTriangulation.get_cocircular_circumcenters
DelaunayTriangulation.get_generator
DelaunayTriangulation.get_generators
DelaunayTriangulation.get_polygon
DelaunayTriangulation.get_polygon_coordinates
DelaunayTriangulation.get_polygon_point
DelaunayTriangulation.get_polygon_points
DelaunayTriangulation.get_polygons
DelaunayTriangulation.get_triangle_to_circumcenter
DelaunayTriangulation.get_triangulation
DelaunayTriangulation.get_unbounded_polygons
DelaunayTriangulation.num_generators
DelaunayTriangulation.num_polygon_vertices
DelaunayTriangulation.num_polygons
DelaunayTriangulation.polygon_bounds
DelaunayTriangulation.polygon_features
DelaunayTriangulation.toggle_inf_warn!
DelaunayTriangulation.voronoi