[commons-rng] branch master updated: Add javadoc for thrown exception to UnitSphereSampler

[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


The following commit(s) were added to refs/heads/master by this push:
     new cca5966  Add javadoc for thrown exception to UnitSphereSampler
cca5966 is described below

commit cca5966d2e1e0f009915ea662a725c8aaf37aa13
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Tue Feb 19 18:15:29 2019 +0000

    Add javadoc for thrown exception to UnitSphereSampler
---
 .../src/main/java/org/apache/commons/rng/sampling/UnitSphereSampler.java | 1 +
 1 file changed, 1 insertion(+)

diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitSphereSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitSphereSampler.java
index cbb3785..3dbdb03 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitSphereSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitSphereSampler.java
@@ -37,6 +37,7 @@ public class UnitSphereSampler {
      * @param dimension Space dimension.
      * @param rng Generator for the individual components of the vectors.
      * A shallow copy will be stored in this instance.
+     * @throws IllegalArgumentException If {@code dimension <= 0}
      */
     public UnitSphereSampler(int dimension,
                              UniformRandomProvider rng) {