octave_packages/geometry-1.5.0/geom2d/angleAbsDiff.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} =} angleAbsDiff (@var{angle1}, @var{angle2})
  36 %% Computes the absolute angular difference between two angles in radians.
  37 %% The result is comprised between 0 and pi.
  38 %%
  39 %% @example
  40 %%     A = angleAbsDiff(pi/2, pi/3)
  41 %%     A =
  42 %%         0.5236   % equal to pi/6
  43 %% @end example
  44 %%
  45 %% @seealso{angles2d, angleDiff}
  46 %% @end deftypefn
  47
  48 function dif = angleAbsDiff(angle1, angle2)
  49
  50   % first, normalization
  51   angle1 = normalizeAngle(angle1);
  52   angle2 = normalizeAngle(angle2);
  53
  54   % compute difference and normalize
  55   dif = normalizeAngle(angle1 - angle2);
  56   dif = min(dif, 2*pi - dif);
  57
  58 endfunction
  59
  60 %!shared xp
  61 %! xp = pi/2;
  62 %!assert (xp, angleAbsDiff (pi/2, 0), 1e-6);
  63 %!assert (xp, angleAbsDiff (0, pi/2), 1e-6);
  64 %!assert (xp, angleAbsDiff (0, 3*pi/2), 1e-6);
  65 %!assert (xp, angleAbsDiff (3*pi/2, 0), 1e-6);
  66