Skip to content
This repository has been archived by the owner on Oct 21, 2021. It is now read-only.

Commit

Permalink
documentation fixes ref #148
Browse files Browse the repository at this point in the history
  • Loading branch information
mlubin committed Jan 2, 2015
1 parent 1c0c75b commit 3406df1
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions doc/source/interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,16 @@ Vertex Map interface

.. py:function:: vertex_index(v, g)
returns the index of a vertex ``v`` in graph ``g``.
returns the index of a vertex ``v`` in graph ``g``. Each vertex
must have a unique index between 1 and ``num_vertices``.

Edge Map interface
------------------

.. py:function:: edge_index(e, g)
returns the index of a vertex ``e`` in graph ``g``.
returns the index of an edge ``e`` in graph ``g``. Each edge
must have a unique index between 1 and ``num_edges``.


Adjacency List interface
Expand Down Expand Up @@ -106,7 +108,7 @@ Incidence List interface

.. py:function:: out_edges(v, g)
returns the number of outgoing edges from vertex ``v`` in graph ``g``.
returns an iterable view/container of outgoing edges from vertex ``v`` in graph ``g``.

.. py:function:: source(e, g)
Expand Down Expand Up @@ -138,11 +140,11 @@ This interface refines the ``Incidence List`` and requires the implementation of

.. py:function:: in_degree(v, g)
returns the number of incoming edges from vertex ``v`` in graph ``g``.
returns the number of incoming edges to vertex ``v`` in graph ``g``.

.. py:function:: in_edges(v, g)
returns the number of incoming edges from vertex ``v`` in graph ``g``.
returns an iterable view/container of the incoming edges to vertex ``v`` in graph ``g``.



Expand Down

0 comments on commit 3406df1

Please sign in to comment.