Commit in lcsim/src/org/lcsim/util/swim on MAIN
Trajectory.java+7-51.5 -> 1.6
Line.java+7-51.5 -> 1.6
+14-10
2 modified files
Resolve interface vs. implementation inconsistency in org.lcsim.util.swim.Trajectory.getDistanceToPoint() by updating comments and changing Line to do what the new comments say.
lcsim/src/org/lcsim/util/swim
Trajectory.java 1.5 -> 1.6
diff -u -r1.5 -r1.6
--- Trajectory.java	26 Aug 2005 21:02:26 -0000	1.5
+++ Trajectory.java	28 Sep 2005 22:39:57 -0000	1.6
@@ -5,7 +5,7 @@

 /**
  * A particle trajectory (either a Helix or a Line)
  * @author tonyj

- * @version $Id: Trajectory.java,v 1.5 2005/08/26 21:02:26 jstrube Exp $

+ * @version $Id: Trajectory.java,v 1.6 2005/09/28 22:39:57 mcharles Exp $

  */
 public interface Trajectory
 {

@@ -27,10 +27,12 @@

     */
    public double getDistanceToZPlane(double z);
    

-   /**
-    * Calculates the shortest distance of a point to the trajectory
-    * @param point The point in space
-    * @return the distance of closest approach in mm

+  /**
+    * Obtain the point of closest approach (POCA)
+    * of the trajectory to a point. The return value is the distance
+    * parameter s, such that getPointAtDistance(s) is the POCA.
+    * @param point Point in space to swim to
+    * @return The length parameter s

     */
    // FIXME this should be a point rather than a vector
    public double getDistanceToPoint(Hep3Vector point);
lcsim/src/org/lcsim/util/swim
Line.java 1.5 -> 1.6
diff -u -r1.5 -r1.6
--- Line.java	22 Sep 2005 19:16:37 -0000	1.5
+++ Line.java	28 Sep 2005 22:39:57 -0000	1.6
@@ -7,7 +7,7 @@

 /**
  * A straight line
  * @author tonyj

- * @version $Id: Line.java,v 1.5 2005/09/22 19:16:37 mcharles Exp $

+ * @version $Id: Line.java,v 1.6 2005/09/28 22:39:57 mcharles Exp $

  */
 public class Line implements Trajectory
 {

@@ -90,12 +90,14 @@

    }
    
    /**

-    * Calculates the shortest distance of a point to the trajectory
-    * @param point The point in space
-    * @return the distance of closest approach in mm

+    * Obtain the point of closest approach (POCA)
+    * of the line to a point. The return value is the distance
+    * parameter s, such that getPointAtDistance(s) is the POCA.
+    * @param point Point in space to swim to
+    * @return The length parameter s

     */
    public double getDistanceToPoint(Hep3Vector point) {

-       return findDOCAToPoint(point);

+       return findPOCAToPoint(point);

    }
 
    /**
CVSspam 0.2.8