Add a useful package (from Source forge) for octave

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

diff --git a/octave_packages/geometry-1.5.0/geom2d/points2d.m b/octave_packages/geometry-1.5.0/geom2d/points2d.m
new file mode 100644 (file)
index 0000000..6d73dc4
--- /dev/null
+++ b/octave_packages/geometry-1.5.0/geom2d/points2d.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} points2d ()
+%% Description of functions operating on points.
+%%
+%%   A point is defined by its two cartesian coordinate, put into a row
+%%   vector of 2 elements:
+%%   P = [x y];
+%%
+%%   Several points are stores in a matrix with two columns, one for the
+%%   x-coordinate, one for the y-coordinate.
+%%   PTS = [x1 y1 ; x2 y2 ; x3 y3];
+%%   
+%%   Example
+%%   P = [5 6];
+%%
+%%   @seealso{centroid, midPoint, polarPoint, pointOnLine
+%%   isCounterClockwise, angle2Points, angle3Points, angleSort
+%%   distancePoints, minDistancePoints
+%%   transformPoint, clipPoints, drawPoint}
+%% @end deftypefn
+
+function points2d
+
+  help('points2d');
+
+endfunction
+