Mercurial > octave-antonio
comparison scripts/geometry/rectint.m @ 20158:7503499a252b stable
doc: Update docstrings to have one sentence summary as first line.
Update scripts in audio, elfun, general, geometry, and image directories.
* scripts/audio/@audioplayer/__get_properties__.m,
scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m,
scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m,
scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m,
scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m,
scripts/audio/@audiorecorder/audiorecorder.m,
scripts/audio/@audiorecorder/get.m,
scripts/audio/@audiorecorder/getaudiodata.m,
scripts/audio/@audiorecorder/getplayer.m,
scripts/audio/@audiorecorder/isrecording.m,
scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m,
scripts/audio/@audiorecorder/recordblocking.m,
scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m,
scripts/audio/@audiorecorder/subsasgn.m,
scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m,
scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m,
scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m,
scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m,
scripts/general/accumarray.m, scripts/general/accumdim.m,
scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m,
scripts/general/blkdiag.m, scripts/general/cart2pol.m,
scripts/general/cart2sph.m, scripts/general/cell2mat.m,
scripts/general/celldisp.m, scripts/general/chop.m,
scripts/general/circshift.m, scripts/general/common_size.m,
scripts/general/cplxpair.m, scripts/general/cumtrapz.m,
scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m,
scripts/general/display.m, scripts/general/divergence.m,
scripts/general/fieldnames.m, scripts/general/flip.m,
scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m,
scripts/general/gradient.m, scripts/general/interp3.m,
scripts/general/interpft.m, scripts/general/interpn.m,
scripts/general/loadobj.m, scripts/general/logspace.m,
scripts/general/methods.m, scripts/general/nargchk.m,
scripts/general/narginchk.m, scripts/general/nargoutchk.m,
scripts/general/nextpow2.m, scripts/general/nthargout.m,
scripts/general/num2str.m, scripts/general/pol2cart.m,
scripts/general/polyarea.m, scripts/general/postpad.m,
scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m,
scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m,
scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m,
scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m,
scripts/general/shiftdim.m, scripts/general/sortrows.m,
scripts/general/sph2cart.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/trapz.m,
scripts/general/triplequad.m, scripts/geometry/delaunayn.m,
scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m,
scripts/geometry/rectint.m, scripts/geometry/tsearchn.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/help/__unimplemented__.m, scripts/help/doc.m,
scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m,
scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m,
scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m,
scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m,
scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m,
scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m,
scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m,
scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m,
scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m,
scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m,
scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m,
scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m,
scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m,
scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m,
scripts/image/white.m, scripts/image/winter.m:
Update docstrings to have one sentence summary as first line.
Re-structure to have line lengths <= 80 chars.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sun, 03 May 2015 09:36:20 -0700 |
| parents | 33e706b6b7be |
| children |
comparison
equal
deleted
inserted
replaced
| 20153:3b3579ad7e46 | 20158:7503499a252b |
|---|---|
| 16 ## along with Octave; see the file COPYING. If not, see | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
| 18 | 18 |
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {@var{area} =} rectint (@var{a}, @var{b}) | 20 ## @deftypefn {Function File} {@var{area} =} rectint (@var{a}, @var{b}) |
| 21 ## Compute area or volume of intersection of rectangles or ND boxes. | 21 ## Compute area or volume of intersection of rectangles or N-D boxes. |
| 22 ## | 22 ## |
| 23 ## Compute the area of intersection of rectangles in @var{a} and | 23 ## Compute the area of intersection of rectangles in @var{a} and rectangles in |
| 24 ## rectangles in @var{b}. N dimensional boxes are supported in which | 24 ## @var{b}. N-dimensional boxes are supported in which case the volume, or |
| 25 ## case the volume, or hypervolume is computed according to the number | 25 ## hypervolume is computed according to the number of dimensions. |
| 26 ## of dimensions. | |
| 27 ## | 26 ## |
| 28 ## 2 dimensional rectangles are defined as @code{[xpos ypos width height]} | 27 ## 2-dimensional rectangles are defined as @code{[xpos ypos width height]} |
| 29 ## where xpos and ypos are the position of the bottom left corner. | 28 ## where xpos and ypos are the position of the bottom left corner. Higher |
| 30 ## Higher dimensions are supported where the coordinates for the minimum | 29 ## dimensions are supported where the coordinates for the minimum value of each |
| 31 ## value of each dimension follow the length of the box in that dimension, | 30 ## dimension follow the length of the box in that dimension, e.g., |
| 32 ## e.g., @code{[xpos ypos zpos kpos @dots{} width height depth k_length @dots{}]}. | 31 ## @code{[xpos ypos zpos kpos @dots{} width height depth k_length @dots{}]}. |
| 33 ## | 32 ## |
| 34 ## Each row of @var{a} and @var{b} define a rectangle, and if both define | 33 ## Each row of @var{a} and @var{b} define a rectangle, and if both define |
| 35 ## multiple rectangles, then the output, @var{area}, is a matrix where | 34 ## multiple rectangles, then the output, @var{area}, is a matrix where the i-th |
| 36 ## the i-th row corresponds to the i-th row of a and the j-th column | 35 ## row corresponds to the i-th row of a and the j-th column corresponds to the |
| 37 ## corresponds to the j-th row of b. | 36 ## j-th row of b. |
| 38 ## | 37 ## |
| 39 ## @seealso{polyarea} | 38 ## @seealso{polyarea} |
| 40 ## @end deftypefn | 39 ## @end deftypefn |
| 41 | 40 |
| 42 ## Author: 2015 Carnë Draug <carandraug@octave.org> | 41 ## Author: 2015 Carnë Draug <carandraug@octave.org> |