Google

section _ of routines in global.i

yorick banner

Home

Manual

Packages

Global Index

Keywords

Quick Reference

all functions - _

 
 
 
_


 _  
 
builtin function, documented at i0/std.i   line 857  
SEE grow  
 
 
 
_3cage


 _3cage  
 
  

interpreted function, defined at i/pl3d.i   line 1017  
 
 
 
_3interference


 _3interference  
 
  

interpreted function, defined at i/pl3d.i   line 1274  
 
 
 
_3remove


 _3remove  
 
  

interpreted function, defined at i/pl3d.i   line 1308  
 
 
 
_3ticks


 _3ticks  
 
  

interpreted function, defined at i/pl3d.i   line 1320  
 
 
 
_car


 _car  
 
builtin function, documented at i0/std.i   line 2921  
SEE _lst  
 
 
 
_cat


 _cat  
 
builtin function, documented at i0/std.i   line 2921  
SEE _lst  
 
 
 
_cauer_parameter


 _cauer_parameter  
 
  

interpreted function, defined at i/filter.i   line 435  
 
 
 
_cdr


 _cdr  
 
builtin function, documented at i0/std.i   line 2921  
SEE _lst  
 
 
 
_cheby_eval


 _cheby_eval  
 
  

interpreted function, defined at i/dawson.i   line 116  
 
 
 
_construct3


 _construct3  
 
  

interpreted function, defined at i/slice3.i   line 792  
 
 
 
_cpy


 _cpy  
 
builtin function, documented at i0/std.i   line 2921  
SEE _lst  
 
 
 
_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  
 
 
 
_draw3_idler


 _draw3_idler  
 
  

interpreted function, defined at i/pl3d.i   line 709  
 
 
 
_dummy_write


 _dummy_write  
 
  

interpreted function, defined at i/netcdf.i   line 488  
 
 
 
_fact_extract


 _fact_extract  
 
  

interpreted function, defined at i/gcd.i   line 133  
 
 
 
_fitsGetInteger


 _fitsGetInteger  
 
  

interpreted function, defined at i/fits.i   line 706  
 
 
 
_fitsGetLogical


 _fitsGetLogical  
 
  

interpreted function, defined at i/fits.i   line 693  
 
 
 
_fitsGetReal


 _fitsGetReal  
 
  

interpreted function, defined at i/fits.i   line 714  
 
 
 
_fitsGetString


 _fitsGetString  
 
  

interpreted function, defined at i/fits.i   line 722  
 
 
 
_fitsPutComment


 _fitsPutComment  
 
  

interpreted function, defined at i/fits.i   line 785  
 
 
 
_fitsPutEnd


 _fitsPutEnd  
 
  

interpreted function, defined at i/fits.i   line 793  
 
 
 
_fitsPutInteger


 _fitsPutInteger  
 
  

interpreted function, defined at i/fits.i   line 761  
 
 
 
_fitsPutLogical


 _fitsPutLogical  
 
  

interpreted function, defined at i/fits.i   line 779  
 
 
 
_fitsPutReal


 _fitsPutReal  
 
  

interpreted function, defined at i/fits.i   line 767  
 
 
 
_fitsPutString


 _fitsPutString  
 
  

interpreted function, defined at i/fits.i   line 773  
 
 
 
_fitsPutValue


 _fitsPutValue  
 
  

interpreted function, defined at i/fits.i   line 742  
 
 
 
_get_matrix


 _get_matrix  
 
  

interpreted function, defined at i0/matrix.i   line 529  
 
 
 
_get_msize


 _get_msize  
 
  

builtin function, documented at i0/drat.i   line 1329  
 
 
 
_getorg3


 _getorg3  
 
  

interpreted function, defined at i/pl3d.i   line 558  
 
 
 
_getrot3


 _getrot3  
 
  

interpreted function, defined at i/pl3d.i   line 554  
 
 
 
_getscl3


 _getscl3  
 
  

interpreted function, defined at i/pl3d.i   line 570  
 
 
 
_getzc3


 _getzc3  
 
  

interpreted function, defined at i/pl3d.i   line 566  
 
 
 
_gnomon_draw


 _gnomon_draw  
 
  

interpreted function, defined at i/pl3d.i   line 761  
 
 
 
_gnomon_text


 _gnomon_text  
 
  

interpreted function, defined at i/pl3d.i   line 863  
 
 
 
_hblk_bc


 _hblk_bc  
 
  

interpreted function, defined at i/hydra.i   line 57  
 
 
 
_hblk_bnd


 _hblk_bnd  
 
  

interpreted function, defined at i/hydra.i   line 52  
 
 
 
_hblk_var


 _hblk_var  
 
  

interpreted function, defined at i/hydra.i   line 47  
 
 
 
_hy_auto_version


 _hy_auto_version  
 
  

interpreted function, defined at i/hydra.i   line 42  
 
 
 
_hy_global


 _hy_global  
 
  

interpreted function, defined at i/hydra.i   line 62  
 
 
 
_hy_gmap


 _hy_gmap  
 
  

interpreted function, defined at i/hydra.i   line 67  
 
 
 
_hy_umap


 _hy_umap  
 
  

interpreted function, defined at i/hydra.i   line 72  
 
 
 
_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 1886  
 
 
 
_init_drat


 _init_drat  
 
  

builtin function, documented at i0/drat.i   line 1337  
 
 
 
_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 1875  
SEE ALSO: createb,   recover_file,   at_pdb_close  
 
 
 
_isosurface_slicer


 _isosurface_slicer  
 
  

interpreted function, defined at i/slice3.i   line 478  
 
 
 
_jc


 _jc  
 
builtin function, documented at i0/std.i   line 2250  
SEE _jr  
 
 
 
_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 2250  
 
 
 
_jt


 _jt  
 
builtin function, documented at i0/std.i   line 2250  
SEE _jr  
 
 
 
_len


 _len  
 
builtin function, documented at i0/std.i   line 2921  
SEE _lst  
 
 
 
_light3


 _light3  
 
  

interpreted function, defined at i/pl3d.i   line 348  
 
 
 
_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 2921  
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 3015  
SEE ALSO: _lst  
 
 
 
_multi__init


 _multi__init  
 
  

interpreted function, defined at i/multi.i   line 510  
 
 
 
_multi_accum


 _multi_accum  
 
  

interpreted function, defined at i/multi.i   line 850  
 
 
 
_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_chunk


 _multi_chunk  
 
  

interpreted function, defined at i/multi.i   line 705  
 
 
 
_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  
 
 
 
_multi_jt


 _multi_jt  
 
  

interpreted function, defined at i/multi.i   line 458  
 
 
 
_multi_names


 _multi_names  
 
  

interpreted function, defined at i/multi.i   line 1056  
 
 
 
_multi_spectreg


 _multi_spectreg  
 
  

interpreted function, defined at i/multi.i   line 814  
 
 
 
_multi_times


 _multi_times  
 
  

interpreted function, defined at i/multi.i   line 1262  
 
 
 
_nbow_print


 _nbow_print  
 
  

interpreted function, defined at i/bowtie.i   line 125  
 
 
 
_nc_add_next_file


 _nc_add_next_file  
 
  

interpreted function, defined at i/netcdf.i   line 115  
 
 
 
_nc_declare


 _nc_declare  
 
  

interpreted function, defined at i/netcdf.i   line 129  
 
 
 
_nc_desc_len


 _nc_desc_len  
 
  

interpreted function, defined at i/netcdf.i   line 478  
 
 
 
_not_cdf


             _not_cdf(file)  
 
     is like _not_pdb, but for netCDF files.  

interpreted function, defined at i0/std.i   line 1899  
 
 
 
_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 1779  
 
 
 
_not_pdbf


 _not_pdbf  
 
  

interpreted function, defined at i0/std.i   line 1873  
 
 
 
_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 3052  
SEE ALSO: _car,   _lst  
 
 
 
_obasis


 _obasis  
 
  

interpreted function, defined at i/basfix.i   line 27  
 
 
 
_pl3leaf


 _pl3leaf  
 
  

interpreted function, defined at i/slice3.i   line 1304  
 
 
 
_pl3tree


 _pl3tree  
 
  

interpreted function, defined at i/slice3.i   line 1268  
 
 
 
_pl3tree_accum


 _pl3tree_accum  
 
  

interpreted function, defined at i/slice3.i   line 1341  
 
 
 
_pl3tree_add


 _pl3tree_add  
 
  

interpreted function, defined at i/slice3.i   line 1384  
 
 
 
_pl3tree_count


 _pl3tree_count  
 
  

interpreted function, defined at i/slice3.i   line 1335  
 
 
 
_pl3tree_prt


 _pl3tree_prt  
 
  

interpreted function, defined at i/slice3.i   line 1443  
 
 
 
_pl3tree_slice


 _pl3tree_slice  
 
  

interpreted function, defined at i/slice3.i   line 1412  
 
 
 
_pl_init


 _pl_init  
 
  

builtin function, documented at i0/graph.i   line 1387  
 
 
 
_plane_slicer


 _plane_slicer  
 
  

interpreted function, defined at i/slice3.i   line 483  
 
 
 
_pnm_image


 _pnm_image  
 
  

interpreted function, defined at i/pnm.i   line 180  
 
 
 
_pnm_rawrd


 _pnm_rawrd  
 
  

interpreted function, defined at i/pnm.i   line 126  
 
 
 
_pnm_token


 _pnm_token  
 
  

interpreted function, defined at i/pnm.i   line 144  
 
 
 
_pnm_txtrd


 _pnm_txtrd  
 
  

interpreted function, defined at i/pnm.i   line 69  
 
 
 
_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 2997  
SEE ALSO: _lst  
 
 
 
_raw1_flat


 _raw1_flat  
 
  

builtin function, documented at i0/drat.i   line 1294  
 
 
 
_raw1_linear


 _raw1_linear  
 
  

builtin function, documented at i0/drat.i   line 1308  
 
 
 
_raw2_flat


 _raw2_flat  
 
  

builtin function, documented at i0/drat.i   line 1301  
 
 
 
_raw2_linear


 _raw2_linear  
 
  

builtin function, documented at i0/drat.i   line 1315  
 
 
 
_raw_pcens


 _raw_pcens  
 
  

builtin function, documented at i0/drat.i   line 1322  
 
 
 
_raw_track


 _raw_track  
 
  

builtin function, documented at i0/drat.i   line 1288  
 
 
 
_ray_integ


 _ray_integ  
 
  

builtin function, documented at i0/hex.i   line 468  
 
 
 
_ray_reduce


 _ray_reduce  
 
  

builtin function, documented at i0/hex.i   line 462  
 
 
 
_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 2435  
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 3036  
SEE ALSO: _lst  
 
 
 
_rez_center


 _rez_center  
 
  

builtin function, documented at i/rezone.i   line 1491  
 
 
 
_roll2


 _roll2  
 
  

builtin function, documented at i0/fft.i   line 323  
 
 
 
_root_gmap


 _root_gmap  
 
  

interpreted function, defined at i/hydra.i   line 77  
 
 
 
_root_umap


 _root_umap  
 
  

interpreted function, defined at i/hydra.i   line 81  
 
 
 
_rot3


 _rot3  
 
  

interpreted function, defined at i/pl3d.i   line 76  
 
 
 
_scalar_err


 _scalar_err  
 
  

interpreted function, defined at i/string.i   line 325  
 
 
 
_set_pdb


 _set_pdb  
 
builtin function, documented at i0/std.i   line 1875  
SEE _init_pdb  
 
 
 
_setorg3


 _setorg3  
 
  

interpreted function, defined at i/pl3d.i   line 582  
 
 
 
_setrot3


 _setrot3  
 
  

interpreted function, defined at i/pl3d.i   line 578  
 
 
 
_setscl3


 _setscl3  
 
  

interpreted function, defined at i/pl3d.i   line 590  
 
 
 
_setzc3


 _setzc3  
 
  

interpreted function, defined at i/pl3d.i   line 586  
 
 
 
_slice2_part


 _slice2_part  
 
  

interpreted function, defined at i/slice3.i   line 1034  
 
 
 
_spin3


 _spin3  
 
  

interpreted function, defined at i/pl3d.i   line 970  
 
 
 
_strcase


 _strcase  
 
  

interpreted function, defined at i/string.i   line 104  
 
 
 
_strchr


 _strchr  
 
  

interpreted function, defined at i/string.i   line 171  
 
 
 
_strcloop


 _strcloop  
 
  
r  

interpreted function, defined at i/string.i   line 182  
 
 
 
_strtrim


 _strtrim  
 
  

interpreted function, defined at i/string.i   line 141  
 
 
 
_style_axis


 _style_axis  
 
  

interpreted function, defined at i/style.i   line 478  
 
 
 
_style_goof


 _style_goof  
 
  

interpreted function, defined at i/style.i   line 622  
 
 
 
_style_legends


 _style_legends  
 
  

interpreted function, defined at i/style.i   line 433  
 
 
 
_style_line


 _style_line  
 
  

interpreted function, defined at i/style.i   line 542  
 
 
 
_style_system


 _style_system  
 
  

interpreted function, defined at i/style.i   line 403  
 
 
 
_style_text


 _style_text  
 
  

interpreted function, defined at i/style.i   line 520  
 
 
 
_style_ticks


 _style_ticks  
 
  

interpreted function, defined at i/style.i   line 453  
 
 
 
_style_token


 _style_token  
 
  

interpreted function, defined at i/style.i   line 563  
 
 
 
_style_vector


 _style_vector  
 
  

interpreted function, defined at i/style.i   line 504  
 
 
 
_style_wline


 _style_wline  
 
  

interpreted function, defined at i/style.i   line 294  
 
 
 
_style_wtext


 _style_wtext  
 
  

interpreted function, defined at i/style.i   line 300  
 
 
 
_style_wvect


 _style_wvect  
 
  

interpreted function, defined at i/style.i   line 283  
 
 
 
_to_real_system


 _to_real_system  
 
  

interpreted function, defined at i0/matrix.i   line 199  
 
 
 
_undo3_set


 _undo3_set  
 
  

interpreted function, defined at i/pl3d.i   line 596  
 
 
 
_walk3


 _walk3  
 
  

interpreted function, defined at i/slice3.i   line 816  
 
 
 
_wf_safe


 _wf_safe  
 
  

interpreted function, defined at i/plwf.i   line 192  
 
 
 
_write


 _write  
 
builtin function, documented at i0/std.i   line 2435  
SEE _read  
 
 
 
_ylm_test


 _ylm_test  
 
  

interpreted function, defined at i/ylmdec.i   line 104