boost_mirror/geometry
1
0
Fork 0
mirror of https://github.com/boostorg/geometry.git synced 2025-05-09 23:24:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

[doc] Explain output range of azimuth algorithm.

Browse Source
This commit is contained in:
Vissarion Fisikopoulos 2022-11-21 21:41:17 +02:00
parent e933682d1c
commit e06b6ff923
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/html/index.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Chapter 1. Geometry</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Chapter 1. Geometry">
<link rel="next" href="geometry/introduction.html" title="Introduction">
</head>
@ -150,7 +150,7 @@
</ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><p><small>Last revised: July 28, 2022 at 11:11:09 GMT</small></p></td>
<td align="left"><p><small>Last revised: November 21, 2022 at 15:41:14 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

7
doc/reference/algorithms/azimuth.qbk
View File

@ -12,11 +12,12 @@
[def __this_function__ azimuth]
[heading_conformance_no_ogc __this_function__]
[note PostGIS contains an algorithm ST_Azimuth with the same functionality.
See the [@https://postgis.net/docs/ST_Azimuth.html PostGIS documentation].
[note PostGIS contains an algorithm ST_Azimuth with the same functionality but could return different
results e.g. result normalized to range 0 to pi instead of range -pi to pi.
See the [@https://postgis.net/docs/ST_Azimuth.html PostGIS documentation].
]
[heading Behavior]
The algorithm calculates the azimuth of a segment defined by a pair of points.
[note The result is in radians.]
[note The result is in the range -pi to pi radians.]