octave_packages/geometry-1.5.0/geom2d/angleDiff.m

   1 %% Copyright (c) 2011, INRA
   2 %% 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{dif} =} angleDiff (@var{angle1}, @var{angle2})
  36 %% Difference between two angles
  37 %%
  38 %%   Computes the signed angular difference between two angles in radians.
  39 %%   The result is comprised between -PI and +PI.
  40 %%
  41 %%   Example
  42 %%     A = angleDiff(-pi/4, pi/4)
  43 %%     A =
  44 %%         1.5708    % equal to pi/2
  45 %%     A = angleDiff(pi/4, -pi/4)
  46 %%     A =
  47 %%        -1.5708    % equal to -pi/2
  48 %%
  49 %% @seealso{angles2d, angleAbsDiff}
  50 %% @end deftypefn
  51
  52 function dif = angleDiff(angle1, angle2)
  53
  54   % first, normalization
  55   angle1 = normalizeAngle(angle1);
  56   angle2 = normalizeAngle(angle2);
  57
  58   % compute difference and normalize in [-pi pi]
  59   dif = normalizeAngle(angle2 - angle1, 0);
  60 endfunction
  61
  62 %!test
  63 %! dif = angleDiff(0, pi/2);
  64 %! assert (pi/2, dif, 1e-6);
  65
  66 %!test
  67 %! dif = angleDiff(pi/2, 0);
  68 %! assert (-pi/2, dif, 1e-6);
  69
  70 %!test
  71 %! dif = angleDiff(0, 3*pi/2);
  72 %! assert (-pi/2, dif, 1e-6);
  73
  74 %!test
  75 %! dif = angleDiff(3*pi/2, 0);
  76 %! assert (pi/2, dif, 1e-6);