Add a useful package (from Source forge) for octave

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

diff --git a/octave_packages/geometry-1.5.0/geom2d/rays2d.m b/octave_packages/geometry-1.5.0/geom2d/rays2d.m
new file mode 100644 (file)
index 0000000..e0e425a
--- /dev/null
+++ b/octave_packages/geometry-1.5.0/geom2d/rays2d.m
@@ -0,0 +1,60 @@
+%% Copyright (c) 2011, INRA
+%% 2008-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} rays2d ()
+%% Description of functions operating on planar rays
+%%
+%%   A ray is defined by a point (its origin), and a vector (its
+%%   direction). The different parameters are bundled into a row vector:
+%%   @code{RAY = [x0 y0 dx dy];}
+%%
+%%   The ray contains all the points (x,y) such that:
+%%   x = x0 + t*dx
+%%   y = y0 + t*dy;
+%%   for all t>0
+%%
+%%   Contrary to a (straight) line, the points located before the origin do
+%%   not belong to the ray.
+%%   However, as rays and lines have the same representation, some functions
+%%   working on lines are also working on rays (like @code{transformLine}).
+%%
+%%   @seealso{points2d, vectors2d, lines2d, createRay, bisector, isPointOnRay,
+%%   clipRay, drawRay}
+%% @end deftypefn
+
+function rays2d(varargin)
+
+  help('rays2d');
+
+endfunction