functions in std.i - h
has_records
has_records(file)
returns 1 if FILE has history records, 0 if it does not.
Interpreted function, defined at i0/std.i line 3296
help
help, topic
or help
Prints DOCUMENT comment from include file in which the variable
TOPIC was defined, followed by the line number and filename.
By opening the file with a text editor, you may be able to find
out more, especially if no DOCUMENT comment was found.
Examples:
help, set_path
prints the documentation for the set_path function.
help
prints the DOCUMENT comment you are reading.
This copy of Yorick was launched from the directory:
**** Y_LAUNCH (computed at runtime) ****
Yorick's "site directory" at this site is:
**** Y_SITE (computed at runtime) ****
You can find out a great deal more about Yorick by browsing
through these directories. Begin with the site directory,
and pay careful attention to the subdirectories doc/ (which
contains documentation relating to Yorick), and i/ and
contrib/ (which contain many examples of Yorick programs).
Look for files called README (or something similar) in any
of these directories -- they are intended to assist browsers.
The site directory itself contains std.i and graph.i, which
are worth reading.
Type:
help, dbexit
for help on debug mode. If your prompt is "dbug>" instead of
">", dbexit will return you to normal mode.
Type:
quit
to quit Yorick.
Builtin function, documented at i0/std.i line 33
SEE ALSO:
quit,
info,
print,
copyright,
warranty,
legal
help_worker
help_worker
Interpreted function, defined at i0/std.i line 99
histinv
list = histinv(hist)
returns a list whose histogram is HIST, hist = histogram(list),
that is, hist(1) 1's followed by hist(2) 2's, followed by hist(3)
3's, and so on. The total number of elements in the returned
list is sum(hist). All values in HIST must be non-negative;
if sum(hist)==0, histinv returns []. The input HIST array may
have any number of dimensions; the result will always be either
nil or a 1D array.
Interpreted function, defined at i0/std.i line 1160
SEE ALSO:
histogram
histogram
histogram(list)
or histogram(list, weight)
returns an array hist which counts the number of occurrences of each
element of the input index LIST, which must consist of positive
integers (1-origin index values into the result array):
histogram(list)(i) = number of occurrences of i in LIST
A second argument WEIGHT must have the same shape as LIST; the result
will be the sum of WEIGHT:
histogram(list)(i) = sum of all WEIGHT(j) where LIST(j)==i
The result of the single argument call will be of type long; the
result of the two argument call will be of type double (WEIGHT is
promoted to that type). The input argument(s) may have any number
of dimensions; the result is always 1-D.
KEYWORD: top=max_list_value
By default, the length of the result is max(LIST). You may
specify that the result have a larger length by means of the TOP
keyword. (Elements beyond max(LIST) will be 0, of course.)
Builtin function, documented at i0/std.i line 1135
SEE ALSO:
digitize,
sort,
histinv