annotate scripts/geometry/rectint.m @ 19697:4197fc428c7d

maint: Update copyright notices for 2015.
author John W. Eaton <jwe@octave.org>
date Wed, 11 Feb 2015 14:19:08 -0500
parents d63878346099
children 33e706b6b7be
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
1 ## Copyright (C) 2008-2015 Bill Denney
7551
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
2 ##
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
3 ## This file is part of Octave.
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
4 ##
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
8 ## your option) any later version.
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
9 ##
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
13 ## General Public License for more details.
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
14 ##
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
18
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
19 ## -*- texinfo -*-
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{area} =} rectint (@var{a}, @var{b})
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
21 ##
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
22 ## Compute the area of intersection of rectangles in @var{a} and
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
23 ## rectangles in @var{b}. Rectangles are defined as [x y width height]
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
24 ## where x and y are the minimum values of the two orthogonal
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
25 ## dimensions.
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
26 ##
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
27 ## If @var{a} or @var{b} are matrices, then the output, @var{area}, is a
8494
836618fee9d6 [docs] add hyphen
Brian Gough <bjg@gnu.org>
parents: 7655
diff changeset
28 ## matrix where the i-th row corresponds to the i-th row of a and the j-th
836618fee9d6 [docs] add hyphen
Brian Gough <bjg@gnu.org>
parents: 7655
diff changeset
29 ## column corresponds to the j-th row of b.
7551
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
30 ##
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
31 ## @seealso{polyarea}
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
32 ## @end deftypefn
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
33
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
34 ## Author: Bill Denney <bill@denney.ws>
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
35
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
36 function area = rectint (a, b)
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
37
7551
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
38 if (nargin != 2)
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
39 print_usage ();
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
40 elseif (ndims (a) != 2 || ndims (b) != 2)
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
41 error ("rectint: expecting arguments to be 2-d arrays");
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
42 elseif (columns (a) != 4)
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
43 error ("rectint: A must have 4 columns");
7551
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
44 elseif (columns (b) != 4)
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
45 error ("rectint: B must have 4 columns");
14552
86854d032a37 maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents: 14363
diff changeset
46 elseif (any ([a(:,3:4);b(:,3:4)](:) < 0))
8664
e07e93c04080 style fixes
John W. Eaton <jwe@octave.org>
parents: 8494
diff changeset
47 error ("rectint: all widths and heights must be > 0");
7655
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
48 endif
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
49
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
50 ## This runs faster if the number of rows of a is greater than the
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
51 ## number of rows of b. Swap them and transpose to make it run
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
52 ## faster.
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
53 swapinputs = false ();
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
54 if (rows (a) > rows (b))
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
55 tmp = a;
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
56 a = b;
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
57 b = tmp;
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
58 swapinputs = true ();
7551
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
59 endif
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
60
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
61 area = zeros (rows (a), rows (b));
7655
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
62 r1 = [a(:,1:2) a(:,1:2)+a(:,3:4)];
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
63 r2 = [b(:,1:2) b(:,1:2)+b(:,3:4)];
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
64 for i = 1:columns (area)
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
65 ## Find the location of each point relative to the other points.
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
66 r1x1small = r1(:,1) < r2(i,1);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
67 r1x1large = r1(:,1) > r2(i,3);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
68 r1x1mid = (r1(:,1) >= r2(i,1)) & (r1(:,1) <= r2(i,3));
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
69 r1x2small = r1(:,3) < r2(i,1);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
70 r1x2large = r1(:,3) > r2(i,3);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
71 r1x2mid = (r1(:,3) >= r2(i,1)) & (r1(:,3) <= r2(i,3));
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
72
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
73 r1y1small = r1(:,2) < r2(i,2);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
74 r1y1large = r1(:,2) > r2(i,4);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
75 r1y1mid = (r1(:,2) >= r2(i,2)) & (r1(:,2) <= r2(i,4));
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
76 r1y2small = r1(:,4) < r2(i,2);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
77 r1y2large = r1(:,4) > r2(i,4);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
78 r1y2mid = (r1(:,4) >= r2(i,2)) & (r1(:,4) <= r2(i,4));
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
79
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
80 ## determine the width of the rectangle
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
81 ## r1 completely encloses r2
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
82 area(r1x1small & r1x2large,i) = r2(i,3) - r2(i,1);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
83 ## the range goes from r2x min to r1x max
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
84 mask = r1x1small & r1x2mid;
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
85 area(mask,i) = r1(mask,3) - r2(i,1);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
86 ## the range goes from r1x min to r2x max
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
87 mask = r1x1mid & r1x2large;
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
88 area(mask,i) = r2(i,3) - r1(mask,1);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
89 ## the range goes from r1x min to r1x max
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
90 mask = r1x1mid & r1x2mid;
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
91 area(mask,i) = r1(mask,3) - r1(mask,1);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
92
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
93 ## determine the height of the rectangle
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
94 ## r1 completely encloses r2
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
95 area(r1y1small & r1y2large,i) .*= r2(i,4) - r2(i,2);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
96 ## the range goes from r2y min to r1y max
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
97 mask = r1y1small & r1y2mid;
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
98 area(mask,i) .*= r1(mask,4) - r2(i,2);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
99 ## the range goes from r1y min to r2y max
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
100 mask = r1y1mid & r1y2large;
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
101 area(mask,i) .*= r2(i,4) - r1(mask,2);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
102 ## the range goes from r1x min to r1x max
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
103 mask = r1y1mid & r1y2mid;
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
104 area(mask,i) .*= r1(mask,4) - r1(mask,2);
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
105
7551
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
106 endfor
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
107
14552
86854d032a37 maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents: 14363
diff changeset
108 if (swapinputs)
7655
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
109 area = area';
7551
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
110 endif
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
111
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
112 endfunction
5ed0cb9e9584 rectint.m: added
bill@denney.ws
parents:
diff changeset
113
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
114
7655
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
115 ## Exactly overlapping
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
116 %!assert (rectint ([0 0 1 1], [0 0 1 1]), 1)
7655
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
117 ## 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
118 %!assert (rectint ([-1 -1 3 3], [0 0 1 1]), 1)
7655
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
119 ## 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
120 %!assert (rectint ([0 0 1 1], [-1 -1 3 3]), 1)
7655
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
121 ## 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
122 %!assert (rectint ([-1 -1 1.5 1.5], [0 0 1 1]), 0.25)
7655
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
123 ## 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
124 %!assert (rectint ([0 0 1 1], [-1 -1 1.5 1.5]), 0.25)
7655
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
125 ## 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
126 %!assert (rectint ([0 0 1 1], [1 1 2 2]), 0)
7655
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
127 ## 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
128 %!assert (rectint ([0 0 1 1], [0 1 2 2]), 0)
7655
ea2344c4140b rectint.m: vectorize and add tests
bill@denney.ws
parents: 7551
diff changeset
129 ## 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
130 %!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
131 %!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
132