octave_packages/geometry-1.5.0/geom2d/angle3Points.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2004-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{alpha} =} angle3Points (@var{p1}, @var{p2}, @var{p3})
  36 %% Computes the angle between the points @var{p1}, @var{p2} and @var{p3}.
  37 %%
  38 %% @var{p1}, @var{p2} and @var{p3} are either [1x2] arrays, or [Nx2] arrays, in this case
  39 %% @var{alpha} is a [Nx1] array. The angle computed is the directed angle between line
  40 %% (@var{p2}@var{p1}) and line (@var{p2}@var{p3}).
  41 %%
  42 %% Result is always given in radians, between 0 and 2*pi.
  43 %%
  44 %% @seealso{points2d, angles2d, angle2points}
  45 %% @end deftypefn
  46
  47 function theta = angle3Points(varargin)
  48
  49   if length(varargin)==3
  50       p1 = varargin{1};
  51       p2 = varargin{2};
  52       p3 = varargin{3};
  53   elseif length(varargin)==1
  54       var = varargin{1};
  55       p1 = var(1,:);
  56       p2 = var(2,:);
  57       p3 = var(3,:);
  58   end
  59
  60   % angle line (P2 P1)
  61   theta = lineAngle(createLine(p2, p1), createLine(p2, p3));
  62
  63 endfunction
  64
  65 %!test
  66 %! % all points inside window, possibly touching edges
  67 %! p1 = [10 0];
  68 %! p2 = [0 0];
  69 %! p3 = [0 10];
  70 %! angle_ = angle3Points(p1, p2, p3);
  71 %! assert(pi/2, angle_,1e-6);
  72 %! angle_ = angle3Points([p1; p2; p3]);
  73 %! assert(pi/2, angle_, 1e-6);
  74
  75 %!test
  76 %! p1 = [10 0; 20 0];
  77 %! p2 = [0 0;0 0];
  78 %! p3 = [0 10; 0 20];
  79 %! angle_ = angle3Points(p1, p2, p3);
  80 %! assert(2, size(angle_, 1));
  81 %! assert([pi/2;pi/2], angle_, 1e-6);
  82