Skip to content

Commit

Permalink
fixing vertex documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
YueRen committed Aug 14, 2024
1 parent 112b83b commit 25a4090
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/src/PolyhedralGeometry/polyhedral_complexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,6 @@ n_vertices(PC::PolyhedralComplex)
polyhedra_of_dim
rays(PC::PolyhedralComplex{T}) where T<:scalar_types
rays_modulo_lineality(PC::PolyhedralComplex{T}) where T<:scalar_types
vertices(PC::PolyhedralComplex)
vertices(as::Type{PointVector{T}}, PC::PolyhedralComplex{T}) where {T<:scalar_types}
vertices_and_rays(PC::PolyhedralComplex{T}) where T<:scalar_types
```
4 changes: 2 additions & 2 deletions src/PolyhedralGeometry/PolyhedralComplex/properties.jl
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ translation `p+L`, where `p` is only unique modulo `L`. The return type is a
dict, the key `:base_points` gives an iterator over such `p`, and the key
`:lineality_basis` lets one access a basis for the lineality space `L` of `PC`.
See also [`vertices`](@ref) and [`lineality_space`](@ref).
See also [`vertices(as::Type{PointVector{T}}, PC::PolyhedralComplex{T}) where {T<:scalar_types}`](@ref) and [`lineality_space`](@ref).
# Examples
```jldoctest
Expand Down Expand Up @@ -310,7 +310,7 @@ Return the rays of `PC`. The rays are defined to be the far vertices, i.e. the
one-dimensional faces of the recession cones of its polyhedra, so if `PC` has
lineality, there are no rays.
See also [`rays_modulo_lineality`](@ref) and [`vertices`](@ref).
See also [`rays_modulo_lineality`](@ref) and [`vertices(as::Type{PointVector{T}}, PC::PolyhedralComplex{T}) where {T<:scalar_types}`](@ref).
Optional arguments for `as` include
* `RayVector`.
Expand Down

0 comments on commit 25a4090

Please sign in to comment.