Skip to content

Commit 3a3d0e3

Browse files
committed
Fix docstring of HalfEdgeTopology with new keyword option
1 parent 16a1352 commit 3a3d0e3

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/topologies/halfedge.jl

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ end
4242

4343
"""
4444
HalfEdgeTopology(elements; sort=true)
45-
HalfEdgeTopology(halfedges)
45+
HalfEdgeTopology(halfedges; nelems=nothing)
4646
4747
A data structure for orientable 2-manifolds based on
4848
half-edges constructed from a vector of connectivity
@@ -52,6 +52,9 @@ The option `sort` can be used to sort the elements in
5252
adjacent-first order in case of inconsistent orientation
5353
(i.e. mix of clockwise and counter-clockwise).
5454
55+
The option `nelems` can be used to specify an approximate
56+
number of `elements` as a size hint.
57+
5558
## Examples
5659
5760
Construct half-edge topology from a list of top-faces:
@@ -97,7 +100,7 @@ struct HalfEdgeTopology <: Topology
97100
edge4pair::Dict{Tuple{Int,Int},Int}
98101
end
99102

100-
function HalfEdgeTopology(halves::AbstractVector{Tuple{HalfEdge,HalfEdge}}, nelems=nothing)
103+
function HalfEdgeTopology(halves::AbstractVector{Tuple{HalfEdge,HalfEdge}}; nelems=nothing)
101104
# pre-allocate memory and provide size hints
102105
halfedges = Vector{HalfEdge}(undef, 2 * length(halves))
103106
edge4pair = Dict{Tuple{Int,Int},Int}()
@@ -222,7 +225,7 @@ function HalfEdgeTopology(elems::AbstractVector{<:Connectivity}; sort=true)
222225
end
223226
end
224227

225-
HalfEdgeTopology(halves, length(elems))
228+
HalfEdgeTopology(halves; nelems=length(elems))
226229
end
227230

228231
function adjsort(elems::AbstractVector{<:Connectivity})

0 commit comments

Comments
 (0)