Skip to content

Commit 00943d4

Browse files
committed
Javadoc
1 parent bf54bea commit 00943d4

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

modules/core/src/main/java/org/locationtech/jts/algorithm/distance/DiscreteHausdorffDistance.java

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@
3232
* <p>
3333
* This algorithm is an approximation to the standard Hausdorff distance.
3434
* Specifically,
35-
* <pre>
36-
* for all geometries a, b: DHD(a, b) &lt;= HD(a, b)
37-
* </pre>
35+
* <blockquote>
36+
* <i>for all geometries A, B: DHD(A, B) &lt;= HD(A, B)</i>
37+
* </blockquote>
3838
* The approximation can be made as close as needed by densifying the input geometries.
3939
* In the limit, this value will approach the true Hausdorff distance:
40-
* <pre>
41-
* DHD(A, B, densifyFactor) -&gt; HD(A, B) as densifyFactor -&gt; 0.0
42-
* </pre>
40+
* <blockquote>
41+
* <i>DHD(A, B, densifyFactor) &rarr; HD(A, B) as densifyFactor &rarr; 0.0</i>
42+
* </blockquote>
4343
* The default approximation is exact or close enough for a large subset of useful cases.
4444
* Examples of these are:
4545
* <ul>
@@ -57,6 +57,13 @@
5757
* </pre>
5858
* The class can compute the oriented Hausdorff distance from A to B.
5959
* This computes the distance to the farthest point on A from B.
60+
* <blockquote>
61+
* <i>OHD(A, B) = max<sub>a &isin; A</sub>( Distance(a, B) )</i>
62+
* <br>
63+
* with
64+
* <br>
65+
* <i>HD(A, B) = max( OHD(A, B), OHD(B, A) )</i>
66+
* </blockquote>
6067
* A use case is to test whether a geometry A lies completely within a given
6168
* distance of another one B.
6269
* This is more efficient than testing whether A is covered by a buffer of B.

0 commit comments

Comments
 (0)