annotate flys-artifacts/src/main/java/de/intevation/flys/artifacts/math/Distance.java @ 4118:116464587b51

Documentation.
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Fri, 12 Oct 2012 15:14:29 +0200
parents 229e9b27ce15
children
rev   line source
3246
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
1 package de.intevation.flys.artifacts.math;
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
2
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
3 /** Helper to calculate distance(s). */
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
4 public final class Distance {
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
5 /** Return distance between two values. */
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
6 public static double distance(double a, double b) {
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
7 return Math.abs(a - b);
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
8 }
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
9
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
10 /** Return whether a and be are within a certain distance. */
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
11 public static boolean within(double a, double b, double threshold) {
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
12 return distance(a, b) <= threshold;
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
13 }
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
14 }
229e9b27ce15 New Distance helper module.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
15 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org