You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2021/04/25 20:06:09 UTC

[commons-rng] branch master updated (a089841 -> 5a21a8e)

This is an automated email from the ASF dual-hosted git repository.

aherbert pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git.


    from a089841  UnitBallSampler: Use the sign bit for the sign of the range [-1, 1)
     new c34749e  RNG-132: Create o.a.c.rng.sampling.shape package
     new 5a21a8e  Correct javadoc paragraph tags.

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .../org/apache/commons/rng/sampling/distribution/package-info.java  | 4 +++-
 .../src/main/java/org/apache/commons/rng/sampling/package-info.java | 6 ++++++
 .../apache/commons/rng/sampling/{ => shape}/UnitBallSampler.java    | 3 ++-
 .../java/org/apache/commons/rng/sampling/shape}/package-info.java   | 6 +++---
 .../commons/rng/sampling/{ => shape}/UnitBallSamplerTest.java       | 4 +++-
 src/changes/changes.xml                                             | 3 +++
 6 files changed, 20 insertions(+), 6 deletions(-)
 rename commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/{ => shape}/UnitBallSampler.java (98%)
 copy {commons-rng-core/src/main/java/org/apache/commons/rng/core/util => commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape}/package-info.java (83%)
 rename commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/{ => shape}/UnitBallSamplerTest.java (98%)

[commons-rng] 02/02: Correct javadoc paragraph tags.

Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git

commit 5a21a8e83787216da7ccb61f17a6cf946beef1e8
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Sun Apr 25 21:01:52 2021 +0100

    Correct javadoc paragraph tags.
---
 .../org/apache/commons/rng/sampling/distribution/package-info.java    | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/package-info.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/package-info.java
index c98f99b..48c93da 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/package-info.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/package-info.java
@@ -29,15 +29,17 @@
  * <p>
  * When no specific algorithm is provided, one can still sample from any
  * distribution, using the <em>inverse method</em>, as illustrated in:
+ * </p>
  * <ul>
  *  <li>{@link org.apache.commons.rng.sampling.distribution.InverseTransformDiscreteSampler InverseTransformDiscreteSampler}</li>
  *  <li>{@link org.apache.commons.rng.sampling.distribution.InverseTransformContinuousSampler InverseTransformContinuousSampler}</li>
  * </ul>
  *
+ * <p>
  * Algorithms are described in e.g. Luc Devroye (1986), <a href="http://luc.devroye.org/chapter_nine.pdf">chapter 9</a>
  * and <a href="http://luc.devroye.org/chapter_ten.pdf">chapter 10</a>.
- *
  * This <a href="http://www.doc.ic.ac.uk/~wl/papers/07/csur07dt.pdf">paper</a> discusses Gaussian generators.
+ * </p>
  */
 
 package org.apache.commons.rng.sampling.distribution;

[commons-rng] 01/02: RNG-132: Create o.a.c.rng.sampling.shape package

Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git

commit c34749edddf0188871f1031ad72fe680b228dbe7
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Sun Apr 25 21:01:14 2021 +0100

    RNG-132: Create o.a.c.rng.sampling.shape package
    
    Move UnitBallSampler to the shape package.
---
 .../main/java/org/apache/commons/rng/sampling/package-info.java   | 6 ++++++
 .../apache/commons/rng/sampling/{ => shape}/UnitBallSampler.java  | 3 ++-
 .../org/apache/commons/rng/sampling/{ => shape}/package-info.java | 8 +++-----
 .../commons/rng/sampling/{ => shape}/UnitBallSamplerTest.java     | 4 +++-
 src/changes/changes.xml                                           | 3 +++
 5 files changed, 17 insertions(+), 7 deletions(-)

diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/package-info.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/package-info.java
index 2d3445f..e578a9e 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/package-info.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/package-info.java
@@ -21,8 +21,14 @@
  * <p>
  * This package provides sampling utilities.
  * </p>
+ * <p>
  * The {@link org.apache.commons.rng.sampling.distribution distribution}
  * sub-package provides sampling from statistical distributions.
+ * </p>
+ * <p>
+ * The {@link org.apache.commons.rng.sampling.shape shape}
+ * sub-package provides sampling coordinates from shapes.
+ * </p>
  */
 
 package org.apache.commons.rng.sampling;
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitBallSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/UnitBallSampler.java
similarity index 98%
rename from commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitBallSampler.java
rename to commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/UnitBallSampler.java
index 4c359b5..f6356bb 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitBallSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/UnitBallSampler.java
@@ -15,9 +15,10 @@
  * limitations under the License.
  */
 
-package org.apache.commons.rng.sampling;
+package org.apache.commons.rng.sampling.shape;
 
 import org.apache.commons.rng.UniformRandomProvider;
+import org.apache.commons.rng.sampling.SharedStateSampler;
 import org.apache.commons.rng.sampling.distribution.NormalizedGaussianSampler;
 import org.apache.commons.rng.sampling.distribution.ZigguratNormalizedGaussianSampler;
 
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/package-info.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/package-info.java
similarity index 77%
copy from commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/package-info.java
copy to commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/package-info.java
index 2d3445f..837c86f 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/package-info.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/package-info.java
@@ -16,13 +16,11 @@
  */
 
 /**
- * <h3>Samplers</h3>
+ * <h3>Shape samplers</h3>
  *
  * <p>
- * This package provides sampling utilities.
+ * This package contains classes for sampling coordinates from shapes, for example a unit ball.
  * </p>
- * The {@link org.apache.commons.rng.sampling.distribution distribution}
- * sub-package provides sampling from statistical distributions.
  */
 
-package org.apache.commons.rng.sampling;
+package org.apache.commons.rng.sampling.shape;
diff --git a/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/UnitBallSamplerTest.java b/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/shape/UnitBallSamplerTest.java
similarity index 98%
rename from commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/UnitBallSamplerTest.java
rename to commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/shape/UnitBallSamplerTest.java
index 6f2b9b0..67c6bba 100644
--- a/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/UnitBallSamplerTest.java
+++ b/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/shape/UnitBallSamplerTest.java
@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.commons.rng.sampling;
+package org.apache.commons.rng.sampling.shape;
 
 import org.junit.Assert;
 import org.junit.Test;
@@ -23,6 +23,8 @@ import java.util.Arrays;
 import org.apache.commons.math3.stat.inference.ChiSquareTest;
 import org.apache.commons.rng.UniformRandomProvider;
 import org.apache.commons.rng.core.source64.SplitMix64;
+import org.apache.commons.rng.sampling.RandomAssert;
+import org.apache.commons.rng.sampling.RandomAssert.Sampler;
 
 /**
  * Test for {@link UnitBallSampler}.
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 2d24b13..1ab4aa9 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -75,6 +75,9 @@ re-run tests that fail, and pass the build if they succeed
 within the allotted number of reruns (the test will be marked
 as 'flaky' in the report).
 ">
+      <action dev="aherbert" type="add" issue="132">
+        New "o.a.c.rng.sampling.shape" package for sampling coordinates from shapes.
+      </action>
       <action dev="aherbert" type="fix" issue="130">
         "UnitSphereSampler": Fix 1 dimension sampling to only return vectors containing 1 or -1.
       </action>