Repository: commons-rng Updated Branches: refs/heads/multimodule 4cf40bb07 -> 92732fccf
Javadoc. Project: http://git-wip-us.apache.org/repos/asf/commons-rng/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-rng/commit/92732fcc Tree: http://git-wip-us.apache.org/repos/asf/commons-rng/tree/92732fcc Diff: http://git-wip-us.apache.org/repos/asf/commons-rng/diff/92732fcc Branch: refs/heads/multimodule Commit: 92732fccf96e10abb48ac9c43899df08f7494401 Parents: 4cf40bb Author: Gilles <[email protected]> Authored: Wed Nov 2 16:30:44 2016 +0100 Committer: Gilles <[email protected]> Committed: Wed Nov 2 16:30:44 2016 +0100 ---------------------------------------------------------------------- .../org/apache/commons/rng/package-info.java | 2 +- .../commons/rng/core/util/package-info.java | 26 ++++++++++++++++++ .../rng/examples/integration/package-info.java | 27 +++++++++++++++++++ .../commons/rng/examples/package-info.java | 26 ++++++++++++++++++ .../rng/examples/stress/RandomStressTester.java | 2 +- .../rng/examples/stress/package-info.java | 28 ++++++++++++++++++++ .../apache/commons/rng/jmh/package-info.java | 27 +++++++++++++++++++ .../apache/commons/rng/simple/package-info.java | 2 +- 8 files changed, 137 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-rng/blob/92732fcc/commons-rng-client-api/src/main/java/org/apache/commons/rng/package-info.java ---------------------------------------------------------------------- diff --git a/commons-rng-client-api/src/main/java/org/apache/commons/rng/package-info.java b/commons-rng-client-api/src/main/java/org/apache/commons/rng/package-info.java index 9f5c52d..efbbe65 100644 --- a/commons-rng-client-api/src/main/java/org/apache/commons/rng/package-info.java +++ b/commons-rng-client-api/src/main/java/org/apache/commons/rng/package-info.java @@ -16,7 +16,7 @@ */ /** - * <h3>Randomness Providers API</h3> + * <h3>Randomness providers API</h3> * * <p> * This package contains the library's interface to be used by client http://git-wip-us.apache.org/repos/asf/commons-rng/blob/92732fcc/commons-rng-core/src/main/java/org/apache/commons/rng/core/util/package-info.java ---------------------------------------------------------------------- diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/util/package-info.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/util/package-info.java new file mode 100644 index 0000000..50eaa7f --- /dev/null +++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/util/package-info.java @@ -0,0 +1,26 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * <h3>Utilities</h3> + * + * <p> + * This package contains utilities to combine/split primitive types. + * </p> + */ + +package org.apache.commons.rng.core.util; http://git-wip-us.apache.org/repos/asf/commons-rng/blob/92732fcc/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/integration/package-info.java ---------------------------------------------------------------------- diff --git a/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/integration/package-info.java b/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/integration/package-info.java new file mode 100644 index 0000000..8fced09 --- /dev/null +++ b/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/integration/package-info.java @@ -0,0 +1,27 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * <h3>Monte-Carlo integration</h3> + * + * <p> + * This package contains a simple application that uses many + * uniformly-distributed random numbers. + * </p> + */ + +package org.apache.commons.rng.examples.integration; http://git-wip-us.apache.org/repos/asf/commons-rng/blob/92732fcc/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/package-info.java ---------------------------------------------------------------------- diff --git a/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/package-info.java b/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/package-info.java new file mode 100644 index 0000000..a88e369 --- /dev/null +++ b/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/package-info.java @@ -0,0 +1,26 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * <h3>Usage examples</h3> + * + * <p> + * This package contains examples of use of the Commons RNG library. + * </p> + */ + +package org.apache.commons.rng.examples; http://git-wip-us.apache.org/repos/asf/commons-rng/blob/92732fcc/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/stress/RandomStressTester.java ---------------------------------------------------------------------- diff --git a/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/stress/RandomStressTester.java b/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/stress/RandomStressTester.java index d55a82c..da3a797 100644 --- a/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/stress/RandomStressTester.java +++ b/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/stress/RandomStressTester.java @@ -47,7 +47,7 @@ import org.apache.commons.rng.UniformRandomProvider; * $ java -jar examples.jar \ * report/dh_ \ * 4 \ - * org.apache.commons.rng.userguide.GeneratorsList \ + * org.apache.commons.rng.examples.stress.GeneratorsList \ * /usr/bin/dieharder -a -g 200 -Y 1 -k 2 * </code></pre> * </p> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/92732fcc/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/stress/package-info.java ---------------------------------------------------------------------- diff --git a/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/stress/package-info.java b/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/stress/package-info.java new file mode 100644 index 0000000..5b59e08 --- /dev/null +++ b/commons-rng-examples/src/main/java/org/apache/commons/rng/examples/stress/package-info.java @@ -0,0 +1,28 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * <h3>Stress test application</h3> + * + * <p> + * This package contains an application for interfacing with external + * software that perform stringent tests to check the uniformity of + * the sequences being passed to them. + * </p> + */ + +package org.apache.commons.rng.examples.stress; http://git-wip-us.apache.org/repos/asf/commons-rng/blob/92732fcc/commons-rng-jmh/src/main/java/org/apache/commons/rng/jmh/package-info.java ---------------------------------------------------------------------- diff --git a/commons-rng-jmh/src/main/java/org/apache/commons/rng/jmh/package-info.java b/commons-rng-jmh/src/main/java/org/apache/commons/rng/jmh/package-info.java new file mode 100644 index 0000000..4334df6 --- /dev/null +++ b/commons-rng-jmh/src/main/java/org/apache/commons/rng/jmh/package-info.java @@ -0,0 +1,27 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * <h3>Performance benchmarks</h3> + * + * <p> + * This package contains code to perform a + * {@link http://openjdk.java.net/projects/code-tools/jmh JMH} run. + * </p> + */ + +package org.apache.commons.rng.jmh; http://git-wip-us.apache.org/repos/asf/commons-rng/blob/92732fcc/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/package-info.java ---------------------------------------------------------------------- diff --git a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/package-info.java b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/package-info.java index 725cbee..19bec32 100644 --- a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/package-info.java +++ b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/package-info.java @@ -16,7 +16,7 @@ */ /** - * <h3>Randomness Providers</h3> + * <h3>Randomness providers</h3> * * <p> * This package provides {@link org.apache.commons.rng.RandomSource factory
