Remove trailing spaces, added missing javadoc tags.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1393153 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Thomas Neidhart 2012-10-02 20:15:00 +00:00
parent 3b5d0dd52c
commit 8eb3bbaca4
2 changed files with 14 additions and 10 deletions

View File

@ -264,10 +264,10 @@ public class Line implements Hyperplane<Euclidean2D>, Embedding<Euclidean2D, Euc
}
/** Compute the distance between the instance and a point.
* This is a shortcut for invoking FastMath.abs(getOffset(p)),
* and provides consistency with what is in the
* org.apache.commons.math3.geometry.euclidean.threed.Line class.
*
* <p>This is a shortcut for invoking FastMath.abs(getOffset(p)),
* and provides consistency with what is in the
* org.apache.commons.math3.geometry.euclidean.threed.Line class.</p>
*
* @param p to check
* @return distance between the instance and the point
*/

View File

@ -65,15 +65,19 @@ public class Segment {
return line;
}
/**
* Calculates the shortest distance from a point to this line segment.
/** Calculates the shortest distance from a point to this line segment.
* <p>
* If the perpendicular extension from the point to the line does not
* cross in the bounds of the line segment, the shortest distance to
* If the perpendicular extension from the point to the line does not
* cross in the bounds of the line segment, the shortest distance to
* the two end points will be returned.
* </p>
*
* Algorithm adapted from: http://www.codeguru.com/forum/printthread.php?s=cc8cf0596231f9a7dba4da6e77c29db3&t=194400&pp=15&page=1
*
* Algorithm adapted from:
* <a href="http://www.codeguru.com/forum/printthread.php?s=cc8cf0596231f9a7dba4da6e77c29db3&t=194400&pp=15&page=1">
* Thread @ Codeguru</a>
*
* @param p to check
* @return distance between the instance and the point
*/
public double distance(final Vector2D p) {
final double deltaX = end.getX() - start.getX();