fixes documentation

tonydattolo · Jan 7, 2019 · d8d3258 · d8d3258
1 parent 4564f64
commit d8d3258
Show file tree

Hide file tree

Showing 13 changed files with 16 additions and 14 deletions.
diff --git a/src/main/java/edu/princeton/cs/algs4/BinaryDump.java b/src/main/java/edu/princeton/cs/algs4/BinaryDump.java
@@ -1,10 +1,10 @@
 /******************************************************************************
  *  Compilation:  javac BinaryDump.java
- *  Execution:    java BinaryDump N < file
+ *  Execution:    java BinaryDump n < file
  *  Dependencies: BinaryStdIn.java
- *  Data file:    http://introcs.cs.princeton.edu/stdlib/abra.txt
+ *  Data file:    https://introcs.cs.princeton.edu/stdlib/abra.txt
  *  
- *  Reads in a binary file and writes out the bits, N per line.
+ *  Reads in a binary file and writes out the bits, n per line.
  *
  *  % more abra.txt 
  *  ABRACADABRA!
@@ -30,7 +30,7 @@
  *  {@code od} (octal dump) and {@code hexdump} (hexadecimal dump).
  *  <p>
  *  For additional documentation,
- *  see <a href="https://algs4.cs.princeton.edu/55compress">Section 5.5</a> of
+ *  see <a href="https://algs4.cs.princeton.edu/55compression">Section 5.5</a> of
  *  <i>Algorithms, 4th Edition</i> by Robert Sedgewick and Kevin Wayne.
  *  <p>
  *  See also {@link HexDump} and {@link PictureDump}.

diff --git a/src/main/java/edu/princeton/cs/algs4/Draw.java b/src/main/java/edu/princeton/cs/algs4/Draw.java
@@ -296,6 +296,7 @@ private void init() {
         frame.setResizable(false);
         // frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);            // closes all windows
         frame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);      // closes only current window
+        frame.setFocusTraversalKeysEnabled(false);  // to recognize VK_TAB with isKeyPressed()
         frame.setTitle(name);
         frame.setJMenuBar(createMenuBar());
         frame.pack();

diff --git a/src/main/java/edu/princeton/cs/algs4/Genome.java b/src/main/java/edu/princeton/cs/algs4/Genome.java
@@ -22,7 +22,7 @@
  *  and expanding a genomic sequence using a 2-bit code.
  *  <p>
  *  For additional documentation,
- *  see <a href="https://algs4.cs.princeton.edu/55compress">Section 5.5</a> of
+ *  see <a href="https://algs4.cs.princeton.edu/55compression">Section 5.5</a> of
  *  <i>Algorithms, 4th Edition</i> by Robert Sedgewick and Kevin Wayne.
  *
  *  @author Robert Sedgewick

diff --git a/src/main/java/edu/princeton/cs/algs4/HexDump.java b/src/main/java/edu/princeton/cs/algs4/HexDump.java
@@ -31,7 +31,7 @@
  *  of a binary file in hexadecimal.
  *  <p>
  *  For additional documentation,
- *  see <a href="https://algs4.cs.princeton.edu/55compress">Section 5.5</a> of
+ *  see <a href="https://algs4.cs.princeton.edu/55compression">Section 5.5</a> of
  *  <i>Algorithms, 4th Edition</i> by Robert Sedgewick and Kevin Wayne.
  *  <p>
  *  See also {@link BinaryDump} and {@link PictureDump}.

diff --git a/src/main/java/edu/princeton/cs/algs4/Huffman.java b/src/main/java/edu/princeton/cs/algs4/Huffman.java
@@ -28,7 +28,7 @@
  *  ASCII alphabet.
  *  <p>
  *  For additional documentation,
- *  see <a href="https://algs4.cs.princeton.edu/55compress">Section 5.5</a> of
+ *  see <a href="https://algs4.cs.princeton.edu/55compression">Section 5.5</a> of
  *  <i>Algorithms, 4th Edition</i> by Robert Sedgewick and Kevin Wayne.
  *
  *  @author Robert Sedgewick

diff --git a/src/main/java/edu/princeton/cs/algs4/IndexMaxPQ.java b/src/main/java/edu/princeton/cs/algs4/IndexMaxPQ.java
@@ -30,7 +30,7 @@
  *  <em>change-key</em>, <em>decrease-key</em>, and <em>increase-key</em>
  *  operations take logarithmic time.
  *  The <em>is-empty</em>, <em>size</em>, <em>max-index</em>, <em>max-key</em>,
- *  and <em>key-of</em> operations take constant time.
+ *  <em>contains</em>, and <em>key-of</em> operations take constant time.
  *  Construction takes time proportional to the specified capacity.
  *  <p>
  *  For additional documentation, see <a href="https://algs4.cs.princeton.edu/24pq">Section 2.4</a> of

diff --git a/src/main/java/edu/princeton/cs/algs4/IndexMinPQ.java b/src/main/java/edu/princeton/cs/algs4/IndexMinPQ.java
@@ -30,7 +30,7 @@
  *  <em>change-key</em>, <em>decrease-key</em>, and <em>increase-key</em>
  *  operations take logarithmic time.
  *  The <em>is-empty</em>, <em>size</em>, <em>min-index</em>, <em>min-key</em>,
- *  and <em>key-of</em> operations take constant time.
+ *  <em>contains</em>, and <em>key-of</em> operations take constant time.
  *  Construction takes time proportional to the specified capacity.
  *  <p>
  *  For additional documentation, see <a href="https://algs4.cs.princeton.edu/24pq">Section 2.4</a> of

diff --git a/src/main/java/edu/princeton/cs/algs4/KruskalMST.java b/src/main/java/edu/princeton/cs/algs4/KruskalMST.java
@@ -1,7 +1,7 @@
 /******************************************************************************
  *  Compilation:  javac KruskalMST.java
  *  Execution:    java  KruskalMST filename.txt
- *  Dependencies: EdgeWeightedGraph.java Edge.java Queue.java
+ *  Dependencies: EdgeWeightedGraph.java Edge.java Queue.java MinPQ.java
  *                UF.java In.java StdOut.java
  *  Data files:   https://algs4.cs.princeton.edu/43mst/tinyEWG.txt
  *                https://algs4.cs.princeton.edu/43mst/mediumEWG.txt

diff --git a/src/main/java/edu/princeton/cs/algs4/LZW.java b/src/main/java/edu/princeton/cs/algs4/LZW.java
@@ -26,7 +26,7 @@
  *  ASCII alphabet with 12-bit codewords.
  *  <p>
  *  For additional documentation,
- *  see <a href="https://algs4.cs.princeton.edu/55compress">Section 5.5</a> of
+ *  see <a href="https://algs4.cs.princeton.edu/55compression">Section 5.5</a> of
  *  <i>Algorithms, 4th Edition</i> by Robert Sedgewick and Kevin Wayne.
  *
  *  @author Robert Sedgewick  

diff --git a/src/main/java/edu/princeton/cs/algs4/PictureDump.java b/src/main/java/edu/princeton/cs/algs4/PictureDump.java
@@ -24,7 +24,7 @@
  *  of a binary file as a black-and-white picture.
  *  <p>
  *  For additional documentation,
- *  see <a href="https://algs4.cs.princeton.edu/55compress">Section 5.5</a> of
+ *  see <a href="https://algs4.cs.princeton.edu/55compression">Section 5.5</a> of
  *  <i>Algorithms, 4th Edition</i> by Robert Sedgewick and Kevin Wayne.
  *  <p>
  *  See also {@link BinaryDump} and {@link HexDump}.

diff --git a/src/main/java/edu/princeton/cs/algs4/RunLength.java b/src/main/java/edu/princeton/cs/algs4/RunLength.java
@@ -30,7 +30,7 @@
  *  run lengths.
  *  <p>
  *  For additional documentation,
- *  see <a href="https://algs4.cs.princeton.edu/55compress">Section 5.5</a> of
+ *  see <a href="https://algs4.cs.princeton.edu/55compression">Section 5.5</a> of
  *  <i>Algorithms, 4th Edition</i> by Robert Sedgewick and Kevin Wayne.
  *
  *  @author Robert Sedgewick

diff --git a/src/main/java/edu/princeton/cs/algs4/StdDraw.java b/src/main/java/edu/princeton/cs/algs4/StdDraw.java
@@ -699,6 +699,7 @@ private static void init() {
 
         frame.setContentPane(draw);
         frame.addKeyListener(std);    // JLabel cannot get keyboard focus
+        frame.setFocusTraversalKeysEnabled(false);  // allow VK_TAB with isKeyPressed()
         frame.setResizable(false);
         frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);            // closes all windows
         // frame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);      // closes only current window

diff --git a/src/main/java/edu/princeton/cs/algs4/StdRandom.java b/src/main/java/edu/princeton/cs/algs4/StdRandom.java
@@ -355,7 +355,7 @@ public static double cauchy() {
      */
     public static int discrete(double[] probabilities) {
         if (probabilities == null) throw new IllegalArgumentException("argument array is null");
-        double EPSILON = 1E-14;
+        double EPSILON = 1.0E-14;
         double sum = 0.0;
         for (int i = 0; i < probabilities.length; i++) {
             if (!(probabilities[i] >= 0.0))