/usr/share/doc/postgresql-9.5-pgrouting-doc/html/en/doc/index.html is in postgresql-9.5-pgrouting-doc 2.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Table of Contents — pgRouting Manual (2.1.0)</title>
<link rel="stylesheet" href="../_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.1.0 (b38118a master)',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="top" title="pgRouting Manual (2.1.0)" href="#" />
<link rel="next" title="Introduction" href="src/introduction/introduction.html" />
</head>
<body role="document">
<div class="header" role="banner"><img class="rightlogo" src="../_static/pgrouting.png" alt="Logo"/><h1 class="heading"><a href="../index.html">
<span>pgRouting Manual (2.1.0)</span></a></h1>
<h2 class="heading"><span>Table of Contents</span></h2>
</div>
<div class="topnav" role="navigation" aria-label="top navigation">
<p>
<a class="uplink" href="#">Contents</a>
  ::  
<a href="src/introduction/introduction.html">Introduction</a>  »
</p>
</div>
<div class="content">
<div class="section" id="table-of-contents">
<span id="index"></span><h1>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h1>
<p>pgRouting extends the <a class="reference external" href="http://postgis.net">PostGIS</a>/<a class="reference external" href="http://postgresql.org">PostgreSQL</a> geospatial database to provide geospatial routing and other network analysis functionality.</p>
<p>This is the manual for pgRouting 2.1.0 (b38118a master).</p>
<img alt="Creative Commons Attribution-Share Alike 3.0 License" class="align-left" src="../_images/ccbysa.png" />
<p>The pgRouting Manual is licensed under a <a class="reference external" href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-Share Alike 3.0 License</a>. Feel free to use this material any way you like, but we ask that you attribute credit to the pgRouting Project and wherever possible, a link back to <a class="reference external" href="http://pgrouting.org">http://pgrouting.org</a>. For other licenses used in pgRouting see the <a class="reference internal" href="src/introduction/introduction.html#license"><span>License</span></a> page.</p>
<div class="section" id="general">
<h2>General<a class="headerlink" href="#general" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="src/introduction/introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="src/introduction/introduction.html#license">License</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/introduction/introduction.html#contributors">Contributors</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/introduction/introduction.html#inside">Inside</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/introduction/introduction.html#more-information">More Information</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="src/installation/index.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="src/installation/index.html#download">Download</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/installation/index.html#installing-in-the-database">Installing in the database</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/installation/index.html#upgrading-the-database">Upgrading the database</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="src/installation/build.html">Build Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="src/installation/build.html#dependencies">Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/installation/build.html#configuration">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/installation/build.html#building">Building</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/installation/build.html#installation-and-reinstallation">Installation and reinstallation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="src/introduction/support.html">Support</a><ul>
<li class="toctree-l2"><a class="reference internal" href="src/introduction/support.html#reporting-problems">Reporting Problems</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/introduction/support.html#mailing-list-and-gis-stackexchange">Mailing List and GIS StackExchange</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/introduction/support.html#commercial-support">Commercial Support</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="tutorial">
<h2>Tutorial<a class="headerlink" href="#tutorial" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="src/tutorial/index.html#tutorial1"><span>Tutorial</span></a></p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="src/tutorial/tutorial.html#tutorial"><span>Getting started</span></a></li>
<li><a class="reference internal" href="src/tutorial/topology.html#topology"><span>Routing Topology</span></a> for an overview of a topology for routing algorithms.</li>
<li><a class="reference internal" href="src/tutorial/analytics.html#analytics"><span>Graph Analytics</span></a> for an overview of the analysis of a graph.</li>
<li><a class="reference internal" href="src/tutorial/custom_query.html#custom-query"><span>Dictionary of columns & Custom Query</span></a> that is used in the routing algorithms.</li>
<li><a class="reference internal" href="src/tutorial/performance.html#performance"><span>Performance Tips</span></a> to improve your performance.</li>
<li><a class="reference internal" href="src/developer/sampledata.html#sampledata"><span>Sample Data</span></a> that is used in the examples of this manual.</li>
<li><a class="reference internal" href="src/recipes/index.html#recipes"><span>User’s Recipes List</span></a></li>
</ul>
</div></blockquote>
<div class="toctree-wrapper compound">
</div>
<p>For a more complete introduction how to build a routing application read the <a class="reference external" href="http://workshop.pgrouting.org">pgRouting Workshop</a>.</p>
</div>
<div class="section" id="version">
<h2>Version<a class="headerlink" href="#version" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="../src/common/doc/utilities/version.html#pgr-version"><span>pgr_version</span></a> - to get pgRouting’s version information.</p>
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="data-types">
<h2>Data Types<a class="headerlink" href="#data-types" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="../src/common/doc/types/index.html#data-types"><span>pgRouting Data Types</span></a></p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="../src/common/doc/types/cost_result.html#type-cost-result"><span>pgr_costResult[]</span></a> - A set of records to describe a path result with cost attribute.</li>
<li><a class="reference internal" href="../src/common/doc/types/cost_result.html#type-cost-result3"><span>pgr_costResult3[]</span></a> - A set of records to describe a path result with cost attribute.</li>
<li><a class="reference internal" href="../src/common/doc/types/geom_result.html#type-geom-result"><span>pgr_geomResult</span></a> - A set of records to describe a path result with geometry attribute.</li>
</ul>
</div></blockquote>
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="topology-functions">
<h2>Topology functions<a class="headerlink" href="#topology-functions" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="../src/common/doc/functions/index.html#topology-functions"><span>Topology Functions</span></a></p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="../src/common/doc/functions/create_topology.html#pgr-create-topology"><span>pgr_createTopology</span></a> - to create a topology based on the geometry.</li>
<li><a class="reference internal" href="../src/common/doc/functions/create_vert_table.html#pgr-create-vert-table"><span>pgr_createVerticesTable</span></a> - to reconstruct the vertices table based on the source and target information.</li>
<li><a class="reference internal" href="../src/common/doc/functions/analyze_graph.html#pgr-analyze-graph"><span>pgr_analyzeGraph</span></a> - to analyze the edges and vertices of the edge table.</li>
<li><a class="reference internal" href="../src/common/doc/functions/analyze_oneway.html#pgr-analyze-oneway"><span>pgr_analyzeOneway</span></a> - to analyze directionality of the edges.</li>
<li><a class="reference internal" href="../src/common/doc/functions/node_network.html#pgr-node-network"><span>pgr_nodeNetwork</span></a> -to create nodes to a not noded edge table.</li>
</ul>
</div></blockquote>
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="routing-functions">
<h2>Routing functions<a class="headerlink" href="#routing-functions" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="../src/index.html#routing-functions"><span>Routing Functions</span></a></p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="../src/apsp_johnson/doc/index.html#pgr-apsp-johnson"><span>pgr_apspJohnson</span></a>- All Pairs Shortest Path, Johnson’s Algorithm</li>
<li><a class="reference internal" href="../src/apsp_warshall/doc/index.html#pgr-apsp-warshall"><span>pgr_apspWarshall</span></a> - All Pairs Shortest Path, Floyd-Warshall Algorithm</li>
<li><a class="reference internal" href="../src/astar/doc/index.html#pgr-astar"><span>pgr_astar</span></a> - Shortest Path A*</li>
<li><a class="reference internal" href="../src/bd_astar/doc/index.html#bd-astar"><span>pgr_bdAstar</span></a> - Bi-directional A* Shortest Path</li>
<li><a class="reference internal" href="../src/bd_dijkstra/doc/index.html#bd-dijkstra"><span>pgr_bdDijkstra</span></a> - Bi-directional Dijkstra Shortest Path</li>
<li><a class="reference internal" href="../src/dijkstra/doc/index.html#pgr-dijkstra"><span>pgr_dijkstra</span></a> - Shortest Path Dijkstra</li>
<li><a class="reference internal" href="../src/driving_distance/doc/index.html#pgr-driving-distance"><span>pgr_driving_distance</span></a> - Driving Distance</li>
<li><a class="reference internal" href="../src/kdijkstra/doc/index.html#pgr-kdijkstra"><span>pgr_kDijkstra</span></a> - Mutliple destination Shortest Path Dijkstra</li>
<li><a class="reference internal" href="../src/ksp/doc/index.html#pgr-ksp"><span>pgr_ksp</span></a> - K-Shortest Path</li>
<li><a class="reference internal" href="../src/trsp/doc/index.html#trsp"><span>pgr_trsp</span></a> - Turn Restriction Shortest Path (TRSP)</li>
<li><a class="reference internal" href="../src/tsp/doc/index.html#pgr-tsp"><span>pgr_tsp</span></a> - Traveling Sales Person</li>
</ul>
</div></blockquote>
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="pre-processing-or-post-processing-helping-functions">
<h2>Pre processing or post processing helping functions<a class="headerlink" href="#pre-processing-or-post-processing-helping-functions" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="../src/driving_distance/doc/index.html#pgr-driving-distance-post"><span>Driving Distance post-processing</span></a></p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="../src/driving_distance/doc/dd_alphashape.html#pgr-alphashape"><span>pgr_alphaShape</span></a> - Alpha shape computation</li>
<li><a class="reference internal" href="../src/driving_distance/doc/dd_points_as_polygon.html#pgr-points-as-polygon"><span>pgr_pointsAsPolygon</span></a> - Polygon around set of points</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="experimental-and-proposed-functions">
<h2>Experimental and Proposed functions<a class="headerlink" href="#experimental-and-proposed-functions" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt>This section contains new experimental or proposed signatures for any of the following sections:</dt>
<dd><ul class="first last simple">
<li>topology functions</li>
<li>routing functions</li>
<li>vehicle routing functions</li>
<li>pre / post procesing helper functions</li>
</ul>
</dd>
</dl>
<p>We are including them so that the pgRouting community can evaluate them before
including them as an official function of pgRouting.</p>
<p>Some of them are unsupported like the GSoC functions.</p>
</div>
<div class="section" id="experimental-functions-proposed-by-steve-woodbridge">
<h2>Experimental functions: Proposed by Steve Woodbridge<a class="headerlink" href="#experimental-functions-proposed-by-steve-woodbridge" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt><a class="reference internal" href="../src/common/doc/convenience/index.html#convenience-functions"><span>Convenience Functions</span></a></dt>
<dd><ul class="first last simple">
<li><a class="reference internal" href="../src/common/doc/convenience/point_to_edgenode.html#pgr-point-to-edgenode"><span>pgr_pointToEdgeNode</span></a> - convert a point geometry to a <code class="docutils literal"><span class="pre">vertex_id</span></code> based on closest edge.</li>
<li><a class="reference internal" href="../src/common/doc/convenience/flip_edges.html#pgr-flip-edges"><span>pgr_flipEdges</span></a> - flip the edges in an array of geometries so the connect end to end.</li>
<li><a class="reference internal" href="../src/common/doc/convenience/text_to_points.html#pgr-text-to-points"><span>pgr_textToPoints</span></a> - convert a string of <code class="docutils literal"><span class="pre">x,y;x,y;...</span></code> locations into point geometries.</li>
<li><a class="reference internal" href="../src/common/doc/convenience/points_to_vids.html#pgr-points-to-vids"><span>pgr_pointsToVids</span></a> - convert an array of point geometries into vertex ids.</li>
<li><a class="reference internal" href="../src/common/doc/convenience/points_to_dmatrix.html#pgr-points-to-dmatrix"><span>pgr_pointsToDMatrix</span></a> - Create a distance matrix from an array of points.</li>
<li><a class="reference internal" href="../src/common/doc/convenience/vids_to_dmatrix.html#pgr-vids-to-dmatrix"><span>pgr_vidsToDMatrix</span></a> - Create a distance matrix from an array of <code class="docutils literal"><span class="pre">vertix_id</span></code>.</li>
<li><a class="reference internal" href="../src/common/doc/convenience/vids_to_dmatrix2.html#pgr-vids-to-dmatrix2"><span>pgr_vidsToDMatrix</span></a> - Create a distance matrix from an array of <code class="docutils literal"><span class="pre">vertix_id</span></code>.</li>
</ul>
</dd>
</dl>
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="experimental-functions-by-gsoc">
<h2>Experimental functions: by GSoC<a class="headerlink" href="#experimental-functions-by-gsoc" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt>The following functions are experimental</dt>
<dd><ul class="first simple">
<li>They may lack documentation,</li>
<li>Were created by GSoC students.</li>
<li>they are unsupported.</li>
</ul>
<blockquote class="last">
<div><ul class="simple">
<li><a class="reference internal" href="../src/vrp_basic/doc/index.html#pgr-vrp-basic"><span>pgr_vrpOneDepot</span></a> - VRP One Depot</li>
<li><a class="reference internal" href="../src/vrppdtw/doc/index.html#pgr-gsocvrppdtw"><span>pgr_vrppdtw - Pickup and Delivery problem</span></a> - Pickup and Delivery problem</li>
</ul>
</div></blockquote>
</dd>
</dl>
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="proposed-functions-proposed-by-zia-mohammed">
<h2>Proposed functions: Proposed by Zia Mohammed<a class="headerlink" href="#proposed-functions-proposed-by-zia-mohammed" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt>About this proposal:</dt>
<dd><ul class="first last simple">
<li>Author: Zia Mohammed.</li>
<li>Status: Needs a lot of testing. I am working on that.</li>
<li>I did not add automated test.</li>
<li>Temporary name: pgr_labelGraph</li>
<li>Need: I need feedback from the community.</li>
<li><a class="reference internal" href="../src/label_graph/doc/analyze_brokengraph.html#pgr-labelgraph"><span>pgr_labelGraph</span></a> - Analyze / label subgraphs within a network</li>
</ul>
</dd>
</dl>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="discontinued-functions">
<h2>Discontinued Functions<a class="headerlink" href="#discontinued-functions" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="src/developer/discontinued.html">Discontinued Functions</a></li>
</ul>
</div>
</div>
<div class="section" id="developer">
<h2>Developer<a class="headerlink" href="#developer" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="../src/common/doc/utilities/index.html#developer-functions"><span>Developers’s Functions</span></a></p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">In V3.0 This function are going to be discontinued. Use the already available underscored version instead.</p>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last"><a class="reference internal" href="../src/common/doc/utilities/index.html#developer-functions"><span>Developers’s Functions</span></a> documentation is going to be deleted from the pgRouting documentation in V3.0</p>
</div>
<dl class="docutils">
<dt>The following functions are used internaly the topology functions.</dt>
<dd><ul class="first last simple">
<li><a class="reference internal" href="../src/common/doc/utilities/get_column_name.html#pgr-get-column-name"><span>pgr_getColumnName</span></a> - to get the name of the column as is stored in the postgres administration tables.</li>
<li><a class="reference internal" href="../src/common/doc/utilities/get_table_name.html#pgr-get-table-name"><span>pgr_getTableName</span></a> - to retrieve the name of the table as is stored in the postgres administration tables.</li>
<li><a class="reference internal" href="../src/common/doc/utilities/is_column_indexed.html#pgr-is-column-indexed"><span>pgr_isColumnIndexed</span></a> - to check if the column is indexed.</li>
<li><a class="reference internal" href="../src/common/doc/utilities/is_column_in_table.html#pgr-is-column-in-table"><span>pgr_isColumnInTable</span></a> - to check only for the existance of the column.</li>
<li><a class="reference internal" href="../src/common/doc/utilities/point_to_id.html#pgr-point-to-id"><span>pgr_pointToId</span></a> -to insert/get the id of the inserted point in a vertices table.</li>
<li><a class="reference internal" href="../src/common/doc/utilities/quote_ident.html#pgr-quote-ident"><span>pgr_quote_ident</span></a> - to quotes the input text to be used as an identifier in an SQL statement string.</li>
<li><a class="reference internal" href="../src/common/doc/utilities/versionless.html#pgr-versionless"><span>pgr_versionless</span></a> - to compare two version numbers.</li>
<li><a class="reference internal" href="../src/common/doc/utilities/start_point.html#pgr-start-point"><span>pgr_startPoint</span></a> - to get the start point of a (multi)linestring.</li>
<li><a class="reference internal" href="../src/common/doc/utilities/end_point.html#pgr-end-point"><span>pgr_endPoint</span></a> - to get the end point of a (multi)linestring.</li>
</ul>
</dd>
</dl>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="src/developer/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="src/developer/index.html#source-tree-layout">Source Tree Layout</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/developer/index.html#tools">Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/developer/index.html#documentation-layout">Documentation Layout</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/developer/index.html#testing-infrastructure">Testing Infrastructure</a></li>
</ul>
</li>
</ul>
</div>
<p><a class="reference internal" href="src/changelog/index.html#change-log"><span>Release Notes</span></a></p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="src/changelog/2_1_0.html#changelog-2-1-0"><span>pgRouting 2.1.0 Release Notes</span></a></li>
<li><a class="reference internal" href="src/changelog/2_0.html#changelog-2-0"><span>pgRouting 2.0 Release Notes</span></a></li>
<li><a class="reference internal" href="src/changelog/1_x.html#changelog-1-x"><span>pgRouting 1.x Release Notes</span></a></li>
</ul>
</div></blockquote>
<div class="toctree-wrapper compound">
</div>
<p class="rubric">Indices and tables</p>
<ul class="simple">
<li><a class="reference internal" href="../genindex.html"><span>Index</span></a></li>
<li><a class="reference internal" href="../search.html"><span>Search Page</span></a></li>
</ul>
</div>
</div>
</div>
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
<p>
<a class="uplink" href="#">Contents</a>
  ::  
<a href="src/introduction/introduction.html">Introduction</a>  »
</p>
</div>
<div class="footer" role="contentinfo">
© Copyright pgRouting Contributors - Version 2.1.0 (b38118a master).
Last updated on Feb 05, 2016.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
</div>
</body>
</html>
|