Author: luc
Date: Sun Feb 9 20:56:55 2014
New Revision: 1566416
URL: http://svn.apache.org/r1566416
Log:
Added a warning about interfaces not implementable by users.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Embedding.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Hyperplane.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/SubHyperplane.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/package-info.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Embedding.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Embedding.java?rev=1566416&r1=1566415&r2=1566416&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Embedding.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Embedding.java
Sun Feb 9 20:56:55 2014
@@ -34,6 +34,13 @@ import org.apache.commons.math3.geometry
* <p>In the 3D euclidean space, hyperplanes are 2D planes, and the 1D
* sub-spaces are lines.</p>
+ * <p>
+ * Note that this interface is <em>not</em> intended to be implemented
+ * by Apache Commons Math users, it is only intended to be implemented
+ * within the library itself. New methods may be added even for minor
+ * versions, which breaks compatibility for external implementations.
+ * </p>
+
* @param <S> Type of the embedding space.
* @param <T> Type of the embedded sub-space.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Hyperplane.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Hyperplane.java?rev=1566416&r1=1566415&r2=1566416&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Hyperplane.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Hyperplane.java
Sun Feb 9 20:56:55 2014
@@ -30,6 +30,13 @@ import org.apache.commons.math3.geometry
* space). They can be more exotic objects in specific fields, for
* example a circle on the surface of the unit sphere.</p>
+ * <p>
+ * Note that this interface is <em>not</em> intended to be implemented
+ * by Apache Commons Math users, it is only intended to be implemented
+ * within the library itself. New methods may be added even for minor
+ * versions, which breaks compatibility for external implementations.
+ * </p>
+
* @param <S> Type of the space.
* @version $Id$
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java?rev=1566416&r1=1566415&r2=1566416&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java
Sun Feb 9 20:56:55 2014
@@ -39,6 +39,13 @@ import org.apache.commons.math3.geometry
* or) for the binary operations, complement for the unary
* operation.</p>
+ * <p>
+ * Note that this interface is <em>not</em> intended to be implemented
+ * by Apache Commons Math users, it is only intended to be implemented
+ * within the library itself. New methods may be added even for minor
+ * versions, which breaks compatibility for external implementations.
+ * </p>
+
* @param <S> Type of the space.
* @version $Id$
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/SubHyperplane.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/SubHyperplane.java?rev=1566416&r1=1566415&r2=1566416&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/SubHyperplane.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/SubHyperplane.java
Sun Feb 9 20:56:55 2014
@@ -28,6 +28,13 @@ import org.apache.commons.math3.geometry
* hyperplane with the convex region which it splits, the chopping
* hyperplanes are the cut hyperplanes closer to the tree root.</p>
+ * <p>
+ * Note that this interface is <em>not</em> intended to be implemented
+ * by Apache Commons Math users, it is only intended to be implemented
+ * within the library itself. New methods may be added even for minor
+ * versions, which breaks compatibility for external implementations.
+ * </p>
+
* @param <S> Type of the embedding space.
* @version $Id$
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/package-info.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/package-info.java?rev=1566416&r1=1566415&r2=1566416&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/package-info.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/package-info.java
Sun Feb 9 20:56:55 2014
@@ -103,6 +103,12 @@
*
href="http://www.cs.utexas.edu/users/fussell/courses/cs384g/bsp_treemerge.pdf";>here</a>.
* </p>
*
+ * <p>
+ * Note that the interfaces defined in this package are <em>not</em> intended
to
+ * be implemented by Apache Commons Math users, they are only intended to be
+ * implemented within the library itself. New methods may be added even for
+ * minor versions, which breaks compatibility for external implementations.
+ * </p>
*
*/
package org.apache.commons.math3.geometry.partitioning;
