Home
Manual
Packages
Global Index
Keywords
Quick Reference
|
all functions - _
_PLM
|
UMENT
legendre function which also takes m<0
interpreted function, defined at contrib/harmonic.i line 203
|
__fit_lp
|
__fit_lp
interpreted function, defined at contrib/yeti_fit_2d_spike.i line 374
|
__gg_draw3
|
__gg_draw_3d_rect_bd, x0, y0, x1, y1, bd, top, bot;
-or- __gg_draw3, x0, y0, x1, y1, x2, y2, color;
Private routines used by gg_draw_3d_rect to paint the 3D border. Top
and left sides of border get drawn with color TOP, bottom and right
sides get drawn with color BOT.
interpreted function, defined at contrib/yeti_gist_gui.i line 1595
|
SEE ALSO:
|
gg_draw_3d_rect
|
_df3_read
|
_df3_read(file, address, expr)
-or- _df3_read, file, address, variable;
Read unformated, binary data from FILE at offset ADDRESS (must be a
scalar long integer). On return, ADDRESS is incremented by the size of
the data read. The third argument gives the data type and dimension list
of the array to read. If called as a function, the argument EXPR may
either be an expression or a variable which is filled with the data read
and is returned as the result of the call. If called as a subroutine,
the third argument should be a predefined variable.
interpreted function, defined at contrib/df3.i line 26
|
SEE
|
ALSO,
df3_read,_df3_write,,
open,,
_read.
|
_df3_write
|
_df3_write(file, address, expr)
Write unformated, binary data from FILE.
On return, ADDRESS is incremented by the size of
the data written. The third argument gives the data to be written.
interpreted function, defined at contrib/df3.i line 96
|
SEE
|
ALSO,
df3_write,_df3_read,,
open,,
_read.
|
_dgecox
|
_dgecox
LAPACK dgecon routine, except norm argument not a string.
builtin function, documented at i0/matrix.i line 288
|
_dgelss
|
_dgelss
LAPACK dgelss routine.
builtin function, documented at i0/matrix.i line 505
|
_dgelx
|
_dgelx
LAPACK dgels routine, except trans argument not a string.
builtin function, documented at i0/matrix.i line 358
|
_dgesv
|
_dgesv
LAPACK dgesv routine.
builtin function, documented at i0/matrix.i line 270
|
_dgesvx
|
_dgesvx
LAPACK dgesvd routine, except jobu and jobvt are not strings.
builtin function, documented at i0/matrix.i line 516
|
_dgetrf
|
_dgetrf
LAPACK dgetrf routine. Performs LU factorization.
builtin function, documented at i0/matrix.i line 279
|
_dgtsv
|
_dgtsv
LAPACK dgtsv routine.
builtin function, documented at i0/matrix.i line 95
|
_fits_bintable_header
|
_fits_bintable_header(fh, nbytes, nrows, tfields)
Set/update header information in FITS handle FH for a binary table
extension. NBYTES is the number of bytes per row of the table, NROWS
is the number of table rows and TFIELDS is the number of fields
(columns in the table). FITS card "XTENSION" with value "BINTABLE"
must already exists in the header (this is not checked). FITS cards
"BITPIX", "NAXIS", "NAXIS1", "NAXIS2", "PCOUNT", "GCOUNT", and
"TFIELDS" get created/updated by this routine. The value of PCOUNT is
computed by the routine and returned to the caller.
interpreted function, defined at i/fits.i line 2076
|
SEE ALSO:
|
fits,
fits_new_bintable,
fits_write_bintable
|
_fits_format_comment
|
_fits_format_comment(key)
-or- _fits_format_comment(key, text)
Private routine to format FITS commentary card, return an array of
80-character string(s). Text comment, if longer than 72 characters,
will result in more than one comment cards.
interpreted function, defined at i/fits.i line 1423
|
SEE ALSO:
|
fits,
fits_set
|
_fits_format_complex
|
_fits_format_complex(key, value)
-or- _fits_format_complex(key, value, comment)
Private routine to format FITS complex card, return a 80-character
string.
interpreted function, defined at i/fits.i line 1370
|
SEE ALSO:
|
fits,
fits_set
|
_fits_format_integer
|
_fits_format_integer(key, value)
-or- _fits_format_integer(key, value, comment)
Private routine to format FITS integer card, return a 80-character
string.
interpreted function, defined at i/fits.i line 1340
|
SEE ALSO:
|
fits,
fits_set
|
_fits_format_logical
|
_fits_format_logical(key, value)
-or- _fits_format_logical(key, value, comment)
Private routine to format FITS logical card, return a 80-character
string.
interpreted function, defined at i/fits.i line 1325
|
SEE ALSO:
|
fits,
fits_set
|
_fits_format_real
|
_fits_format_real(key, value)
-or- _fits_format_real(key, value, comment)
Private routine to format FITS real card, return a 80-character
string.
Note: FITS standard imposes that the ASCII representation of a real
number makes 20 characters; the full precision of 64-bit values
can not be represented with this restriction.
interpreted function, defined at i/fits.i line 1352
|
SEE ALSO:
|
fits,
fits_set
|
_fits_format_string
|
_fits_format_string(key, value)
-or- _fits_format_string(key, value, comment)
Private routine to format FITS string card, return a 80-character
string.
Note: enclose input string in quotes, replacing each quote in input
string by 2 quotes. Since opening quote should appear in
column 11 and closing quote in columns 20 to 80 of the FITS
card, make sure that string is not longer than 68 characters
(too long strings get silently truncated).
interpreted function, defined at i/fits.i line 1383
|
SEE ALSO:
|
fits,
fits_set
|
_fits_get_cards
|
_fits_get_cards(fh, cards, ids)
Stores in variables CARDS and IDS the FITS cards and numerical
identifiers from header in FITS handle FH. The returned value is the
number of FITS cards (including empty ones).
interpreted function, defined at i/fits.i line 1284
|
SEE ALSO:
|
fits,
fits_set
|
_fits_id
|
_fits_id(hdr)
Return array of numerical identifier for FITS header data HDR which
must be an array(char, 80, N). Any invalid FITS key will have its
identifier set to -1.
interpreted function, defined at i/fits.i line 2626
|
SEE ALSO:
|
fits,
fits_id,
fits_key,
fits_rehash
|
_fits_key
|
_fits_key(id)
Private routine used by fits_key, only useful if ID is a valid scalar
numerical identifier.
interpreted function, defined at i/fits.i line 2654
|
SEE ALSO:
|
fits_key
|
_fits_warn
|
_fits_warn, msg;
Private FITS routine: print out warning message MSG. */
interpreted function, defined at i/fits.i line 768
|
_gadget_read
|
_gadget_read(file, address, expr)
-or- _gadget_read, file, address, variable;
Read unformated, binary data from FILE at offset ADDRESS (must be a
scalar long integer). On return, ADDRESS is incremented by the size of
the data read. The third argument gives the data type and dimension list
of the array to read. If called as a function, the argument EXPR may
either be an expression or a variable which is filled with the data read
and is returned as the result of the call. If called as a subroutine,
the third argument should be a predefined variable.
interpreted function, defined at contrib/gadget.i line 374
|
SEE
|
ALSO,
gadget_read,_gadget_write,,
open,,
_read.
|
_gadget_write
|
_gadget_write(file, address, expr)
Write unformated, binary data from FILE.
On return, ADDRESS is incremented by the size of
the data written. The third argument gives the data to be written.
interpreted function, defined at contrib/gadget.i line 493
|
SEE
|
ALSO,
gadget_write,_gadget_read,,
open,,
_read.
|
_init_clog
|
_init_clog, file
initializes a Clog binary file. Used after creating a new file --
must be called AFTER the primitive data formats have been set.
builtin function, documented at i0/std.i line 2019
|
_init_pdb
|
_init_pdb, file, at_pdb_close
_set_pdb, file, at_pdb_close
initializes a PDB binary file. Used after creating a new file --
must be called AFTER the primitive data formats have been set.
The _set_pdb call only sets the CloseHook, on the assumption that
the file header has already been written (as in recover_file).
builtin function, documented at i0/std.i line 2008
|
SEE ALSO:
|
createb,
recover_file,
at_pdb_close
|
_jr
|
_jt, file, time
_jc, file, ncyc
_jr, file
are raw versions of jt and jc provided to simplify redefining
the default jt and jc functions to add additional features.
For example, you could redefine jt to jump to a time, then
plot something. The new jt can pass its arguments along to
_jt, then call the appropriate plotting functions.
There is a raw version of jr as well.
builtin function, documented at i0/std.i line 2383
|
_lsm1
|
_lsm1
interpreted function, defined at contrib/htmldoc.i line 256
|
_lst
|
list= _lst(item1, item2, item3, ...)
list= _cat(item_or_list1, item_or_list2, item_or_list3, ...)
list= _cpy(list)
list= _cpy(list, i)
length= _len(list)
item= _car(list)
item_i= _car(list, i)
_car, list, i, new_item_i
list= _cdr(list)
list= _cdr(list, i)
_cdr, list, i, new_list_i
implement rudimentary Lisp-like list handling in Yorick.
However, in Yorick, a list must have a simple tree structure
- no loops or rings are allowed (loops break Yorick's memory
manager - beware). You need to be careful not to do this as
the error will not be detected.
Lists are required in Yorick whenever you need to hold an
indeterminate amount of non-array data, such as file handles,
bookmarks, functions, index ranges, etc. Note that Yorick
pointers cannot point to these objects. For array data, you have
a choice between a list and a struct or an array of pointers.
Note that a list cannot be written into a file with the save
function, since it may contain unsaveable items.
The _lst (list), _cat (catenate), and _cpy (copy) functions
are the principal means for creating and maintaining lists.
_lst makes a list out of its arguments, so that each argument
becomes one item of the new list. Unlike Yorick array data
types, a statement like x=list does not make a copy of the
list, it merely makes an additional reference to the list.
You must explicitly use the _cpy function to copy a list. Note
that _cpy only copies the outermost list itself, not the items
in the list (even if those items are lists). With the second
argument i, _cpy copies only the first i items in the list.
The _cat function concatentates several lists together,
"promoting" any arguments which are not lists. This operation
changes the values of list arguments to _cat, except for the
final argument, since after _cat(list, item), the variable list
will point to the new longer list returned by _cat.
Nil, or [], functions as an empty list. This leads to ambiguity
in the argument list for _cat, since _cat "promotes" non-list
arguments to lists; _cat treats [] as an empty list, not as a
non-list item. Also, _lst() or _lst([]) returns a single item list,
not [] itself.
The _len function returns the number of items in a list, or 0
for [].
The _car and _cdr functions (the names are taken from Lisp,
where they originally stood for something like "address register"
and "data register" of some long forgotten machine) provide
access to the items stored in a list. _car(list,i) returns the
i-th item of the list, and i defaults to 1, so _car(list) is the
first item. Also, _car,list,i,new_item_i sets the i-th item
of the list. Finally, _cdr(list,i) returns a list of all the
items beyond the i-th, where i again defaults to 1. The form
_cdr,list,i,new_list_i can be used to reset all list items
beyond the i-th to new values. In the _cdr function, i=0 is
allowed. When used to set values, both _car and _cdr can also
be called as functions, in which case they return the item or
list which has been replaced. The _cdr(list) function returns
nil if and only if LIST contains only a single item; this is
the usual means of halting a loop over items in a list.
builtin function, documented at i0/std.i line 3054
|
SEE ALSO:
|
array,
grow,
_prt,
_map,
_rev,
_nxt
|
_map
|
_map(f, list)
return a list of the results of applying function F to each
element of the input LIST in turn, as if by
_lst(f(_car(list,1)),f(_car(list,2)),...)
interpreted function, defined at i0/std.i line 3148
|
SEE ALSO:
|
_lst
|
_multi_bins
|
gb= _multi_bins(nfinal, gb1, gb2, ...)
returns NFINAL+1 boundaries of NFINAL bins constructed by combining
the input bin structures GB1, GB2, etc.
Use NFINAL=0 to get at least the resolution in the finest GBi in
every region of the spectrum.
This is done by constructing a total bin density function
(#bins/energy width), as the maximum of the bin density of each
component. This total bin density function is integrated, and
the integral is divided into NFINAL equal parts; the points in
energy at which this division must be made are the returned bin
boundaries.
In the returned bin structure, the density of bins is everywhere
proportional to the densest bins in any of the GBi.
interpreted function, defined at i/multi.i line 1155
|
_multi_integrate
|
atten_emit= _multi_integrate(f, mesh, time, irays, slimits)
is the default drat_integrate routine.
On entry, file F is positioned at TIME, from which MESH has already
been read. IRAYS and SLIMITS are the rays coordinates (in internal
format) and integration limits.
The result should be ngroup-by-2-by-raydims, where the second index
is 1 for the attenuation factor, 2 for the self-emission (specific
intensity due to emission along the ray).
OPTIONS: drat_linear, drat_ocompute, drat_oadjust,
drat_emult, drat_amult, drat_omult, drat_nomilne,
drat_ekap, drat_akap, drat_glist
interpreted function, defined at i/multi.i line 540
|
SEE ALSO:
|
streak,
multi_streak
|
_not_cdf
|
_not_cdf(file)
is like _not_pdb, but for netCDF files.
interpreted function, defined at i0/std.i line 2032
|
_not_pdb
|
_not_pdb(file, familyOK)
returns 1 if FILE is not a PDB file, otherwise returns 0 after
setting the structure and data tables, and cataloguing any
history records. Used to open an existing file. Also detects
a file with an appended Clog description.
Before calling _not_pdb, set the variable yPDBopen to the value
of at_pdb_open you want to be in force. (For historical reasons
-- in order to allow for the open102 keyword to openb -- _not_pdb
looks at the value of the variable yPDBopen, rather than at_pdb_open
directly.)
builtin function, documented at i0/std.i line 1912
|
_numfmt1
|
_numfmt1
struct _numfmt1 { double d; char c; }
|
_numfmt1
|
_numfmt1
struct _numfmt1 { double d(1); char c; }
|
_numfmt1
|
_numfmt1
struct _numfmt1 { char c; }
|
_numfmt2
|
_numfmt2
struct _numfmt2 { char x; float y; }
|
_numfmt2
|
_numfmt2
struct _numfmt2 { char x; double y; }
|
_numfmt2
|
_numfmt2
struct _numfmt2 { char x; char y; }
|
_numfmt2
|
_numfmt2
struct _numfmt2 { char x; short y; }
|
_numfmt2
|
_numfmt2
struct _numfmt2 { char x; _numfmt1 y; }
|
_numfmt2
|
_numfmt2
struct _numfmt2 { char x; int y; }
|
_numfmt2
|
_numfmt2
struct _numfmt2 { char x; long y; }
|
_numfmt2
|
_numfmt2
struct _numfmt2 { char x; pointer y; }
|
_numfmt2
|
_numfmt2
struct _numfmt2 { char x; _numfmt1 y; }
|
_nxt
|
item= _nxt(list)
return first item in LIST, and set LIST to list of remaining
items. If you are iterating through a list, this is the way
to do it, since a loop on _car(list,i) with i varying from 1
to _len(list) scales quadratically with the length of the list,
while a loop on _nxt(list) scales linearly.
interpreted function, defined at i0/std.i line 3185
|
SEE ALSO:
|
_car,
_lst
|
_prt
|
_prt, list
print every item in a list, recursing if some item is itself a list.
interpreted function, defined at i0/std.i line 3130
|
SEE ALSO:
|
_lst
|
_read
|
_write, file, address, expression
_read, file, address, variable
or nbytes= _read(file, address, variable);
are low level read and write functions which do not "see" the
symbol table for the binary FILE. The ADDRESS is the byte address
at which to begin the write or read operation. The type and number
of objects of the EXPRESSION or VARIABLE determines how much data
to read, and what format conversion operations to apply. In the
case of type char, no conversion operations are ever applied, and
_read will return the actual number of bytes read, which may be
fewer than the number implied by VARIABLE in this one case.
(In all other cases, _read returns numberof(VARIABLE).)
If the FILE has records, the ADDRESS is understood to be in the
file family member in which the current record resides.
builtin function, documented at i0/std.i line 2568
|
SEE ALSO:
|
openb,
createb,
updateb,
save,
restore,
sizeof
|
_rev
|
_rev(list)
returns the input list in reverse order
interpreted function, defined at i0/std.i line 3169
|
SEE ALSO:
|
_lst
|
_rot3
|
_rot3
interpreted function, defined at i/pl3d.i line 76
|
_rotate
|
interpreted function, defined at contrib/gadget.i line 975
|
SEE ALSO:
|
|
|