isParallel

ISPARALLEL Check parallelism of two vectors.

   B = isParallel(V1, V2)
   where V1 and V2 are two row vectors of length ND, ND being the
   dimension, returns 1 if the vectors are parallel, and 0 otherwise.

   Also works when V1 and V2 are two N-by-ND arrays with same number of
   rows. In this case, return a N-by-1 array containing 1 at the positions
   of parallel vectors.

   Also works when one of V1 or V2 is N-by-1 and the other one is N-by-ND
   array, in this case return N-by-1 results.

   B = isParallel(V1, V2, ACCURACY)
   specifies the accuracy for numerical computation. Default value is
   1e-14. 
   

   Example
   isParallel([1 2], [2 4])
   ans =
       1
   isParallel([1 2], [1 3])
   ans =
       0

   See also
   vectors2d, isPerpendicular, lines2d

0001 function b = isParallel(v1, v2, varargin)
0002 %ISPARALLEL Check parallelism of two vectors.
0003 %
0004 %   B = isParallel(V1, V2)
0005 %   where V1 and V2 are two row vectors of length ND, ND being the
0006 %   dimension, returns 1 if the vectors are parallel, and 0 otherwise.
0007 %
0008 %   Also works when V1 and V2 are two N-by-ND arrays with same number of
0009 %   rows. In this case, return a N-by-1 array containing 1 at the positions
0010 %   of parallel vectors.
0011 %
0012 %   Also works when one of V1 or V2 is N-by-1 and the other one is N-by-ND
0013 %   array, in this case return N-by-1 results.
0014 %
0015 %   B = isParallel(V1, V2, ACCURACY)
0016 %   specifies the accuracy for numerical computation. Default value is
0017 %   1e-14.
0018 %
0019 %
0020 %   Example
0021 %   isParallel([1 2], [2 4])
0022 %   ans =
0023 %       1
0024 %   isParallel([1 2], [1 3])
0025 %   ans =
0026 %       0
0027 %
0028 %   See also
0029 %   vectors2d, isPerpendicular, lines2d
0030 %
0031 
0032 % ------
0033 % Author: David Legland
0034 % E-mail: david.legland@inrae.fr
0035 % Created: 2006-04-25
0036 % Copyright 2006-2024 INRA - CEPIA Nantes - MIAJ (Jouy-en-Josas)
0037 
0038 % default accuracy
0039 acc = 1e-14;
0040 if ~isempty(varargin)
0041     acc = abs(varargin{1});
0042 end
0043 
0044 % normalize vectors
0045 v1 = normalizeVector(v1);
0046 v2 = normalizeVector(v2);
0047 
0048 % adapt size of inputs if needed
0049 n1 = size(v1, 1);
0050 n2 = size(v2, 1);
0051 if n1 ~= n2
0052     if n1 == 1
0053         v1 = v1(ones(n2,1), :);
0054     elseif n2 == 1
0055         v2 = v2(ones(n1,1), :);
0056     end
0057 end
0058 
0059 % performs computation
0060 if size(v1, 2) == 2
0061     % computation for plane vectors
0062     b = abs(v1(:, 1) .* v2(:, 2) - v1(:, 2) .* v2(:, 1)) < acc;
0063 else
0064     % computation in greater dimensions
0065     b = vectorNorm(cross(v1, v2, 2)) < acc;
0066 end
0067