Pileus Git - ~andy/rsl/blob - doc/RSL_clear.html

   1 <head>
   2 </head>
   3
   4 <body>
   5 <a HREF="index.html"> <IMG SRC="rsl.gif"> </a>
   6 <hr>
   7
   8
   9 <h1>RSL_clear_...</h1>
  10
  11 <hr>
  12
  13 <h3>Synopsis</h3>
  14 <b>#include &quot;rsl.h&quot;</b> <br>
  15 <b><a href=RSL_ray_struct.html>Ray</a> *RSL_clear_ray(<a href=RSL_ray_struct.html>Ray</a> *r);<br>
  16 <a href=RSL_sweep_struct.html>Sweep</a> *RSL_clear_sweep(<a href=RSL_sweep_struct.html>Sweep</a> *s);<br>
  17 <a href=RSL_volume_struct.html>Volume</a> *RSL_clear_volume(<a href=RSL_volume_struct.html>Volume</a> *v);</b>
  18
  19 <h3>
  20 <hr>Description</h3>
  21 <b>RSL_clear_volume</b> calls <b>RSL_clear_sweep</b> for the number of sweeps. <b>RSL_clear_sweep</b> calls <b>RSL_clear_ray</b> for the number of rays. And <b>RSL_clear_ray</b> clears the array of <b>Range</b> of size <b>nbins</b>. All header information is preserved. This may or may not be a desired capability.
  22 <hr>
  23
  24 <h3>Return value</h3>
  25 Upon successful completion, a pointer to the appropriate structure is returned.
  26 <hr>
  27
  28 <h3>See also</h3>
  29 <a href=../examples/Example_RSL_clear.c>Example</a><br>
  30 <a href=RSL_free.html>RSL_free_volume</a>, <a href=RSL_free.html>RSL_free_sweep</a>, <a href=RSL_free.html>RSL_free_ray</a>
  31 <hr>
  32
  33 <p>Author: <a href=john.merritt.html>John H. Merritt</a>
  34 </body>