Mercurial > hg > octave-nkf
annotate scripts/geometry/rectint.m @ 20368: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 |
rev | line source |
---|---|
20326
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
1 ## Copyright (C) 2015 Carnë Draug |
7551 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7 ## the Free Software Foundation; either version 3 of the License, or (at | |
8 ## your option) any later version. | |
9 ## | |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
16 ## along with Octave; see the file COPYING. If not, see | |
17 ## <http://www.gnu.org/licenses/>. | |
18 | |
19 ## -*- texinfo -*- | |
20 ## @deftypefn {Function File} {@var{area} =} rectint (@var{a}, @var{b}) | |
20368
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20326
diff
changeset
|
21 ## Compute area or volume of intersection of rectangles or N-D boxes. |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20326
diff
changeset
|
22 ## |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20326
diff
changeset
|
23 ## Compute the area of intersection of rectangles in @var{a} and rectangles in |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20326
diff
changeset
|
24 ## @var{b}. N-dimensional boxes are supported in which case the volume, or |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20326
diff
changeset
|
25 ## hypervolume is computed according to the number of dimensions. |
7551 | 26 ## |
20368
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20326
diff
changeset
|
27 ## 2-dimensional rectangles are defined as @code{[xpos ypos width height]} |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20326
diff
changeset
|
28 ## where xpos and ypos are the position of the bottom left corner. Higher |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20326
diff
changeset
|
29 ## dimensions are supported where the coordinates for the minimum value of each |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20326
diff
changeset
|
30 ## dimension follow the length of the box in that dimension, e.g., |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20326
diff
changeset
|
31 ## @code{[xpos ypos zpos kpos @dots{} width height depth k_length @dots{}]}. |
20326
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
32 ## |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
33 ## Each row of @var{a} and @var{b} define a rectangle, and if both define |
20368
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20326
diff
changeset
|
34 ## multiple rectangles, then the output, @var{area}, is a matrix where the i-th |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20326
diff
changeset
|
35 ## row corresponds to the i-th row of a and the j-th column corresponds to the |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20326
diff
changeset
|
36 ## j-th row of b. |
7551 | 37 ## |
38 ## @seealso{polyarea} | |
39 ## @end deftypefn | |
40 | |
20326
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
41 ## Author: 2015 Carnë Draug <carandraug@octave.org> |
7551 | 42 |
20326
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
43 function dists = rectint (a, b) |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
44 |
7551 | 45 if (nargin != 2) |
46 print_usage (); | |
20326
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
47 elseif (columns (a) != columns (b)) |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
48 error ("rectint: A and B must have same number of columns"); |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
49 elseif (ndims (a) > 2) |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
50 error ("rectint: A and B must be 2-d arrays"); |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
51 elseif (mod (columns (a), 2)) |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
52 error ("rectint: number of columns of A and B must be a multiple of two"); |
7551 | 53 endif |
54 | |
20326
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
55 nd = columns (a) / 2; |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
56 na = rows (a); |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
57 nb = rows (b); |
7655 | 58 |
20326
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
59 a_start = a(:,1:nd); |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
60 b_start = b(:,1:nd); |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
61 |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
62 a_end = a_start + a(:,nd+1:end); |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
63 b_end = b_start + b(:,nd+1:end); |
7655 | 64 |
20326
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
65 a_start = reshape (a_start, [na 1 nd]); |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
66 b_start = reshape (b_start, [1 nb nd]); |
7655 | 67 |
20326
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
68 a_end = reshape (a_end, [na 1 nd]); |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
69 b_end = reshape (b_end, [1 nb nd]); |
7655 | 70 |
20326
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
71 ## We get a 3d matrix where each dimension is in the 3rd dimension |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
72 dists = bsxfun (@min , a_end, b_end) - bsxfun (@max, a_start, b_start); |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
73 dists(dists < 0) = 0; |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
74 dists = prod (dists, 3); |
7551 | 75 |
76 endfunction | |
77 | |
7655 | 78 ## Exactly overlapping |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
79 %!assert (rectint ([0 0 1 1], [0 0 1 1]), 1) |
7655 | 80 ## rect2 completely enclosed by rect1 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
81 %!assert (rectint ([-1 -1 3 3], [0 0 1 1]), 1) |
7655 | 82 ## rect1 completely enclosed by rect2 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
83 %!assert (rectint ([0 0 1 1], [-1 -1 3 3]), 1) |
7655 | 84 ## rect1 right and top in rect2 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
85 %!assert (rectint ([-1 -1 1.5 1.5], [0 0 1 1]), 0.25) |
7655 | 86 ## rect2 right and top in rect1 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
87 %!assert (rectint ([0 0 1 1], [-1 -1 1.5 1.5]), 0.25) |
7655 | 88 ## no overlap - shared corner |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
89 %!assert (rectint ([0 0 1 1], [1 1 2 2]), 0) |
7655 | 90 ## no overlap - shared edge |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
91 %!assert (rectint ([0 0 1 1], [0 1 2 2]), 0) |
7655 | 92 ## Correct orientation of output |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
93 %!assert (rectint ([0 0 1 1;0.5 0.5 1 1;-1 -1 2 2], [1 1 2 2]), [0;0.25;0]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
94 %!assert (rectint ([1 1 2 2], [0 0 1 1;0.5 0.5 1 1;-1 -1 2 2]), [0 0.25 0]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
95 |
20326
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
96 ## bug #44904 |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
97 %!assert (rectint ([0 0 5 5], [6 6 5 5]), 0) |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
98 %!assert (rectint ([0 0 5 5], [0 6 5 5]), 0) |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
99 %!assert (rectint ([0 0 5 5], [6 0 5 5]), 0) |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
100 %!assert (rectint ([0 0 0 5 5 5], [0 0 6 5 5 5]), 0) |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
101 |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
102 ## Test volumes |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
103 %!shared r1, r2, r3, r4, r5 |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
104 %! r1 = [ 5 3 0 7 5 2]; |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
105 %! r2 = [ 2 5 0 4 2 2]; |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
106 %! r3 = [ 10 7 0 10 3 2]; |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
107 %! r4 = [ 10 -5 0 5 7 2]; |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
108 %! r5 = [-10 0 0 40 11 2]; |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
109 |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
110 %!assert (rectint (r5, r1), 70) |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
111 %!assert (rectint (r5, r4), 20) |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
112 %!assert (rectint (r5, [r1; r2; r3; r4]), [70 16 60 20]) |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
113 |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
114 ## Test multiple volumes in both A and B |
33e706b6b7be
rectint: fix for non-overlapping rectangle, and support ND boxes (bug #44904)
Carnë Draug <carandraug@octave.org>
parents:
19898
diff
changeset
|
115 %!assert (rectint ([r2; r5], [r1; r3; r4]), [4 0 0; 70 60 20]) |