|
|
|
|
|
|
|
|
|
abs
|
abs(x)
or abs(x, y, z, ...)
returns the absolute value of its argument.
In the multi-argument form, returns sqrt(x^2+y^2+z^2+...).
unknown type function, documented at startup/std.i line 633
| |
| SEE ALSO: |
sign, function |
|
|
acos
|
acos(x)
returns the inverse cosine of its argument, range [0, pi].
unknown type function, documented at startup/std.i line 536
| |
| SEE ALSO: |
sin, |
|
|
add_member
|
add_member, file, struct_name, offset, name, type, dimlist
adds a member to a data type in the file FILE. The data type name
(struct name) is STRUCT_NAME, which will be created if it does
not already exist. The new member will be at OFFSET (in bytes)
from the beginning of an instance of this structure, and will
have the specified NAME, TYPE, and DIMLIST. Use OFFSET -1 to
have add_member compute the next available offset in the structure.
The TYPE can be either a structure definition, or a string naming
a previously defined data type in FILE. The optional DIMLIST is
as for the "array" function.
The STRUCT_NAME built from a series of add_member calls cannot be
used until it is installed with install_struct.
This function should be used very sparingly, mostly in code which
is building the structure of a foreign-format binary file.
unknown type function, documented at startup/std.i line 2330
| |
| SEE ALSO: |
add_variable, |
|
|
add_next_file
|
failure= add_next_file(file, filename, create_flag)
adds the next file to the FILE, which must contain history records.
If FILENAME is non-nil, the new file will be called that, otherwise
the next sequential filename is used. If CREATE_FLAG is present
and non-zero, the new file will be created if it does not already
exist. If omitted or nil, CREATE_FLAG defaults to 1 if the file has
write permission and 0 if it does not.
Returns 0 on success.
unknown type function, documented at startup/std.i line 2391
| |
| SEE ALSO: |
openb, |
|
|
add_record
|
add_record, file, time, ncyc
or add_record, file, time, ncyc, address
or add_record, file
adds a new record to FILE corresponding to the specified TIME and
NCYC (respectively a double and a long). Either or both TIME
and NCYC may be nil or omitted, but the existence of TIME and
NCYC must be the same for every record added to one FILE.
If present, ADDRESS specifies the disk address of the new record,
which is assumed to be in the current file. Without ADDRESS, or
if ADDRESS<0, the next available address is used; this may create
a new file in the family (see the set_filesize function).
The add_record function leaves the new record current
for subsequent save commands to actually write the data.
The TIME, NCYC, and ADDRESS arguments may be equal length vectors
to add several records at once; in this case, the first of the
newly added records is the current one. If all three of TIME,
NCYC, and ADDRESS are nil or omitted, no new records are added,
but the file becomes a record file if it was not already, and in
any case, no record will be the current record after such an
add_record call.
After the first add_record call (even if no records were added),
subsequent add_variable commands will create record variables.
After the first record has been added, subsequent save commands
will create any new variables as record variables.
After a second record has been added using add_record, neither
save commands nor add_variable commands may be used to introduce
any new record variables.
unknown type function, documented at startup/std.i line 2184
| |
| SEE ALSO: |
save, set_blocksize, |
|
|
add_variable
|
add_variable, file, address, name, type, dimlist
adds a variable NAME to FILE at the specified ADDRESS, with the
specified TYPE and dimensions given by DIMLIST. The DIMLIST may
be zero or more arguments, as for the "array" function. If the
ADDRESS is <0, the next available address is used. Note that,
unlike the save command, add_variable does not actually write any
data -- it merely changes Yorick's description of the contents of
FILE.
After the first add_record call, add_variable adds a variable to
the record instead of a non-record variable. See add_record.
unknown type function, documented at startup/std.i line 2199
| |
| SEE ALSO: |
save, add_member, |
|
|
adjust_ireg
|
adjust_ireg(ireg)
returns the input IREG with the regions specified in drat_ireg_adj
zeroed. Beware-- the ireg array is actually modified.
unknown type function, documented at startup/drat.i line 442
| |
| SEE ALSO: |
drat_ireg_adj |
|
|
aim3
|
aim3, xa,ya,za
move the current 3D plot to put the point (XA,YA,ZA) in object
coordinates at the point (0,0,0) -- the aim point -- in the
viewer's coordinates. If any of XA, YA, or ZA is nil, it defaults
to zero.
unknown type function, documented at include/pl3d.i line 112
| |
| SEE ALSO: |
mov3, restore3, |
|
|
allof
|
allof(x)
anyof(x)
nallof(x)
noneof(x)
Respectively:
returns 1 if every element of the array x is non-zero, else 0.
returns 1 if at least one element of the array x is non-zero, else 0.
returns 1 if at least one element of the array x is zero, else 0.
returns 1 if every element of the array x is zero, else 0.
unknown type function, documented at startup/std.i line 753
| |
| SEE ALSO: |
allof, |
|
|
alpha_primitives
|
alpha_primitives, file
sets FILE primitive data types to be native to DEC alpha workstations.
unknown type function, documented at startup/std.i line 1969
| |
|
am_subroutine
|
am_subroutine()
returns 1 if the current Yorick function was invoked as a subroutine,
else 0. If am_subroutine() returns true, the result of the current
function will not be used, and need not be computed (the function
has been called for its side effects only).
unknown type function, documented at startup/std.i line 511
| |
|
animate
|
animate
or animate, 0/1
without any arguments, toggles animation mode; with argument 0,
turns off animation mode, with argument 1 turns on animation mode.
In animation mode, the X window associated with a graphics window
is actually an offscreen pixmap which is bit-blitted onscreen
when an fma command is issued. This is confusing unless you are
actually trying to make a movie, but results in smoother animation
if you are. Generally, you should turn animation on, run your movie,
then turn it off.
unknown type function, documented at startup/graph.i line 272
| |
| SEE ALSO: |
window, |
|
|
anyof
|
unknown type function, documented at startup/std.i line 753 | |
| SEE |
allof |
|
|
apply_funcs
|
apply_funcs(streak_result)
or apply_funcs(transp, selfem)
or apply_funcs(transp, selfem, time)
or apply_funcs(transp, selfem, times)
applies the drat_backlight and drat_channel options (if any)
to the input streak_result. This destroys the separate
transparency and self-emission information returned by streak.
transp= streak_result(,1,..) and selfem= streak_result(,2,..).
If time is not given, time=0.0 is passed to the functions.
If times is a vector, it must match the final dimension of
transp and selfem.
unknown type function, documented at startup/drat.i line 394
| |
|
area
|
area(y, x)
returns the zonal areas of the 2-D mesh (X, Y). If Y and X are
imax-by-jmax, the result is (imax-1)-by-(jmax-1). The area is
positive when, say, X increases with i and Y increases with j.
For example, area([[0,0],[1,1]],[[0,1],[0,1]]) is +1.
unknown type function, documented at startup/std.i line 2570
| |
| SEE ALSO: |
volume |
|
|
array
|
array(value, dimension_list)
or array(type, dimension_list)
returns an object of the same type as VALUE, consisting of copies
of VALUE, with the given DIMENSION_LIST appended to the dimensions
of VALUE. Hence, array(1.5, 3, 1) is the same as [[1.5, 1.5, 1.5]].
In the second form, the VALUE is taken as scalar zero of the TYPE.
Hence, array(short, 2, 3) is the same as [[0s,0s],[0s,0s],[0s,0s]].
A DIMENSION_LIST is a list of arguments, each of which may be
any of the following:
(1) A positive scalar integer expression,
(2) An index range with no step field (e.g.- 1:10), or
(3) A vector of integers [number of dims, length1, length2, ...]
(that is, the format returned by the dimsof function).
unknown type function, documented at startup/std.i line 322
| |
| SEE ALSO: |
reshape, span, |
|
|
asin
|
asin(x)
returns the inverse sine of its argument, range [-pi/2, pi/2].
unknown type function, documented at startup/std.i line 530
| |
| SEE ALSO: |
sin, |
|
|
asinh
|
asinh(x)
acosh(x)
atanh(x)
returns the inverse hyperbolic sine, cosine, or tangent of
its argument. The range of acosh is >=0.0.
unknown type function, documented at startup/std.i line 582
| |
| SEE ALSO: |
sinh, |
|
|
atan
|
atan(x)
or atan(y, x)
returns the inverse tangent of its argument, range [-pi/2, pi/2].
In the two argument form, returns the angle from (1, 0) to (x, y),
in the range (-pi, pi], with atan(1, 0)==pi/2. (If x>=0, this is
the same as atan(y/x).)
unknown type function, documented at startup/std.i line 546
| |
| SEE ALSO: |
sin, |
|
|
avg
|
avg(x)
returns the scalar average of all elements of its array argument.
unknown type function, documented at startup/std.i line 737
| |
| SEE ALSO: |
sum, |
|
|
|
|
|
|
|
|
|