Table of Contents


NAME

decida - summary of all decida 1.1 commands (Decida Application)

USAGE

          decida

OBJECT-CREATION-COMMANDS

data <data> create new data object
par <par> create new parameter object
model <model> create new model object
arthur <arthur> create new N2F optimizer object
lancelot <lancelot> create new Simulated-annealing optimizer object

UTILITY-COMMANDS

echo <args> echo joined argument list
date return current date
sourcex <file> source archive file

DATA-OBJECT-COMMANDS

<data> delete destroy data object
<data> dup <data-1> create new data object by duplicating data object
<data> get <row> <col> return value from data table at row, col
<data> length return number of rows in data table
<data> pack eliminate unselected rows and columns from data table
<data> read <file> read data from file. File format can be Column, A3-format, or gspmod-format.
<data> set <row> <col> <value> set entry at row, col of data table to value
<data> show display rows and columns of data
<data> width return number of columns in data table
<data> write <file> write data to file in columnar format
<data> lstsq <data-X> <data-Y> compute least-squares coefficients

DATA-COLUMN-COMMANDS

<data>.col append <data-1> ?<data-2> ...? append columns of data from other data objects
<data>.col extend <number> widen the data object - increase the column count
<data>.col index <column> return the column index of <column>, -1 if not present
<data>.col is-selected <label> return select-status of data column
<data>.col label return list of column labels
<data>.col label <column> return label of column <column> (<column> is either index or name)
<data>.col label <column> <label> set label of column <column> to <label> (<column> is either index or name)
<data>.col numselected return the number of selected columns
<data>.col reduce <number> narrow the data object - reduce the column count
<data>.col resize <number> set the width of the data object
<data>.col scale <column> <value> multiply column by value
<data>.col select <column> ?<column-1> ...? select the data columns
<data>.col select-all select all data columns
<data>.col select-all <row> <value> select all data columns where entry at <row>, column = <value>
<data>.col unselect <column> unselect the data column
<data>.col unselect-all unselect all of the data columns
<data>.col unselect-all <row> <value> unselect all of the data columns where entry at <row>, column = <value>
<data>.col vector <column> return list of entries in <column>
<data>.col set <column> return list of entries in <column>
<data>.col set <column> index set entries in column to the row index
<data>.col set <column> <value> set entries in <column> to <value>
<data>.col set <column> <column-1> copy entries in <column-1> to <column>
<data>.col set <column> <unary-operation> <column-1|value> set <column> to unary operation on <column-1> (or <value>)
unary-operations are:
+ - abs sgn
sqrt log log10 exp 10^X 1/X
sin cos tan asin acos atan
sinh cosh tanh asinh acosh atanh
del (d.col set z del x: z(i) = x(i) - x(i-1)))
<data>.col set <column> <column-1> <binary-operation> <column-2|value> set <column> to binary operation between <column-1> and <column-2> (or <value>)
binary operations are:
+ - * / ^ div % max min
== != < > <= >=
dY/dX d2Y/dX2 spline integ
<data>.col offset <column> <column-1> <step-value> <column-2> ?<column-3> ...? set <column> to <column-1>, adding <step-value> whenever values in <column-2> ... change.
<data>.col max <column> return the maximum value in <column>
<data>.col max <column> ?<column-1> ...? return list of maximum values in <column>, for each block of rows where entries at <row>, <column-1> ... are constant.
<data>.col min <column> return the minimum value in <column>
<data>.col min <column> ?<column-1> ...? return list of minimum values in <column>, for each block of rows where entries at <row>, <column-1> ... are constant.
<data>.col range <column> <row-1> <row-2> return list of entries in <column> between rows <row-1> and <row-2>
<data>.col unique <column> return unique list of entries in <column>
<data>.col stats xcol return unary statistics of <column>: avg std var norm sum sum-of-squares min max return list is list of lists of name value pairs
<data>.col stats <column> <column-1> return binary statistics of <column> and <column-1>: rms-error(percent) abs-error inner-product return list is list of lists of name value pairs
<data>.col linreg <x-column> <y-column> return linear regression coefficients for regression line: b0 b1, where y=b0+b1*x
<data>.col quadreg <x-column> <y-column> return quadratic regression coefficients for regression curve: b0 b1 b2, where y=b0+b1*x+b2*x^2
<data>.col splint <x-value> <x-column> <y-column> <d2y/dx2-column> return (spline-)interpolated y-value corresponding to x-value d2y/dx2-column must have been calculated by <data>.col set z y spline x

DATA-ROW-COMMANDS

<data>.row append <data-1> ?<data-2> ...? append rows of data from other data objects
<data>.row extend <number> lengthen the data object - increase the row count
<data>.row index <label> find the data row index of a row, -1 if not present
<data>.row is-selected <label> return select-status of data row
<data>.row label return list of row labels
<data>.row label return list of row labels
<data>.row label <row> return label of row <row> (<row> is either index or name)
<data>.row label <row> <label> set label of row <row> to <label> (<row> is either index or name)
<data>.row numselected return the number of selected rows
<data>.row reduce <number> shorten the data object - reduce the row count
<data>.row resize <number> set the length of the data object
<data>.row scale <row> <value> multiply row by value
<data>.row select <row> ?<row-1> ...? select data rows
<data>.row select-all select all data rows
<data>.row select-all <column> <value> select all data rows where entry at row, <column> = <value>
<data>.row select-unique <column> ?<column-1> ...? select data rows with unique values at row, <column>, <column-1>, ...
<data>.row sort <column> ?<column-1> ...? sort rows in order of increasing <column>, <column-1>, ...
<data>.row unselect <row> unselect the data row
<data>.row unselect-all unselect all of the data rows
<data>.row unselect-all <column> <value> unselect all of the data rows where entry at row, <column> = <value>
<data>.row vector <row> return list of entries in <row>

PAR-OBJECT-COMMANDS

<par> delete destroy parameter object
<par> dup <par-1> create new parameter object by duplicating parameter object
<par> exclude <parameter> ?<parameter-1> ...? set include-status to exclude for parameters
<par> exclude-all set include-status to exclude for all parameters
<par> get <parameter> <field> return entry at (row, column) <parameter>, <field> field is one of INITIAL, NOMINAL, MINIMUM, MAXIMUM, CURRENT, last
<par> include <parameter> ?<parameter-1> ...? set include-status to include for parameters
<par> include-all set include-status to include for all parameters
<par> length return number of parameters in parameter table
<par> pack eliminate unselected rows and columns from parameter table
<par> read <file> read parameter from specification file. File must be in arthur-format: each line is: "<parameter> (EXCLUDE|INCLUDE) <nominal> <minimum> <maximum>"
<par> rebound <policy> <parameter> ?<parameter-1> ...? specify rebound policy for parameters <policy> is one of center, reflect, or geometric
<par> set <parameter> <field> <value> set entry at (row, column) <parameter>, <field> to <value> field is one of INITIAL, NOMINAL, MINIMUM, MAXIMUM, CURRENT, last
<par> show display parameter table.
<par> width return number of fields in parameter table.
<par> write <file> write arthur-format paramater specification file.

PAR-COLUMN-COMMANDS

<par>.col append <par-1> ?<par-2> ...? append columns of parameter tables from other parameter objects
<par>.col extend <number> widen the parameter object - increase the field count
<par>.col index <field> return the column index of <field>, -1 if not present
<par>.col label return all field (column) labels
<par>.col label <field> return label of column <field> (<field> is either index or label)
<par>.col label <field> <label> set label of column <field> to <label> (<field> is either index or name)
<par>.col reduce <number> narrow the parameter object - reduce the column count
<par>.col resize <number> set the width of the parameter object
<par>.col select <field> ?<field-1> ...? select parameter columns
<par>.col select-all select all parameter columns
<par>.col select-all <parameter> <value> select all parameter fields with entry at (row, column) <parameter>, field = <value>
<par>.col unselect <field> ?<field-1> ...? unselect parameter columns
<par>.col unselect-all unselect all parameter columns
<par>.col unselect-all <parameter> <value> unselect all parameter fields with entry at (row, column) <parameter>, field = <value>

PAR-ROW-COMMANDS

<par>.row append <par-1> ?<par-2> ...? append rows of parameter tables from other parameter objects
<par>.row extend <number> lengthen the parameter object - increase the row count
<par>.row index <parameter> return the row index of <parameter>, -1 if not present
<par>.row label return all row labels (parameter list)
<par>.row label <parameter> return label of row <parameter> (<parameter> is either index or label)
<par>.row label <parameter> <label> set label of row <parameter> to <label> (<parameter> is either index or name)
<par>.row reduce <number> shorten the parameter object - reduce the row count
<par>.row resize <number> set the length of the parameter object
<par>.row select <parameter> ?<parameter-1> ...? select parameter rows
<par>.row select-all select all parameter rows
<par>.row select-all <field> <value> select all parameter rows with entry at (row, column) parameter, <field> = <value>
<par>.row unselect <parameter> ?<parameter-1> ...? unselect parameter rows
<par>.row unselect-all unselect all parameter rows
<par>.row unselect-all <field> <value> unselect all parameter rows with entry at (row, column) parameter, <field> = <value>

MODEL-OBJECT-COMMANDS

<model> delete destroy model object
<model> dup <model-1> create new model object by duplicating model object
<model> evaluate <data> <par> ?args? invoke model evaluation procedure with data and parameter objects. additional arguments to procedures are passed in args.
<model> set-hook <hook-name> <c-function> specify procedure to be associated with model hook <hook-name>. hook-name is one of <init> <getdim> <eval> <error>, or <term>.
<model> set-tcl-hook <hook-name> <tcl-proc> specify a tcl procedure to be associated with model hook <hook-name>. hook-name is one of <init> <getdim> <eval> <error>, or <term>.
<model> unset-hook <hook-name> remove association between model hook and procedure
<model> show display model status report

ARTHUR-OPTIMIZER-OBJECT-COMMANDS

<arthur> delete destroy optimizer object
<arthur> dup <arthur-1> create new optimizer object by duplicating optimizer object.
<arthur> config query optimizer options
<arthur> config <option> query specific optimizer option <option> is one of abstol, ftol, journal, maxeval, maxiter, reltol, stepsize, stol, verbose, xtol
<arthur> config <option> <value> ?<option> <value> ...? specify optimizer options <option> is one of abstol, ftol, journal, maxeval, maxiter, reltol, stepsize, stol, verbose, xtol
<arthur> extract model data par ?args? invoke optimization procedure with model, data and parameter objects. additional arguments to procedures are passed in args.
<arthur> info <optimizer-variable> query optimizer for optimization information <optimizer-variable> is one of current, errorCode, errorInfo, initial, numEval, numIter
<arthur> show display optimizer status report
<arthur> stop interrupt optimization

LANCELOT-OPTIMIZER-OBJECT-COMMANDS

<lancelot> delete destroy optimizer object
<lancelot> dup <lancelot-1> create new optimizer object by duplicating optimizer object.
<lancelot> config query optimizer options
<lancelot> config <option> query specific optimizer option <option> is one of ftol, annealtype, tscale, tdescend, titerations, siterations, journal, maxiter, or verbose.
<lancelot> config <option> <value> ?<option> <value> ...? specify optimizer options <option> is one of ftol, annealtype, tscale, tdescend, titerations, siterations, journal, maxiter, or verbose.
<lancelot> extract model data par ?args? invoke optimization procedure with model, data and parameter objects. additional arguments to procedures are passed in args.
<lancelot> info <optimizer-variable> query optimizer for optimization information <optimizer-variable> is one of: initial, current, best, temperature, iterations-performed, numEval, numIter, errorCode, errorInfo
<lancelot> show display optimizer status report
<lancelot> stop interrupt optimization

AUTHORS

Richard Booth, Michael McLennan, George Howlett

Table of Contents