home
manual
quick ref.
packages
index
keywords
examples




tan

 
unknown type function, documented at startup/std.i   line 524  
 
SEE sin




tanh

 
unknown type function, documented at startup/std.i   line 562  
 
SEE sinh




test1

 
             test1  
          or test1, npass  
  
     Track a mock "ablation front" as it propagates through a mesh.  
     If NPASS is given, the calculation is repeated that many  
     times.  The zoning, densities, temperatures, pressures, and  
     velocities are all computed arbitrarily, but the number of zones  
     and groups are taken to be representative of a typical 1-D  
     ablation calculation.  */  

unknown type function, documented at include/test1.i   line 23  
 




test2

 
             test2  
          or test2, npass  
  
     Given a slab divided into zones by parallel planes, and given a  
     set of photon group boundary energies, compute the contribution of  
     each zone to the radiation flux emerging from one surface of the  
     slab.  If NPASS is given, the calculation is repeated that many  
     times.  The zoning, photon group structure, opacities, and source  
     functions are all computed arbitrarily, but the number of zones  
     and groups are taken to be representative of a typical 1-D  
     radiation transport calculation.  */  

unknown type function, documented at include/test2.i   line 23  
 




test3

 
             test3  
          or test3, npass  
  
     Computes the ratio r which solves 1 + r^2 + r^3 +...+ r^n = s,  
     given n and s.  If NPASS is given, the calculation is repeated  
     that many times (actually the equation is solved many times for  
     each pass).  The worker routine invgeom can actually be  
     vectorized; the vector version is gseries_r in series.i.  */  

unknown type function, documented at include/test3.i   line 20  
 




testb

 
             testb  
          or testb, 1      (prints yorick_stats)  
  
     Perform systematic test of all features of Yorick's binary I/O  
     package.  This extends the simple test in testp.i.  

unknown type function, documented at include/testb.i   line 25  
 




testg

 
             testg  
  
     runs a Yorick near-equivalent of Steve Langer's grbench graphics  
     timing benchmark.  

unknown type function, documented at include/testg.i   line 26  
 
SEE ALSO: lissajous, grtest, txtest




testlp

 
             testlp  
  
     Run a benchmark of Yorick's LUsolve routine similar to the  
     Linpack benchmark.  

unknown type function, documented at include/testlp.i   line 19  
 




timer

 
             timer, elapsed  
          or timer, elapsed, split  
  
     updates the ELAPSED and optionally SPLIT timing arrays.  These  
     arrays must each be of type array(double,3); the layout is  
     [cpu, system, wall], with all three times measured in seconds.  
     ELAPSED is updated to the total times elapsed since this copy  
     of Yorick started.  SPLIT is incremented by the difference between  
     the new values of ELAPSED and the values of ELAPSED on entry.  
     This feature allows for primitive code profiling by keeping  
     separate accounting of time usage in several categories, e.g.--  
        elapsed= total= cat1= cat2= cat3= array(double, 3);  
        timer, elapsed0;  
	elasped= elapsed0;  
        ... category 1 code ...  
	timer, elapsed, cat1;  
        ... category 2 code ...  
	timer, elapsed, cat2;  
        ... category 3 code ...  
	timer, elapsed, cat3;  
        ... more category 2 code ...  
	timer, elapsed, cat2;  
        timer, elapsed0, total;  
     The wall time is not absolutely reliable, owning to possible  
     rollover at midnight.  

unknown type function, documented at startup/std.i   line 2525  
 
SEE ALSO: timestamp, timer_print




timer_print

 
             timer_print, label1, split1, label2, split2, ...  
          or timer_print  
          or timer_print, label_total  
  
     prints out a timing summary for splits accumulated by timer.  
        timer_print, "category 1", cat1, "category 2", cat2,  
                     "category 3", cat3, "total", total;  

unknown type function, documented at startup/std.i   line 2544  
 
SEE ALSO: timer




timestamp

 
             timestamp()  
  
     returns string of the form "Sun Jan  3 15:14:13 1988" -- always  
     has 24 characters.  

unknown type function, documented at startup/std.i   line 2497  
 
SEE ALSO: timer




to_corners3

 
             to_corners(list, ni, nj)  
  
     convert a LIST of cell indices in an (NI-1)-by-(NJ-1)-by-(nk-1)  
     logically rectangular grid of cells into the list of  
     2-by-2-by-2-by-numberof(LIST) cell corner indices in the  
     corresponding NI-by-NJ-by-nk list of vertices.  

unknown type function, documented at include/slice3.i   line 502  
 




to_hsv

 
             hsv= to_hsv(rgb)  
          or hsv= to_hsv([r,g,b])  
  
     return the HSV representation of the n-by-3 array of RGB colors  
     rgb: red, green, blue from 0 to 255  
     hsv: h= hue in degrees, red=0, green=120, blue=240  
          s= saturation from 0 (gray) to 1 (full hue)  
          v= value from 0 (black) to 1 (full intensity)  
	  s= 1 - min(r,g,b)/max(r,g,b)  
          v= max(r,g,b)  

unknown type function, documented at include/color.i   line 130  
 
SEE ALSO: to_rgb




to_rgb

 
             rgb= to_rgb(hsv)  
          or rgb= to_rgb([h,s,v])  
  
     return the RGB representation of the n-by-3 array of HSV colors  
     rgb: red, green, blue from 0 to 255  
     hsv: h= hue in degrees, red=0, green=120, blue=240  
          s= saturation from 0 (gray) to 1 (full hue)  
          v= value from 0 (black) to 1 (full intensity)  
	  s= 1 - min(r,g,b)/max(r,g,b)  
          v= max(r,g,b)/255  

unknown type function, documented at include/color.i   line 85  
 
SEE ALSO: to_hsv




toy_mesh

 
             toy_mesh, filename  
  
     generates a toy mesh in the file FILENAME in order to be able to  
     play with the rezone function.  (FILENAME must be a string enclosed  
     in double quotes, of course.)  

unknown type function, documented at include/rezone.i   line 29  
 
SEE ALSO: rezone




track_rays

 
             ray_paths= track_rays(rays, mesh, slimits)  
  
     returns array of Ray_Path structs representing the progress of  
     RAYS through the MESH between the given SLIMITS.  

unknown type function, documented at startup/drat.i   line 1254  
 
SEE ALSO: Ray_Path, integ_flat, get_ray-path




transpose

 
             transpose(x)  
          or transpose(x, permutation1, permutation2, ...)  
  
     transpose the first and last dimensions of array X.  In the second  
     form, each PERMUTATION specifies a simple permutation of the  
     dimensions of X.  These permutations are compounded left to right  
     to determine the final permutation to be applied to the dimensions  
     of X.  Each PERMUTATION is either an integer or a 1D array of  
     integers.  A 1D array specifies a cyclic permutation of the  
     dimensions as follows: [3, 5, 2] moves the 3rd dimension to the  
     5th dimension, the 5th dimension to the 2nd dimension, and the 2nd  
     dimension to the 3rd dimension.  Non-positive numbers count from the  
     end of the dimension list of X, so that 0 is the final dimension,  
     -1 in the next to last, etc.  A scalar PERMUTATION is a shorthand  
     for a cyclic permutation of all of the dimensions of X.  The value  
     of the scalar is the dimension to which the 1st dimension will move.  
  
     Examples:  Let x have dimsof(x) equal [6, 1,2,3,4,5,6] in order  
        to be able to easily identify a dimension by its length. Then:  
	dimsof(x)                          == [6, 1,2,3,4,5,6]  
	dimsof(transpose(x))               == [6, 6,2,3,4,5,1]  
        dimsof(transpose(x,[1,2]))         == [6, 2,1,3,4,5,6]  
	dimsof(transpose(x,[1,0]))         == [6, 6,2,3,4,5,1]  
	dimsof(transpose(x,2))             == [6, 6,1,2,3,4,5]  
	dimsof(transpose(x,0))             == [6, 2,3,4,5,6,1]  
	dimsof(transpose(x,3))             == [6, 5,6,1,2,3,4]  
	dimsof(transpose(x,[4,6,3],[2,5])) == [6, 1,5,6,3,2,4]  

unknown type function, documented at startup/std.i   line 1088  
 




tspline

 
             d2ydx2= tspline(tension, y, x)  
  
       -or-     yp= tspline(tension, d2ydx2, y, x, xp)  
       -or-     yp= tspline(tension, y, x, xp)  
     computes a tensioned spline curve passing through the points (X, Y).  
  
     The first argument, TENSION, is a positive number which determines  
     the "tension" in the spline.  In a cubic spline, the second derivative  
     of the spline function varies linearly between the points X.  In the  
     tensioned spline, the curvature is concentrated near the points X,  
     falling off at a rate proportional to the tension.  Between the points  
     of X, the function varies as:  
           y= C1*exp(k*x) + C2*exp(-k*x) + C3*x + C4  
     The parameter k is proportional to the TENSION; for k->0, the function  
     reduces to the cubic spline (a piecewise cubic function), while for  
     k->infinity, the function reduces to the piecewise linear function  
     connecting the points.  The TENSION argument may either be a scalar  
     value, in which case, k will be TENSION*(numberof(X)-1)/(max(X)-min(X))  
     in every interval of X, or TENSION may be an array of length one less  
     than the length of X, in which case the parameter k will be  
     abs(TENSION/X(dif)), possibly varying from one interval to the next.  
     You can use a variable tension to flatten "bumps" in one interval  
     without affecting nearby intervals.  Internally, tspline forces  
     k*X(dif) to lie between 0.01 and 100.0 in every interval, independent  
     of the value of TENSION.  Typically, the most dramatic variation  
     occurs between TENSION of 1.0 and 10.0.  
  
     With three arguments, Y and X, spline returns the derivatives D2YDX2 at  
     the points, an array of the same length as X and Y.  The D2YDX2 values  
     are chosen so that the tensioned spline function returned by the five  
     argument call will have a continuous first derivative.  
  
     The X array must be strictly monotonic; it may either increase or  
     decrease.  
  
     The values Y and the derivatives D2YDX2 uniquely determine a tensioned  
     spline function, whose value is returned in the five argument form.  
     In this form, tspline is analogous to the piecewise linear interpolator  
     interp; usually you will regard it as a continuous function of its  
     fifth (or fourth) argument, XP.  
  
     The XP array may have any dimensionality; the result YP will have  
     the same dimensions as XP.  
  
     The D2YDX2 argument will normally have been computed by a previous call  
     to the three argument tspline function.  If you will be computing the  
     values of the spline function for many sets of XP, use this five  
     argument form.  
  
     If you only want the tspline evaluated at a single set of XP, use the  
     four argument form.  This is equivalent to:  
          yp= tspline(tension, tspline(tension,y,x), y, x, xp)  
  
     The keywords DYDX1 and DYDX0 can be used to set the values of the  
     returned DYDX(1) and DYDX(0) -- the first and last values of the  
     slope, respectively.  If either is not specified or nil, the slope at  
     that end will be chosen so that the second derivative is zero there.  
  
     The function tspline (tensioned spline) gives an interpolation  
     function which lies between spline and interp, at the cost of  
     requiring you to specify another parameter (the tension).  
  

unknown type function, documented at include/spline.i   line 195  
 
SEE ALSO: interp, tspline




txtest

 
             txtest  
             txtest, n  
  
     Print some tests of Yorick's plt command.  Start with the nth  
     page in the second form.  

unknown type function, documented at include/testg.i   line 534  
 




typeof

 
             typeof(object)  
  
     returns a string describing the type of object.  For the basic  
     data types, these are "char", "short", "int", "long", "float",  
     "double", "complex", "string", "pointer", "struct_instance",  
     "void", "range", "struct_definition", "function", "builtin",  
     "stream" (for a binary stream), and "text_stream".  

unknown type function, documented at startup/std.i   line 404  
 
SEE ALSO: structof, dimsof, sizeof, numberof, nameof






home
manual
quick ref.
packages
index
keywords
examples
LLNL Disclaimers