working with build scripts

Author: heineman

Code/Chapter3/example3-3/sample.c

@@ -1,5 +1,5 @@
 /**
- * @file Memory/sample.c    Program to show addresses in memory
+ * @file sample.c    Program to show addresses in memory
  * @brief 
  *    Small program to show internal memory addresses.
  * 

Code/Clock/tableA-6.c

@@ -1,5 +1,5 @@
 /**
- * @file Clock/sample.c   Show timing example in both milliseconds and nanonseconds.
+ * @file Clock/tableA-6.c   Show timing example in both milliseconds and nanonseconds.
  * @brief 
  *   Show the ability on Unix systems to time both using milliseconds and
  *   nanosecond timers.

Code/Doxyfile

@@ -31,7 +31,7 @@ PROJECT_NAME           = Algorithms_in_a_Nutshell
 # This could be handy for archiving the generated documentation or 
 # if some version control system is used.
 
-PROJECT_NUMBER         = 1.0
+PROJECT_NUMBER         = 2.0
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 

Code/Graph/MinimumSpanningTree/mst_slow.cxx

@@ -1,5 +1,5 @@
 /**
- * @file mst.cxx    Prim's Algorithm for Minimum Spanning Tree problem
+ * @file mst_slow.cxx    Prim's Algorithm for Minimum Spanning Tree problem
  * @brief 
  *
  *   Defines the implementation using Prim's Algorithm to minimum spanning

Code/Graph/MinimumSpanningTree/msttsp.c

@@ -1,5 +1,5 @@
 /**
- * @file tsplib.c   Test driver code that understands TSP data formatn
+ * @file msttsp.c   Test driver code that understands TSP data formatn
  * @brief 
  *   Driver that can load up dense graphs whose input is stored using 
  *   the TSP format as recognized by the community.

Code/README

@@ -1,6 +1,6 @@
 This directory contains the C and C++ code solutions as coded in the
-O'Reilly book "Algorithm in a Nutshell" by George Heineman, Gary Pollice,
-and Stanley Selkow, (C) 2008.
+O'Reilly book "Algorithm in a Nutshell", Second Edition, by George
+Heineman, Gary Pollice, and Stanley Selkow, (C) 2016.
 
 INSTALLATION
 
@@ -16,6 +16,10 @@ BUILD
 
   To build, type 'make' in this top-level directory.
 
+DOCUMENTATION
+
+  To build the Doxygen documentation, type 'make doxygen'
+
 TEST
 
   To test all available test cases, type 'make test' in this top-level

Code/Sorting/Ints/modifiedQsort.c

@@ -1,5 +1,5 @@
 /**
- * @file modifiedQsort.c
+ * @file Ints/modifiedQsort.c
  * @brief
  *
  *    Find crossover where InsertionSort is slower than FullQsort using

Code/Sorting/Ints/testSmallArrays.c

@@ -88,8 +88,9 @@ void insertion (int *ar, int low, int high) {
  * Inline code using macro to set value
  * 
  * \param vals    the array of elements.
- * \param left    the left end of the subarray range
- * \param right   the right end of the subarray range
+ * \param left    the left end of the subarray range.
+ * \param right   the right end of the subarray range.
+ * \param pivot   variable for pivot.
  * \return        int in the range [left, right] to use in partition.
  */
 #define selectPivotIndex(vals,left,right,pivot)\

Code/Sorting/Ints/timeSmallArrays.c

@@ -104,8 +104,9 @@ void insertion (int *ar, int low, int high) {
  * Inline code using macro to set value
  * 
  * \param vals    the array of elements.
- * \param left    the left end of the subarray range
- * \param right   the right end of the subarray range
+ * \param left    the left end of the subarray range.
+ * \param right   the right end of the subarray range.
+ * \param pivot   variable to use for pivot.
  * \return        int in the range [left, right] to use in partition.
  */
 #define selectPivotIndex(vals,left,right,pivot)\

Code/Sorting/PointerBased/merge.c

@@ -1,5 +1,5 @@
 /**
- * @file merge.c   Merge Sort implementation
+ * @file PointerBased/merge.c   Merge Sort implementation
  * @brief 
  *   Contains Merge Sort implementation.
  *

Code/Sorting/PointerBased/parallelQsort.c

@@ -1,5 +1,5 @@
 /**
- * @file baseQsort.c   Multithread Quicksort implementation
+ * @file parallelQsort.c   Multithread Quicksort implementation
  * @brief 
  *
  *   Complete Multithread Quicksort implementation using PThreads implementation.

Code/Sorting/PointerBased/stripped_baseQsort.c

@@ -1,5 +1,5 @@
 /**
- * @file baseQsort.c   Quicksort implementation
+ * @file stripped_baseQsort.c   Quicksort implementation
  * @brief 
  *   Complete Quicksort implementation optimized to switch to Insertion 
  *   Sort when problem sizes are less than or equal to minSize in length.

Code/Sorting/ValueBased/modifiedQsort.c

@@ -1,5 +1,5 @@
 /**
- * @file modifiedQsort.c
+ * @file ValueBased/modifiedQsort.c
  * @brief
  *
  *    See how well optimized Qsort compares with qsort() unix library
@@ -61,9 +61,10 @@ while (ct > sizeof (int)) { \
  * ASSUMES THAT pivot value is already placed in ar[right] and that
  * ar[left] <= ar[mid] <= ar[right].
  * 
- * @param ar           array of elements to be sorted.
- * @param left         lower bound index position  (inclusive)    
- * @param right        upper bound index position  (exclusive)
+ * @param pbase        pointer to base of array of elements to be sorted.
+ * @param n            number of elements in the array.
+ * @param s            fixed size of each element.
+ * @param cmp          comparator function.
  * @return             location of the pivot index properly positioned.
  */
 void *partition (void *const pbase, size_t n, size_t s, 
@@ -128,14 +129,15 @@ void insertion (void *base, int n, int s,
 
 /**
  * Select pivot index to use in partition based on median of three. 
- * Places smallest value in vals[left] and the mdeian value in vals[right].
+ * Places smallest value in vals[left] and the median value in vals[right].
  * The largest of the three is actually placed in vals[mid]
  * 
  * Inline code using macro to set value
  * 
  * \param vals    the array of elements.
- * \param left    the left end of the subarray range
- * \param right   the right end of the subarray range
+ * \param n       the number of elements in the array.
+ * \param s       the size in bytes of each value.
+ * \param cmp     the comparator function.
  * \return        int in the range [left, right] to use in partition.
  */
 #define selectPivotIndex(vals,n,s,cmp)       \

README.txt

@@ -115,13 +115,14 @@ Primary Task
 
    Apparently, ant 1.7 does not have this second CLASSPATH requirement.
 
-5. cd into 'Tasks' and type 'ant' to build special ant task
+5. cd into 'Task' and type 'ant' to build special ant task
 
    go back to main directory (cd ..) and continue. At this point you 
    may have to ensure that the ant libraries ${ant.home}/lib/ant.jar
    are in your CLASSPATH.
 
-6. Type 'ant' to compile all Java code (in JavaCode directory).
+6. Type 'ant' to compile all Java code (in JavaCode, Examples, Figures,
+   and PerformanceTests).
 
    This will compile all sources and execute the JUnit test cases
 
@@ -177,7 +178,7 @@ Optional Tasks
    progress. Only works if you have valid JAVA_HOME set to locate
    tools.jar. Find the compiled JUnit report in:
 
-       ./Tests/bin/report/ 
+       ./Tests/report/ 
 
    This option is likely only available for ant 1.7 (and higher).
 

Task/build.xml

@@ -49,6 +49,9 @@
   <target name="all" 
    description="Build runall task">
 
+    <!-- Make sure bin directory exists -->
+    <mkdir    dir="Task/bin"/>
+
     <javac srcdir="Task/src"
           destdir="Task/bin"
             debug="${compile.debug}"