Update comments for release 1.0b5

florianlaws · Jun 21, 2010 · 1536d5a · 1536d5a
1 parent 73c0125
commit 1536d5a
Show file tree

Hide file tree

Showing 55 changed files with 230 additions and 199 deletions.
diff --git a/build.xml b/build.xml
@@ -5,7 +5,7 @@
 <project name="JSI build" default="all" basedir=".">
 
   <!-- version number -->
-  <property name="version" value="1.0b5-DEV"/>
+  <property name="version" value="1.0b5"/>
 
   <!-- library includes -->
   <property name="lib.dir" value="${basedir}/jsi/lib"/>

diff --git a/jsi/doc/BUILD.txt b/jsi/doc/BUILD.txt
@@ -3,7 +3,8 @@ To build the JSI library from source, install Ant and run the following:
 % cd <location-of-build.xml>
 % ant all
 
-This will generate two jar files; jsi/jar/jsi-1.0b5-DEV.jar and jsi/jar/jsi-test-1.0b5-DEV.jar. The second is only required for running tests, and is not needed for production use.
+This will generate two jar files; jsi/jar/jsi-1.0b5.jar and jsi/jar/jsi-test-1.0b5.jar. 
+The second is only required for running tests, and is not needed for production use.
 
 
 
diff --git a/jsi/doc/README.txt b/jsi/doc/README.txt
@@ -1,14 +1,14 @@
 This release contains the following directories/files:
-
-jsi-1.0b5-DEV/jsi/src          - source code to the JSI library. Test code is in 
-                                 the com.infomatiq.jsi.test package.
-jsi-1.0b5-DEV/jsi/bin          - compiled version of jsi/src
-jsi-1.0b5-DEV/jsi/lib          - the log4j-1.2.6 and trove-2.02 libraries are 
-                                 required by the JSI library. The junit-3.7.0 and
-                                 sil-0.44.2b libraries are only required by the 
-                                 test code.
-jsi-1.0b5-DEV/jsi/tests        - test scripts
-jsi-1.0b5-DEV/jsi/test-results - test results will be placed here
-jsi-1.0b5-DEV/jsi/doc          - documentation
-jsi-1.0b5-DEV/jsi/doc/javadoc  - javadoc documentation
-jsi-1.0b5-DEV/build.xml        - ANT build script. See BUILD.txt.
+
+jsi-1.0b5/jsi/src          - source code to the JSI library. Test code is in 
+                             the com.infomatiq.jsi.test package.
+jsi-1.0b5/jsi/bin          - compiled version of jsi/src
+jsi-1.0b5/jsi/lib          - the log4j-1.2.6 and trove-2.02 libraries are 
+                             required by the JSI library. The junit-3.7.0 and
+                             sil-0.44.2b libraries are only required by the 
+                             test code.
+jsi-1.0b5/jsi/tests        - test scripts
+jsi-1.0b5/jsi/test-results - test results will be placed here
+jsi-1.0b5/jsi/doc          - documentation
+jsi-1.0b5/jsi/doc/javadoc  - javadoc documentation
+jsi-1.0b5/jsi/build.xml    - ANT build script. See BUILD.txt.
diff --git a/jsi/doc/TEST.txt b/jsi/doc/TEST.txt
@@ -4,7 +4,7 @@ Note this will take a very long time to run:
 1. Make sure the java executable is in the path.
 2. Extract the zip file into a directory of your choice, eg /home/fred
 3. 'cd' into the 'jsi' directory created in the previous step; 
-   eg /home/fred/jsi-1.0b5-DEV/jsi
+   eg /home/fred/jsi-1.0b5/jsi
 4. Generate reference test results
      [Linux]
      java -classpath bin:lib/log4j-1.2.6.jar:lib/junit-3.7.0.jar:lib/trove-2.0.2.jar:lib/sil-0.44.2b.jar junit.textui.TestRunner com.infomatiq.jsi.test.ReferenceGenerateTest

diff --git a/jsi/doc/javadoc/allclasses-frame.html b/jsi/doc/javadoc/allclasses-frame.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:45 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:30 BST 2010 -->
 <TITLE>
 All Classes
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
 

diff --git a/jsi/doc/javadoc/allclasses-noframe.html b/jsi/doc/javadoc/allclasses-noframe.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:45 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:30 BST 2010 -->
 <TITLE>
 All Classes
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
 

diff --git a/jsi/doc/javadoc/com/infomatiq/jsi/Point.html b/jsi/doc/javadoc/com/infomatiq/jsi/Point.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:44 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:28 BST 2010 -->
 <TITLE>
 Point
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
 
@@ -107,7 +107,7 @@ <H2>
 <P>
 <DL>
 <DT><B>Version:</B></DT>
-  <DD>1.0b5-DEV</DD>
+  <DD>1.0b5</DD>
 <DT><B>Author:</B></DT>
   <DD>[email protected]</DD>
 </DL>

diff --git a/jsi/doc/javadoc/com/infomatiq/jsi/PriorityQueue.html b/jsi/doc/javadoc/com/infomatiq/jsi/PriorityQueue.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:44 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:29 BST 2010 -->
 <TITLE>
 PriorityQueue
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
 
@@ -101,12 +101,15 @@ <H2>
 </PRE>
 
 <P>
-Priority Queue that stores values as ints and priorities as floats. Uses a
+<p>
+ Priority Queue that stores values as ints and priorities as floats. Uses a
  Heap to sort the priorities; the values are sorted "in step" with the
  priorities.
-
+ </p>
+ <p>
  A Heap is simply an array that is kept semi sorted; in particular if the
  elements of the array are arranged in a tree structure; ie
+ </p>
 
                                    00 
                                  /     \ 
@@ -116,31 +119,37 @@ <H2>
                           /\    /\    /\    /\ 
                         07 08 09 10 11 12 13 14
 
+ <p>
  then each parent is kept sorted with respect to it's immediate children. E.g.
  00 < 01, 00 < 02, 02 < 05, 02 < 06
-
+ </p>
+ <p>
  This means that the array appears to be sorted, as long as we only ever look
  at element 0.
-
+ </p>
+ <p>
  Inserting new elements is much faster than if the entire array was kept
  sorted; a new element is appended to the array, and then recursively swapped
  with each parent to maintain the "parent is sorted w.r.t it's children"
  property.
-
+ </p>
+ <p>
  To return the "next" value it is necessary to remove the root element. The
  last element in the array is placed in the root of the tree, and is
  recursively swapped with one of it's children until the "parent is sorted
  w.r.t it's children" property is restored.
-
+ </p>
+ <p>
  Random access is slow (eg for deleting a particular value), and is not
  implemented here - if this functionality is required, then a heap probably
  isn't the right data structure.
+ </p>
 <P>
 
 <P>
 <DL>
 <DT><B>Version:</B></DT>
-  <DD>1.0b5-DEV</DD>
+  <DD>1.0b5</DD>
 <DT><B>Author:</B></DT>
   <DD>Aled Morris <aled@sourceforge.net></DD>
 </DL>

diff --git a/jsi/doc/javadoc/com/infomatiq/jsi/Rectangle.html b/jsi/doc/javadoc/com/infomatiq/jsi/Rectangle.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:44 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:29 BST 2010 -->
 <TITLE>
 Rectangle
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
 
@@ -107,7 +107,7 @@ <H2>
 <P>
 <DL>
 <DT><B>Version:</B></DT>
-  <DD>1.0b5-DEV</DD>
+  <DD>1.0b5</DD>
 <DT><B>Author:</B></DT>
   <DD>[email protected]</DD>
 </DL>

diff --git a/jsi/doc/javadoc/com/infomatiq/jsi/SpatialIndex.html b/jsi/doc/javadoc/com/infomatiq/jsi/SpatialIndex.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:45 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:29 BST 2010 -->
 <TITLE>
 SpatialIndex
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
 
@@ -107,7 +107,7 @@ <H2>
 <P>
 <DL>
 <DT><B>Version:</B></DT>
-  <DD>1.0b5-DEV</DD>
+  <DD>1.0b5</DD>
 <DT><B>Author:</B></DT>
   <DD>[email protected]</DD>
 </DL>
@@ -361,7 +361,7 @@ <H2>
                       float&nbsp;distance)</PRE>
 <DL>
 <DD>Same as nearestN, except the found rectangles are not returned
- in sorted order. This may be faster, depending on the implementation.
+ in sorted order. This will be faster, if sorting is not required
 <P>
 <DD><DL>
 </DL>

diff --git a/jsi/doc/javadoc/com/infomatiq/jsi/class-use/Point.html b/jsi/doc/javadoc/com/infomatiq/jsi/class-use/Point.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:45 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:30 BST 2010 -->
 <TITLE>
 Uses of Class com.infomatiq.jsi.Point
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
 
@@ -239,7 +239,7 @@ <H2>
          float&nbsp;furthestDistance)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Second alternative implementation of NearestN.</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -250,7 +250,7 @@ <H2>
                  float&nbsp;furthestDistance)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;New implementation of nearestN.</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 </TR>
 </TABLE>
 &nbsp;

diff --git a/jsi/doc/javadoc/com/infomatiq/jsi/class-use/PriorityQueue.html b/jsi/doc/javadoc/com/infomatiq/jsi/class-use/PriorityQueue.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:45 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:30 BST 2010 -->
 <TITLE>
 Uses of Class com.infomatiq.jsi.PriorityQueue
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
 

diff --git a/jsi/doc/javadoc/com/infomatiq/jsi/class-use/Rectangle.html b/jsi/doc/javadoc/com/infomatiq/jsi/class-use/Rectangle.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:45 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:30 BST 2010 -->
 <TITLE>
 Uses of Class com.infomatiq.jsi.Rectangle
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
 

diff --git a/jsi/doc/javadoc/com/infomatiq/jsi/class-use/SpatialIndex.html b/jsi/doc/javadoc/com/infomatiq/jsi/class-use/SpatialIndex.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:45 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:30 BST 2010 -->
 <TITLE>
 Uses of Interface com.infomatiq.jsi.SpatialIndex
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
 

diff --git a/jsi/doc/javadoc/com/infomatiq/jsi/package-frame.html b/jsi/doc/javadoc/com/infomatiq/jsi/package-frame.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:45 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:29 BST 2010 -->
 <TITLE>
 com.infomatiq.jsi
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
 

diff --git a/jsi/doc/javadoc/com/infomatiq/jsi/package-summary.html b/jsi/doc/javadoc/com/infomatiq/jsi/package-summary.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:45 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:29 BST 2010 -->
 <TITLE>
 com.infomatiq.jsi
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
 
@@ -109,7 +109,8 @@ <H2>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD WIDTH="15%"><B><A HREF="../../../com/infomatiq/jsi/PriorityQueue.html" title="class in com.infomatiq.jsi">PriorityQueue</A></B></TD>
-<TD>Priority Queue that stores values as ints and priorities as floats.</TD>
+<TD>
+ Priority Queue that stores values as ints and priorities as floats.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD WIDTH="15%"><B><A HREF="../../../com/infomatiq/jsi/Rectangle.html" title="class in com.infomatiq.jsi">Rectangle</A></B></TD>

diff --git a/jsi/doc/javadoc/com/infomatiq/jsi/package-tree.html b/jsi/doc/javadoc/com/infomatiq/jsi/package-tree.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:45 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:29 BST 2010 -->
 <TITLE>
 com.infomatiq.jsi Class Hierarchy
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
 

diff --git a/jsi/doc/javadoc/com/infomatiq/jsi/package-use.html b/jsi/doc/javadoc/com/infomatiq/jsi/package-use.html
@@ -2,12 +2,12 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Sat Jun 05 09:23:45 BST 2010 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Mon Jun 21 21:33:30 BST 2010 -->
 <TITLE>
 Uses of Package com.infomatiq.jsi
 </TITLE>
 
-<META NAME="date" CONTENT="2010-06-05">
+<META NAME="date" CONTENT="2010-06-21">
 
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">