octave_packages/geometry-1.5.0/geom2d/isPointOnCircle.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} = } isPointOnCircle (@var{point}, @var{circle})
  36 %% Test if a point is located on a given circle.
  37 %%
  38 %%   B = isPointOnCircle(POINT, CIRCLE)
  39 %%   return true if point is located on the circle, i.e. if the distance to
  40 %%   the circle center equals the radius up to an epsilon value.
  41 %%
  42 %%   B = isPointOnCircle(POINT, CIRCLE, TOL)
  43 %%   Specifies the tolerance value.
  44 %%
  45 %%   Example:
  46 %%   isPointOnCircle([1 0], [0 0 1])
  47 %%   returns true, whereas
  48 %%   isPointOnCircle([1 1], [0 0 1])
  49 %%   return false
  50 %%
  51 %%   @seealso{circles2d, isPointInCircle}
  52 %% @end deftypefn
  53
  54 function b = isPointOnCircle(point, circle, varargin)
  55
  56   tol = 1e-14;
  57   if ~isempty(varargin)
  58       tol = varargin{1};
  59   end
  60
  61   d = sqrt(sum(power(point - circle(:,1:2), 2), 2));
  62   b = abs(d-circle(:,3))<tol;
  63
  64 endfunction
  65