Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / geometry-1.5.0 / geom2d / angleDiff.m

diff --git a/octave_packages/geometry-1.5.0/geom2d/angleDiff.m b/octave_packages/geometry-1.5.0/geom2d/angleDiff.m
new file mode 100644 (file)
index 0000000..e71b2f2
--- /dev/null
+++ b/octave_packages/geometry-1.5.0/geom2d/angleDiff.m
@@ -0,0 +1,76 @@
+%% Copyright (c) 2011, INRA
+%% 2011, David Legland <david.legland@grignon.inra.fr>
+%% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
+%%
+%% All rights reserved.
+%% (simplified BSD License)
+%%
+%% Redistribution and use in source and binary forms, with or without
+%% modification, are permitted provided that the following conditions are met:
+%%
+%% 1. Redistributions of source code must retain the above copyright notice, this
+%%    list of conditions and the following disclaimer.
+%%     
+%% 2. Redistributions in binary form must reproduce the above copyright notice, 
+%%    this list of conditions and the following disclaimer in the documentation
+%%    and/or other materials provided with the distribution.
+%%
+%% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+%% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+%% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+%% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+%% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+%% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+%% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
+%% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+%% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+%% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+%% POSSIBILITY OF SUCH DAMAGE.
+%%
+%% The views and conclusions contained in the software and documentation are
+%% those of the authors and should not be interpreted as representing official
+%% policies, either expressed or implied, of copyright holder.
+
+%% -*- texinfo -*-
+%% @deftypefn {Function File} {@var{dif} =} angleDiff (@var{angle1}, @var{angle2})
+%% Difference between two angles
+%%
+%%   Computes the signed angular difference between two angles in radians.
+%%   The result is comprised between -PI and +PI.
+%%
+%%   Example
+%%     A = angleDiff(-pi/4, pi/4)
+%%     A = 
+%%         1.5708    % equal to pi/2
+%%     A = angleDiff(pi/4, -pi/4)
+%%     A = 
+%%        -1.5708    % equal to -pi/2
+%% 
+%% @seealso{angles2d, angleAbsDiff}
+%% @end deftypefn
+
+function dif = angleDiff(angle1, angle2)
+
+  % first, normalization
+  angle1 = normalizeAngle(angle1);
+  angle2 = normalizeAngle(angle2);
+
+  % compute difference and normalize in [-pi pi]
+  dif = normalizeAngle(angle2 - angle1, 0);
+endfunction
+
+%!test
+%! dif = angleDiff(0, pi/2);
+%! assert (pi/2, dif, 1e-6);
+
+%!test
+%! dif = angleDiff(pi/2, 0);
+%! assert (-pi/2, dif, 1e-6);
+
+%!test
+%! dif = angleDiff(0, 3*pi/2);
+%! assert (-pi/2, dif, 1e-6);
+
+%!test
+%! dif = angleDiff(3*pi/2, 0);
+%! assert (pi/2, dif, 1e-6);