Skip to content

Commit

Permalink
Adjusting the documentation to the new names
Browse files Browse the repository at this point in the history
  • Loading branch information
cvvergara committed May 27, 2024
1 parent 3f23593 commit d468bbb
Show file tree
Hide file tree
Showing 82 changed files with 482 additions and 482 deletions.
2 changes: 1 addition & 1 deletion doc/allpairs/pgr_floydWarshall.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Signatures

:Example: For a directed subgraph with edges :math:`\{1, 2, 3, 4\}`.

.. literalinclude:: doc-floydWarshall.queries
.. literalinclude:: floydWarshall.queries
:start-after: -- q1
:end-before: -- q2

Expand Down
2 changes: 1 addition & 1 deletion doc/allpairs/pgr_johnson.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Signatures
:Example: For a directed subgraph with edges :math:`\{1, 2, 3, 4\}`.

.. literalinclude:: doc-johnson.queries
.. literalinclude:: johnson.queries
:start-after: -- q1
:end-before: -- q2

Expand Down
2 changes: 1 addition & 1 deletion doc/alpha_shape/pgr_alphaShape.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Signatures
:Example: passing a geometry collection with spoon radius :math:`1.5` using the
return variable ``geom``

.. literalinclude:: doc-pgr_alphashape.queries
.. literalinclude:: alphashape.queries
:start-after: -- q1
:end-before: -- q2

Expand Down
18 changes: 9 additions & 9 deletions doc/astar/pgr_aStar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ One to One
:Example: From vertex :math:`6` to vertex :math:`12` on a **directed** graph
with heuristic :math:`2`

.. literalinclude:: doc-astar.queries
.. literalinclude:: astar.queries
:start-after: -- q2
:end-before: -- q3

Expand All @@ -135,7 +135,7 @@ One to Many
:Example: From vertex :math:`6` to vertices :math:`\{10, 12\}` on a **directed**
graph with heuristic :math:`3` and factor :math:`3.5`

.. literalinclude:: doc-astar.queries
.. literalinclude:: astar.queries
:start-after: -- q3
:end-before: -- q4

Expand All @@ -157,7 +157,7 @@ Many to One
:Example: From vertices :math:`\{6, 8\}` to vertex :math:`10` on an
**undirected** graph with heuristic :math:`4`

.. literalinclude:: doc-astar.queries
.. literalinclude:: astar.queries
:start-after: -- q4
:end-before: -- q5

Expand All @@ -179,7 +179,7 @@ Many to Many
:Example: From vertices :math:`\{6, 8\}` to vertices :math:`\{10, 12\}` on a
**directed** graph with factor :math:`0.5`

.. literalinclude:: doc-astar.queries
.. literalinclude:: astar.queries
:start-after: -- q5
:end-before: -- q51

Expand All @@ -203,13 +203,13 @@ Combinations

The combinations table:

.. literalinclude:: doc-astar.queries
.. literalinclude:: astar.queries
:start-after: -- q51
:end-before: -- q52

The query:

.. literalinclude:: doc-astar.queries
.. literalinclude:: astar.queries
:start-after: -- q52
:end-before: -- q6

Expand Down Expand Up @@ -263,19 +263,19 @@ Additional Examples

:Example 1: Demonstration of repeated values are ignored, and result is sorted.

.. literalinclude:: doc-astar.queries
.. literalinclude:: astar.queries
:start-after: -- q6
:end-before: -- q7

:Example 2: Making **start vids** the same as **end vids**.

.. literalinclude:: doc-astar.queries
.. literalinclude:: astar.queries
:start-after: -- q7
:end-before: -- q8

:Example 3: Manually assigned vertex combinations.

.. literalinclude:: doc-astar.queries
.. literalinclude:: astar.queries
:start-after: -- q8
:end-before: -- q9

Expand Down
18 changes: 9 additions & 9 deletions doc/astar/pgr_aStarCost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ One to One
:Example: From vertex :math:`6` to vertex :math:`12` on a **directed** graph
with heuristic :math:`2`

.. literalinclude:: doc-aStarCost.queries
.. literalinclude:: aStarCost.queries
:start-after: -- q2
:end-before: -- q3

Expand All @@ -121,7 +121,7 @@ One to Many
:Example: From vertex :math:`6` to vertices :math:`\{10, 12\}` on a **directed**
graph with heuristic :math:`3` and factor :math:`3.5`

.. literalinclude:: doc-aStarCost.queries
.. literalinclude:: aStarCost.queries
:start-after: -- q3
:end-before: -- q4

Expand All @@ -143,7 +143,7 @@ Many to One
:Example: From vertices :math:`\{6, 8\}` to vertex :math:`10` on an
**undirected** graph with heuristic :math:`4`

.. literalinclude:: doc-aStarCost.queries
.. literalinclude:: aStarCost.queries
:start-after: -- q4
:end-before: -- q5

Expand All @@ -165,7 +165,7 @@ Many to Many
:Example: From vertices :math:`\{6, 8\}` to vertices :math:`\{10, 12\}` on a
**directed** graph with factor :math:`0.5`

.. literalinclude:: doc-aStarCost.queries
.. literalinclude:: aStarCost.queries
:start-after: -- q5
:end-before: -- q51

Expand All @@ -189,13 +189,13 @@ Combinations

The combinations table:

.. literalinclude:: doc-aStarCost.queries
.. literalinclude:: aStarCost.queries
:start-after: -- q51
:end-before: -- q52

The query:

.. literalinclude:: doc-aStarCost.queries
.. literalinclude:: aStarCost.queries
:start-after: -- q52
:end-before: -- q6

Expand Down Expand Up @@ -249,19 +249,19 @@ Additional Examples

:Example 1: Demonstration of repeated values are ignored, and result is sorted.

.. literalinclude:: doc-aStarCost.queries
.. literalinclude:: aStarCost.queries
:start-after: -- q6
:end-before: -- q7

:Example 2: Making **start vids** the same as **end vids**.

.. literalinclude:: doc-aStarCost.queries
.. literalinclude:: aStarCost.queries
:start-after: -- q7
:end-before: -- q8

:Example 3: Manually assigned vertex combinations.

.. literalinclude:: doc-aStarCost.queries
.. literalinclude:: aStarCost.queries
:start-after: -- q8
:end-before: -- q9

Expand Down
4 changes: 2 additions & 2 deletions doc/astar/pgr_aStarCostMatrix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Signatures
:Example: Symmetric cost matrix for vertices :math:`\{5, 6, 10, 15\}` on an
**undirected** graph using heuristic :math:`2`

.. literalinclude:: doc-aStarCostMatrix.queries
.. literalinclude:: aStarCostMatrix.queries
:start-after: -- q2
:end-before: -- q3

Expand Down Expand Up @@ -119,7 +119,7 @@ Additional Examples

:Example: Use with :doc:`pgr_TSP`

.. literalinclude:: doc-aStarCostMatrix.queries
.. literalinclude:: aStarCostMatrix.queries
:start-after: -- q3
:end-before: -- q4

Expand Down
18 changes: 9 additions & 9 deletions doc/bdAstar/pgr_bdAstar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ One to One
:Example: From vertex :math:`6` to vertex :math:`12` on a **directed** graph
with heuristic :math:`2`

.. literalinclude:: doc-pgr_bdAstar.queries
.. literalinclude:: bdAstar.queries
:start-after: -- q2
:end-before: -- q3

Expand All @@ -133,7 +133,7 @@ One to Many
:Example: From vertex :math:`6` to vertices :math:`\{10, 12\}` on a **directed**
graph with heuristic :math:`3` and factor :math:`3.5`

.. literalinclude:: doc-pgr_bdAstar.queries
.. literalinclude:: bdAstar.queries
:start-after: -- q3
:end-before: -- q4

Expand All @@ -155,7 +155,7 @@ Many to One
:Example: From vertices :math:`\{6, 8\}` to vertex :math:`10` on an
**undirected** graph with heuristic :math:`4`

.. literalinclude:: doc-pgr_bdAstar.queries
.. literalinclude:: bdAstar.queries
:start-after: -- q4
:end-before: -- q5

Expand All @@ -177,7 +177,7 @@ Many to Many
:Example: From vertices :math:`\{6, 8\}` to vertices :math:`\{10, 12\}` on a
**directed** graph with factor :math:`0.5`

.. literalinclude:: doc-pgr_bdAstar.queries
.. literalinclude:: bdAstar.queries
:start-after: -- q5
:end-before: -- q51

Expand All @@ -201,13 +201,13 @@ Combinations

The combinations table:

.. literalinclude:: doc-pgr_bdAstar.queries
.. literalinclude:: bdAstar.queries
:start-after: -- q51
:end-before: -- q52

The query:

.. literalinclude:: doc-pgr_bdAstar.queries
.. literalinclude:: bdAstar.queries
:start-after: -- q52
:end-before: -- q6

Expand Down Expand Up @@ -261,19 +261,19 @@ Additional Examples

:Example 1: Demonstration of repeated values are ignored, and result is sorted.

.. literalinclude:: doc-pgr_bdAstar.queries
.. literalinclude:: bdAstar.queries
:start-after: -- q6
:end-before: -- q7

:Example 2: Making **start vids** the same as **end vids**.

.. literalinclude:: doc-pgr_bdAstar.queries
.. literalinclude:: bdAstar.queries
:start-after: -- q7
:end-before: -- q8

:Example 3: Manually assigned vertex combinations.

.. literalinclude:: doc-pgr_bdAstar.queries
.. literalinclude:: bdAstar.queries
:start-after: -- q8
:end-before: -- q9

Expand Down
18 changes: 9 additions & 9 deletions doc/bdAstar/pgr_bdAstarCost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ One to One
:Example: From vertex :math:`6` to vertex :math:`12` on a **directed** graph
with heuristic :math:`2`

.. literalinclude:: doc-pgr_bdAstarCost.queries
.. literalinclude:: bdAstarCost.queries
:start-after: -- q2
:end-before: -- q3

Expand All @@ -122,7 +122,7 @@ One to Many
:Example: From vertex :math:`6` to vertices :math:`\{10, 12\}` on a **directed**
graph with heuristic :math:`3` and factor :math:`3.5`

.. literalinclude:: doc-pgr_bdAstarCost.queries
.. literalinclude:: bdAstarCost.queries
:start-after: -- q3
:end-before: -- q4

Expand All @@ -144,7 +144,7 @@ Many to One
:Example: From vertices :math:`\{6, 8\}` to vertex :math:`10` on an
**undirected** graph with heuristic :math:`4`

.. literalinclude:: doc-pgr_bdAstarCost.queries
.. literalinclude:: bdAstarCost.queries
:start-after: -- q4
:end-before: -- q5

Expand All @@ -166,7 +166,7 @@ Many to Many
:Example: From vertices :math:`\{6, 8\}` to vertices :math:`\{10, 12\}` on a
**directed** graph with factor :math:`0.5`

.. literalinclude:: doc-pgr_bdAstarCost.queries
.. literalinclude:: bdAstarCost.queries
:start-after: -- q5
:end-before: -- q51

Expand All @@ -190,13 +190,13 @@ Combinations

The combinations table:

.. literalinclude:: doc-pgr_bdAstarCost.queries
.. literalinclude:: bdAstarCost.queries
:start-after: -- q51
:end-before: -- q52

The query:

.. literalinclude:: doc-pgr_bdAstarCost.queries
.. literalinclude:: bdAstarCost.queries
:start-after: -- q52
:end-before: -- q6

Expand Down Expand Up @@ -250,19 +250,19 @@ Additional Examples

:Example 1: Demonstration of repeated values are ignored, and result is sorted.

.. literalinclude:: doc-pgr_bdAstarCost.queries
.. literalinclude:: bdAstarCost.queries
:start-after: -- q6
:end-before: -- q7

:Example 2: Making **start vids** the same as **end vids**.

.. literalinclude:: doc-pgr_bdAstarCost.queries
.. literalinclude:: bdAstarCost.queries
:start-after: -- q7
:end-before: -- q8

:Example 3: Manually assigned vertex combinations.

.. literalinclude:: doc-pgr_bdAstarCost.queries
.. literalinclude:: bdAstarCost.queries
:start-after: -- q8
:end-before: -- q9

Expand Down
4 changes: 2 additions & 2 deletions doc/bdAstar/pgr_bdAstarCostMatrix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Signatures
:Example: Symmetric cost matrix for vertices :math:`\{5, 6, 10, 15\}` on an
**undirected** graph using heuristic :math:`2`

.. literalinclude:: doc-pgr_bdAstarCostMatrix.queries
.. literalinclude:: bdAstarCostMatrix.queries
:start-after: -- q2
:end-before: -- q3

Expand Down Expand Up @@ -119,7 +119,7 @@ Additional Examples

:Example: Use with :doc:`pgr_TSP`

.. literalinclude:: doc-pgr_bdAstarCostMatrix.queries
.. literalinclude:: bdAstarCostMatrix.queries
:start-after: -- q3
:end-before: -- q4

Expand Down
Loading

0 comments on commit d468bbb

Please sign in to comment.