octave_packages/geometry-1.5.0/geom2d/isPointOnLine.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2003-2011, David Legland <david.legland@grignon.inra.fr>
   3 %% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
   4 %%
   5 %% All rights reserved.
   6 %% (simplified BSD License)
   7 %%
   8 %% Redistribution and use in source and binary forms, with or without
   9 %% modification, are permitted provided that the following conditions are met:
  10 %%
  11 %% 1. Redistributions of source code must retain the above copyright notice, this
  12 %%    list of conditions and the following disclaimer.
  13 %%
  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.
  17 %%
  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.
  29 %%
  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.
  33
  34 %% -*- texinfo -*-
  35 %% @deftypefn {Function File} {@var{b} = } isPointOnLine (@var{point}, @var{line})
  36 %% Test if a point belongs to a line
  37 %%
  38 %%   B = isPointOnLine(POINT, LINE)
  39 %%   with POINT being [xp yp], and LINE being [x0 y0 dx dy].
  40 %%   Returns 1 if point lies on the line, 0 otherwise.
  41 %%
  42 %%   If POINT is an N*2 array of points, B is a N*1 array of booleans.
  43 %%
  44 %%   If LINE is a N*4 array of line, B is a 1*N array of booleans.
  45 %%
  46 %%   @seealso {lines2d, points2d, isPointOnEdge, isPointOnRay, angle3Points}
  47 %% @end deftypefn
  48
  49 function b = isPointOnLine(point, line, varargin)
  50
  51   % extract computation tolerance
  52   tol = 1e-14;
  53   if ~isempty(varargin)
  54       tol = varargin{1};
  55   end
  56
  57   % number of lines and of points
  58   Nl = size(line, 1);
  59   Np = size(point, 1);
  60
  61   % adapt the size of inputs
  62   x0 = repmat(line(:,1)', Np, 1);
  63   y0 = repmat(line(:,2)', Np, 1);
  64   dx = repmat(line(:,3)', Np, 1);
  65   dy = repmat(line(:,4)', Np, 1);
  66   xp = repmat(point(:,1), 1, Nl);
  67   yp = repmat(point(:,2), 1, Nl);
  68
  69   % test if lines are colinear
  70   b = abs((xp-x0).*dy-(yp-y0).*dx)./hypot(dx, dy) < tol;
  71
  72 endfunction