Skip to content

Commit cc23d83

Browse files
committed
docs update
1 parent 7548127 commit cc23d83

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

docs/graph_elements.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,14 +164,20 @@ The destructor is *defaulted*, allowing proper cleanup of the `edge_descriptor`
164164

165165
- **`incident_vertex(const vertex_type& vertex) const`**:
166166
- *Description*: Returns the vertex on the other end of the edge relative to the provided vertex. Throws an error if the provided vertex is not incident with the edge.
167-
- *Returned value*: $\begin{cases} v & \text{: vertex} = u \\ u & \text{: vertex} = v \\ \text{error} & \text{: otherwise} \end{cases}$
167+
- *Returned value*:
168+
- $v$ if $\text{vertex} = u$
169+
- $u$ if $\text{vertex} = v$
170+
- error otherwise
168171
- *Parameters*:
169172
- `vertex: const vertex_type&` – the vertex for which the opposite vertex is requested.
170173
- *Return type*: `const vertex_type&`
171174

172175
- **`incident_vertex_id(const types::id_type vertex_id) const`**:
173176
- *Description*: Returns the ID of the vertex on the other end of the edge relative to the provided vertex ID. Throws an error if the provided vertex ID is invalid.
174-
- *Returned value*: $\begin{cases} v_{id} & \text{: vertex-id} = u_{id} \\ u_{id} & \text{: vertex-id} = v_{id} \\ \text{error} & \text{: otherwise} \end{cases}$
177+
- *Returned value*:
178+
- $v_{id}$ if $\text{vertex-id} = u_{id}$
179+
- $u_{id}$ if $\text{vertex-id} = v_{id}$
180+
- error otherwise
175181
- *Parameters*:
176182
- `vertex_id: const types::id_type` – the vertex ID for which the opposite vertex ID is requested.
177183
- *Return type*: `types::id_type`

0 commit comments

Comments
 (0)