Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix size types in BGL doc #8722

Open
wants to merge 2 commits into
base: 5.6.x-branch
Choose a base branch
from
Open

Fix size types in BGL doc #8722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c5515b
Fix types
MaelRL Jan 28, 2025
68e7bfa
Might as well use the real type
MaelRL Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion BGL/doc/BGL/BGL.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ boost::graph_traits<Graph>::edge_iterator ei;
Algorithms obtain incidence information in graphs with the help of global
functions such as:
- `std::pair<vertex_iterator,vertex_iterator> vertices(const Graph& g);` to obtain an iterator range providing access to all the vertices, or
- `int num_vertices(const Graph&);` to obtain the number of vertices of a graph, or
- `vertices_size_type num_vertices(const Graph&);` to obtain the number of vertices of a graph, or
- `vertex_descriptor source(edge_descriptor, const Graph&);` to obtain the source vertex of an edge.

Note, that the way we have written the types is a simplification; in reality,
Expand Down
2 changes: 1 addition & 1 deletion BGL/doc/BGL/Concepts/FaceListGraph.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ faces(const FaceListGraph& g);
This is the case for implementations only marking faces deleted in the face container.
*/
template <typename FaceListGraph>
boost::graph_traits<FaceListGraph>::face_size_type
boost::graph_traits<FaceListGraph>::faces_size_type
num_faces(const FaceListGraph& g);

2 changes: 1 addition & 1 deletion BGL/doc/BGL/Concepts/HalfedgeListGraph.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ halfedges(const HalfedgeListGraph& g);
This is the case for implementations only marking halfedges deleted in the halfedge container.
*/
template <typename HalfedgeListGraph>
boost::graph_traits<HalfedgeListGraph>::halfedge_size_type
boost::graph_traits<HalfedgeListGraph>::halfedges_size_type
num_halfedges(const HalfedgeListGraph& g);