Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / geometry-1.5.0 / octclip / doc-cache

diff --git a/octave_packages/geometry-1.5.0/octclip/doc-cache b/octave_packages/geometry-1.5.0/octclip/doc-cache
new file mode 100644 (file)
index 0000000..8315818
--- /dev/null
+++ b/octave_packages/geometry-1.5.0/octclip/doc-cache
@@ -0,0 +1,72 @@
+# Created by Octave 3.6.2, Sun Jun 10 09:53:40 2012 UTC <root@brouzouf>
+# name: cache
+# type: cell
+# rows: 3
+# columns: 1
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 11
+oc_polybool
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 1545
+ -- Function File: [X,Y,NPOL,NINT,NPERT] = _oc_polybool(SUB,CLIP,OP)
+ -- Function File: [X,Y,NPOL,NINT,NPERT] = _oc_polybool(SUB,CLIP)
+     This function performs boolean operations between two polygons
+     using the Greiner-Hormann algorithm
+     (http://davis.wpi.edu/~matt/courses/clipping/).
+
+     SUB is a two column matrix containing the X and Y coordinates of
+     the vertices for the subject polygon.
+
+     CLIP is a two column matrix containing the X and Y coordinates of
+     the vertices for the clipper polygon.
+
+     OP is a text string containing the operation to perform between
+     SUB and CLIP. Possible values are:
+
+        * 'AND' Intersection of SUB and CLIP (value by default).
+
+        * 'OR' Union of SUBT and CLIP.
+
+        * 'AB' Operation SUB - CLIP.
+
+        * 'BA' Operation of CLIP - SUB.
+
+     For the matrices SUB and CLIP, the first point is not needed to be
+     repeated at the end (but is permitted). Pairs of (NaN,NaN)
+     coordinates in SUB and/or CLIP are omitted.
+
+     X is a column vector containing the X coordinates of the vertices
+     for.  resultant polygon(s).
+
+     Y is a column vector containing the Y coordinates of the vertices
+     for.  resultant polygon(s).
+
+     NPOL is the number of output polygons.
+
+     NINT is the number of intersections between SUB and CLIP.
+
+     NPERT is the number of perturbed points of the CLIP polygon in any
+     particular case (points in the oborder of the other polygon)
+     occurs see http://davis.wpi.edu/~matt/courses/clipping/ for
+     details.
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 80
+This function performs boolean operations between two polygons using the
+Greiner
+
+
+
+
+