section a of routines in global.i Home

Manual

Packages

Global Index

Keywords

Quick Reference

# all functions - a

 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+...). builtin function, documented at i0/std.i line 630 ``` SEE ALSO: sign,   sqrt

 accum ``` accum interpreted function, defined at i/test1.i line 225 ```

 accumulate ``` alm= accumulate(n, f, mesh, rcap, rtrack, pts, dylm, flux, nrpp) Do N batches (approximately rays_per_batch each, default 13000) of rays from file F, MESH = hydra_mesh(F), analyzing the symmetry of a capsule of radius RCAP (all rays tangent to this sphere), tracing the rays only down to radius RTRACK (>1.001*RCAP). This routine is designed to be called several times successively to get better statistics. PTS, DYLM, FLUX, and NRPP are all updated. PTS = unit vectors in directions of points on capsule surface defaults to bucky(3,1): 1280 points with an intrinsic fidelity of about 1% out to l=12 use bucky(4,1,domega), dylm= get_ylm(pts,lmax,list)*domega(-,..) to get 5120 points and intrinsic fidelity of about 0.2% at l=12 DYLM = ylm*domega for PTS FLUX = accumulated flux at each of PTS; units are power/area NRPP = accumulated number of rays per point of capsule surface ALM = 91 coefficients of Ylm up to l=12 corresponding to FLUX l= [0, 1,1, 2,2,2, 3,3,3,3, 4,4,4,4,4, ...] m= [0, 0,1, 0,1,2, 0,1,2,3, 0,1,2,3,4, ...] interpreted function, defined at i/ylmdec.i line 158 ```

 acos ``` acos(x) returns the inverse cosine of its argument, range [0, pi]. builtin function, documented at i0/std.i line 535 ``` SEE ALSO: sin,   cos,   tan,   asin,   acos,   atan

 acosh ``` acosh interpreted function, defined at i0/std.i line 576 ``` SEE asinh

 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. builtin function, documented at i0/std.i line 2454 ``` SEE ALSO: add_variable,   install_struct,   struct_align

 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. builtin function, documented at i0/std.i line 2521 ``` SEE ALSO: openb,   updateb,   createb,   add_record

 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. builtin function, documented at i0/std.i line 2279 ``` SEE ALSO: save,   createb,   updateb,   openb,   set_filesize,   set_blocksize,   add_variable

 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. builtin function, documented at i0/std.i line 2313 ``` SEE ALSO: save,   openb,   createb,   updateb,   add_record,   add_member,   install_struct,   data_align

 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. interpreted function, defined at i0/drat.i line 427 ``` 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. interpreted function, defined at i/pl3d.i line 98 ``` SEE ALSO: mov3,   rot3,   orient3,   setz3,   undo3,   save3,   restore3,   light3

 alloc_mesh ``` alloc_mesh interpreted function, defined at i0/drat.i line 1017 ```

 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. builtin function, documented at i0/std.i line 742 ``` SEE ALSO: allof,   anyof,   noneof,   nallof,   where,   where2

 alpha_primitives ``` alpha_primitives, file sets FILE primitive data types to be native to DEC alpha workstations. interpreted function, defined at i0/std.i line 1987 ```

 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). builtin function, documented at i0/std.i line 508 ```

 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. builtin function, documented at i0/graph.i line 265 ``` SEE ALSO: window,   fma,   plg

 any_in ``` any_in(left,x,right, mask, xx, a,aa, b,bb, c,cc return the number of elements of the array X which are in the interval LEFT < X <= RIGHT. Also return MASK, which has the shape of X and is 1 where X is in the interval and 0 otherwise, and XX = X(where(MASK)). Up to three optional arrays A, B, and C of the same shape as X may be supplied; the arrays AA, BB, and CC analogous to XX are returned. LEFT or RIGHT may be [] for the interval to extend to infinity on the corresponding side. LEFT and/or RIGHT may be arrays as long as they are conformable with X. interpreted function, defined at i/dawson.i line 129 ``` SEE ALSO: merge_n,   merge

 anyof ``` anyof builtin function, documented at i0/std.i line 742 ``` 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. interpreted function, defined at i0/drat.i line 379 ```

 approx_eq ``` approx_eq ```

 approx_eq ``` approx_eq ```

 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. interpreted function, defined at i0/std.i line 2702 ``` 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). builtin function, documented at i0/std.i line 309 ``` SEE ALSO: reshape,   is_array,   dimsof,   numberof,   grow,   span,   use_origins,   _lst

 asin ``` asin(x) returns the inverse sine of its argument, range [-pi/2, pi/2]. builtin function, documented at i0/std.i line 529 ``` SEE ALSO: sin,   cos,   tan,   asin,   acos,   atan

 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. interpreted function, defined at i0/std.i line 576 ``` SEE ALSO: sinh,   cosh,   tanh,   sech,   csch

 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).) builtin function, documented at i0/std.i line 541 ``` SEE ALSO: sin,   cos,   tan,   asin,   acos,   atan

 atanh ``` atanh interpreted function, defined at i0/std.i line 576 ``` SEE asinh

 avg ``` avg(x) returns the scalar average of all elements of its array argument. builtin function, documented at i0/std.i line 736 ``` SEE ALSO: sum,   min,   max