1 %% Copyright (c) 2011, INRA
2 %% 2006-2011, David Legland <david.legland@grignon.inra.fr>
3 %% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
5 %% All rights reserved.
6 %% (simplified BSD License)
8 %% Redistribution and use in source and binary forms, with or without
9 %% modification, are permitted provided that the following conditions are met:
11 %% 1. Redistributions of source code must retain the above copyright notice, this
12 %% list of conditions and the following disclaimer.
14 %% 2. Redistributions in binary form must reproduce the above copyright notice,
15 %% this list of conditions and the following disclaimer in the documentation
16 %% and/or other materials provided with the distribution.
18 %% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 %% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 %% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 %% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 %% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 %% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 %% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 %% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 %% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 %% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 %% POSSIBILITY OF SUCH DAMAGE.
30 %% The views and conclusions contained in the software and documentation are
31 %% those of the authors and should not be interpreted as representing official
32 %% policies, either expressed or implied, of copyright holder.
35 %% @deftypefn {Function File} {@var{b} = } isPerpendicular (@var{v1}, @var{v2})
36 %% @deftypefnx {Function File} {@var{b} = } isPerpendicula (@var{v1}, @var{v2},@var{tol})
37 %% heck orthogonality of two vectors.
39 %% @var{v1} and @var{v2} are 2 row vectors of length Nd, Nd being the dimension,
40 %% returns @code{true} if the vectors are perpendicular, and @code{false} otherwise.
42 %% Also works when @var{v1} and @var{v2} are two [NxNd] arrays with same number of
43 %% rows. In this case, return a [Nx1] array containing @code{true} at the positions
44 %% of parallel vectors.
46 %% @var{tol} specifies the accuracy of numerical computation. Default value is 1e-14.
51 % isPerpendicular([1 2 0], [0 0 2])
54 % isPerpendicular([1 2 1], [1 3 2])
59 %% @seealso{vectors2d, isParallel, lines2d}
63 %% Also works when one of @var{v1} or @var{v2} is scalar and the other one is [NxNd]
64 %% array, in this case return [Nx1] results.
66 function b = isPerpendicular(v1, v2, varargin)
71 acc = abs(varargin{1});
74 % adapt size of inputs
79 v1 = v1(ones(n2, 1), :);
81 v2 = v2(ones(n1, 1), :);
83 error('Inputs must either have same size, or one must be scalar');
88 b = abs(dot(v1, v2, 2)) < acc;
92 %!assert (isPerpendicular ([1 2 0], [0 0 2]))
93 %!assert (!isPerpendicular([1 2 1], [1 3 2]))
94 %!error (isPerpendicular(1, rand(4,3)))