TODO

   1 Time-stamp: <2004-02-24 19:22:15 blp>
   2
   3 TODO
   4 ----
   5
   6 Use posix_fadvise(POSIX_FADV_SEQUENTIAL) where available.
   7
   8 random.c should not know about set_seed.
   9
  10 Use AFM files instead of Groff font files, and include AFMs for our default
  11 fonts with the distribution.
  12
  13 Add libplot output driver.  Suggested by Robert S. Maier
  14 <rsm@math.arizona.edu>: "it produces output in idraw-editable PS format, PCL5
  15 format, xfig-editable format, Illustrator format,..., and can draw vector
  16 graphics on X11 displays also".
  17
  18 Storage of value labels on disk is inefficient.  Invent new data structure.
  19
  20 Add an output flag which would cause a page break if a table segment could fit
  21 vertically on a page but it just happens to be positioned such that it won't.
  22
  23 Fix spanned joint cells, i.e., EDLEVEL on crosstabs.stat.
  24
  25 Cell footnotes.
  26
  27 PostScript driver should emit thin lines, then thick lines, to optimize time
  28 and space.
  29
  30 New functions?  var_name_or_label(), tab_value_or_label()
  31
  32 Should be able to bottom-justify cells.  It'll be expensive, though, by
  33 requiring an extra metrics call.
  34
  35 Perhaps instead of the current lines we should define the following line types:
  36 null, thin, thick, double.  It might look pretty classy.
  37
  38 Perhaps thick table borders that are cut off by a page break should decay to
  39 thin borders.  (i.e., on a thick bordered table that's longer than one page,
  40 but narrow, the bottom border would be thin on the first page, and the top and
  41 bottom borders on middle pages.)
  42
  43 Support multi-line titles on tables. (For the first page only, presumably.)
  44
  45 Rewrite the convert_F() function in data-out.c to be nicer code.
  46
  47 In addition to searching the source directory, we should search the current
  48 directory (for data files).  (Yuck!)
  49
  50 Fix line-too-long problems in PostScript code, instead of covering them up.
  51 setlinecap is *not* a proper solution.
  52
  53 Need a better way than MAX_WORKSPACE to detect low-memory conditions.
  54
  55 When malloc() returns 0, page to disk and free() unnecessary data.
  56
  57 Remove ccase * argument from procfunc argument to procedure().
  58
  59 See if process_active_file() has wider applicability.
  60
  61 Eliminate private data in struct variable through use of pointers.
  62
  63 Fix som_columns().
  64
  65 There needs to be another layer onto the lexer, which should probably be
  66 entirely rewritten anyway.  The lexer needs to read entire *commands* at a
  67 time, not just a *line* at a time.  This would vastly simplify the
  68 (yet-to-be-implemented) logging mechanism and other stuff as well.
  69
  70 Has glob.c been pared down enough?
  71
  72 Improve interactivity of output by allowing a `commit' function for a page.
  73 This will also allow for infinite-length pages.
  74
  75 All the tests need to be looked over.  Some of the SET calls don't make sense
  76 any more.
  77
  78 Implement thin single lines, should be pretty easy now.
  79
  80 SELECT IF should be moved before other transformations whenever possible.  It
  81 should only be impossible when one of the variables referred to in SELECT IF is
  82 created or modified by a previous transformation.
  83
  84 The manual: add text, add index entries, add examples.
  85
  86 The inline file should be improved: There should be *real* detection of whether
  87 it is used (in dfm.c:cmd_begin_data), not after-the-fact detection.
  88
  89 Figure out a stylesheet for messages displayed by PSPP: i.e., what quotation
  90 marks around filenames, etc.
  91
  92 Data input and data output are currently arranged in reciprocal pairs: input is
  93 done directly, with write_record() or whatever; output is done on a callback
  94 event-driven basis.  It would definitely be easier if both could be done on a
  95 direct basis, with read_record() and write_record() routines, with a coroutine
  96 implementation (see Knuth).  But I'm not sure that coroutines can be
  97 implemented in ANSI C.  This will require some thought.  Perhaps 0.4.0 can do
  98 this.
  99
 100 New SET subcommand: OUTPUT.  i.e., SET OUTPUT="filename" to send output to that
 101 file; SET OUTPUT="filename"(APPEND) to append to that file; SET OUTPUT=DEFAULT
 102 to reset everything.  There might be a better approach, though--think about it.
 103
 104 HDF export capabilities (http://hdf.ncsa.uiuc.edu).  Suggested by Marcus
 105 G. Daniels <mgd@santafe.edu>.
 106
 107 From Zvi Grauer <z.grauer@csuohio.edu> and <zvi@mail.ohio.net>:
 108
 109    1. design of experiments software, specifically Factorial, response surface
 110    methodology and mixrture design.
 111
 112    These would be EXTREMELY USEFUL for chemists, engineeris, and anyone
 113    involved in the production of chemicals or formulations.
 114
 115    2. Multidimensional Scaling analysis (for market analysis) -
 116
 117    3. Preference mapping software for market analysis
 118
 119    4. Hierarchical clustering (as well as partition clustering)
 120
 121    5. Conjoint analysis
 122
 123    6. Categorical data analsys ?
 124
 125 IDEAS
 126 -----
 127
 128 In addition to an "infinite journal", we should keep a number of
 129 individual-session journals, pspp.jnl-1 through pspp.jnl-X, renaming and
 130 deleting as needed.  All of the journals should have date/time comments.
 131
 132 Qualifiers for variables giving type--categorical, ordinal, ...
 133
 134 Analysis Wizard
 135
 136 Consider consequences of xmalloc(), fail(), hcf() in interactive
 137 use:
 138 a. Can we safely just use setjmp()/longjmp()?
 139 b. Will that leak memory?
 140 i. I don't think so: all procedure-created memory is either
 141 garbage-collected or globally-accessible.
 142 ii. But you never know... esp. w/o Checker.
 143 c. Is this too early to worry? too late?
 144
 145 Need to implement a shared buffer for funny functions that require relatively
 146 large permanent transient buffers (1024 bytes or so), that is, buffers that are
 147 permanent in the sense that they probably shouldn't be deallocated but are only
 148 used from time to time, buffers that can't be allocated on the stack because
 149 they are of variable and unpredictable but usually relatively small (usually
 150 line buffers).  There are too many of these lurking around; can save a sizeable
 151 amount of space at very little overhead and with very little effort by merging
 152 them.
 153
 154 Clever multiplatform GUI idea (due partly to John Williams): write a GUI in
 155 Java where each statistical procedure dialog box could be downloaded from the
 156 server independently.  The statistical procedures would run on (the/a) server
 157 and results would be reported through HTML tables viewed with the user's choice
 158 of web browsers.  Help could be implemented through the browser as well.
 159
 160 Design a plotting API, with scatterplots, line plots, pie charts, barcharts,
 161 Pareto plots, etc., as subclasses of the plot superclass.
 162
 163 HOWTOs
 164 ------
 165
 166 1. How to add an operator for use in PSPP expressions:
 167
 168 a. Add the operator to the enumerated type at the top of expr.h.  If the
 169 operator has arguments (i.e., it's not a terminal) then add it *before*
 170 OP_TERMINAL; otherwise, add it *after* OP_TERMINAL.  All these begin with OP_.
 171
 172 b. If the operator's a terminal then you'll want to design a structure to hold
 173 its content.  Add the structure to the union any_node.  (You can also reuse one
 174 of the prefab structures, of course.)
 175
 176 c. Now switch to expr-prs.c--the module for expression parsing.  Insert the
 177 operator somewhere in the precedence hierarchy.
 178
 179 (1) If you're adding a operator that is a function (like ACOS, ABS, etc.) then
 180 add the function to functab in `void init_functab(void)'.  Order is not
 181 important here.  The first element is the function name, like "ACOS".  The
 182 second is the operator enumerator you added in expr.h, like OP_ARCOS.  The
 183 third element is the C function to parse the PSPP function.  The predefined
 184 functions will probably suit your needs, but if not, you can write your own.
 185 The fourth element is an argument to the parsing function; it's only used
 186 currently by generic_str_func(), which handles a rather general syntax for
 187 functions that return strings; see the comment at the beginning of its code for
 188 details.
 189
 190 (2) If you're adding an actual operator you'll have to put a function in
 191 between two of the operators there already in functions `exprtype
 192 parse_*(any_node **n)'.  Each of these stores the tree for its result into *n,
 193 and returns the result type, or EX_ERROR on error.  Be sure to delete all the
 194 allocated memory on error before returning.
 195
 196 d. Add the operator to the table `op_desc ops[OP_SENTINEL+1]' in expr-prs.c,
 197 which has an entry for every operator.  These entries *must* be in the same
 198 order as they are in expr.h.  The entries have the form `op(A,B,C,D)'.  A is
 199 the name of the operator as it should be printed in a postfix output format.
 200 For example, the addition operator is printed as `plus'.  B is a bitmapped set
 201 of flags:
 202
 203 * Set the 001 bit (OP_VAR_ARGS) if the operator takes a variable number of
 204 arguments.  If a function can take, say, two args or three args, but no other
 205 numbers of args, this is a poor way to do it--instead implement the operator as
 206 two separate operators, one with two args, the other with three.  (The main
 207 effect of this bit is to cause the number of arguments to be output to the
 208 postfix form so that the expression evaluator can know how many args the
 209 operator takes.  It also causes the expression optimizer to calculate the
 210 needed stack height differently, without referencing C.)
 211
 212 * Set the 002 bit (OP_MIN_ARGS) if the operator can take an optional `dotted
 213 argument' that specified the minimum number of non-SYSMIS arguments in order to
 214 have a non-SYSMIS result.  For instance, MIN.3(e1,e2,e3,e4,e5) returns a
 215 non-SYSMIS result only if at least 3 out of 5 of the expressions e1 to e5 are
 216 not missing.
 217
 218 Minargs are passed in the nonterm_node structure in `arg[]''s elements past
 219 `n'--search expr-prs.c for the words `terrible crock' for an example of this.
 220
 221 Minargs are output to the postfix form.  A default value is output if none was
 222 specified by the user.
 223
 224 You can use minargs for anything you want--they're not limited to actually
 225 describing a minimum number of valid arguments; that's just what they're most
 226 *commonly* used for.
 227
 228 * Set the 004 bit (OP_FMT_SPEC) if the operator has an argument that is a
 229 format specifier.  (This causes the format specifier to be output to the
 230 postfix representation.)
 231
 232 Format specs are passed in the nonterm_node structure in the same way as
 233 minargs, except that there are three args, in this order: type, width, # of
 234 decimals--search expr-prs.c for the words `is a crock' for an example of this.
 235
 236 * Set the 010 bit (OP_ABSORB_MISS) if the operator can *ever* have a result of
 237 other than SYSMIS when given one or more arguments of SYSMIS.  Operators
 238 lacking this bit and known to have a SYSMIS argument are short-circuited to
 239 SYSMIS by the expression optimizer.
 240
 241 * If your operator doesn't fit easily into the existing categories,
 242 congratulations, you get to write lots of code to adjust everything to cope
 243 with this new operator.  Are you really sure you want to do that?
 244
 245 C is the effect the operator has on stack height.  Set this to `varies' if the
 246 operator has a variable number of arguments.  Otherwise this 1, minus the
 247 number of arguments the operator has.  (Since terminals have no arguments, they
 248 have a value of +1 for this; other operators have a value of 0 or less.)
 249
 250 D is the number of items output to the postfix form after the operator proper.
 251 This is 0, plus 1 if the operator has varargs, plus 1 if the operator has
 252 minargs, plus 3 if the operator has a format spec.  Note that minargs/varargs
 253 can't coexist with a format spec on the same operator as currently coded.  Some
 254 terminals also have a nonzero value for this but don't fit into the above
 255 categories.
 256
 257 e. Switch to expr-opt.c.  Add code to evaluate_tree() to evaluate the
 258 expression when all arguments are known to be constants.  Pseudo-random
 259 functions can't be evaluated even if their arguments are constants.  If the
 260 function can be optimized even if its arguments aren't all known constants, add
 261 code to optimize_tree() to do it.
 262
 263 f. Switch to expr-evl.c.  Add code to evaluate_expression() to evaluate the
 264 expression.  You must be absolutely certain that the code in evaluate_tree(),
 265 optimize_tree(), and evaluate_expression() will always return the same results,
 266 otherwise users will get inconsistent results, a Bad Thing.  You must be
 267 certain that even on boundary conditions users will get identical results, for
 268 instance for the values 0, 1, -1, SYSMIS, or, for string functions, the null
 269 string, 1-char strings, and 255-char strings.
 270
 271 g. Test the code.  Write some test syntax files.  Examine the output carefully.
 272
 273 NOTES ON SEARCH ALGORITHMS
 274 --------------------------
 275
 276 1. Trees are nicer when you want a sorted table.  However, you can always
 277 sort a hash table after you're done adding values.
 278
 279 2. Brent's variation of Algorithm D is best when the table is fixed: it's
 280 memory-efficient, having small, fixed overhead.  It's easier to use
 281 when you know in advance how many entries the table will contain.
 282
 283 3. Algorithm L is rather slow for a hash algorithm, however it's easy.
 284
 285 4. Chaining is best in terms of speed; ordered/self-ordering is even
 286 better.
 287
 288 5. Rehashing is slow.
 289
 290 6. Might want to decide on an algorithm empirically since there are no
 291 clear mathematical winners in some cases.
 292
 293 7. gprof?  Hey, it works!
 294
 295 MORE NOTES/IDEAS/BUGS
 296 ---------------------
 297
 298 The behavior of converting a floating point to an integer when the value of the
 299 float is out of range of the integer type is UNDEFINED!  See ANSI 6.2.1.3.
 300
 301 What should we do for *negative* times in expressions?
 302
 303 Sometimes very wide (or very tall) columns can occur in tables.  What is a good
 304 way to truncate them?  It doesn't seem to cause problems for the ascii or
 305 postscript drivers, but it's not good in the general case.  Should they be
 306 split somehow?  (One way that wide columns can occur is through user request,
 307 for instance through a wide PRINT request--try time-date.stat with a narrow
 308 ascii page or with the postscript driver on letter size paper.)
 309
 310 NULs in input files break the products we're replacing: although it will input
 311 them properly and display them properly as AHEX format, it truncates them in A
 312 format.  Also, string-manipulation functions such as CONCAT truncate their
 313 results after the first NUL.  This should simplify the result of PSPP design.
 314 Perhaps those ugly a_string, b_string, ..., can all be eliminated.
 315
 316 From Moshe Braner <mbraner@nessie.vdh.state.vt.us>: An idea regarding MATCH
 317 FILES, again getting BEYOND the state of SPSS: it always bothered me that if I
 318 have a large data file and I want to match it to a small lookup table, via
 319 MATCH FILES FILE= /TABLE= /BY key, I need to SORT the large file on key, do the
 320 match, then (usually) re-sort back into the order I really want it.  There is
 321 no reason to do this, when the lookup table is small.  Even a dumb sequential
 322 search through the table, for every case in the big file, is better, in some
 323 cases, than the sort.  So here's my idea: first look at the /TABLE file, if it
 324 is "small enough", read it into memory, and create an index (or hash table,
 325 whatever) for it.  Then read the /FILE and use the index to match to each case.
 326 OTOH, if the /TABLE is too large, then do it the old way, complaining if either
 327 file is not sorted on key.
 328
 329 -------------------------------------------------------------------------------
 330 Local Variables:
 331 mode: text
 332 fill-column: 79
 333 End: