Module dedicated web page.
Project: http://git-wip-us.apache.org/repos/asf/commons-rng/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-rng/commit/1068c58b Tree: http://git-wip-us.apache.org/repos/asf/commons-rng/tree/1068c58b Diff: http://git-wip-us.apache.org/repos/asf/commons-rng/diff/1068c58b Branch: refs/heads/multimodule Commit: 1068c58bd957244d532ba309bc676cb447196f36 Parents: 9b33d8b Author: Gilles <[email protected]> Authored: Fri Nov 4 13:07:31 2016 +0100 Committer: Gilles <[email protected]> Committed: Fri Nov 4 13:07:31 2016 +0100 ---------------------------------------------------------------------- commons-rng-simple/src/site/site.xml | 40 ++++++++++++++++ commons-rng-simple/src/site/xdoc/index.xml | 62 +++++++++++++++++++++++++ 2 files changed, 102 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-rng/blob/1068c58b/commons-rng-simple/src/site/site.xml ---------------------------------------------------------------------- diff --git a/commons-rng-simple/src/site/site.xml b/commons-rng-simple/src/site/site.xml new file mode 100644 index 0000000..61a4d76 --- /dev/null +++ b/commons-rng-simple/src/site/site.xml @@ -0,0 +1,40 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + 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. +--> +<project name="RNG"> + <bannerRight> + <name>Apache Commons RNG</name> + <src>/images/commons_rng.small.png</src> + <href>/index.html</href> + </bannerRight> + + <body> + <menu name="RNG Simple"> + <item name="Overview" href="index.html"/> + <item name="Latest API docs (development)" + href="apidocs/index.html"/> + <item name="Javadoc (1.0 release)" + href="http://commons.apache.org/rng/client-api/javadocs/api-1.0/index.html"/> + </menu> + + <head> + <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";> + </script> + </head> + + </body> +</project> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/1068c58b/commons-rng-simple/src/site/xdoc/index.xml ---------------------------------------------------------------------- diff --git a/commons-rng-simple/src/site/xdoc/index.xml b/commons-rng-simple/src/site/xdoc/index.xml new file mode 100644 index 0000000..6b4a355 --- /dev/null +++ b/commons-rng-simple/src/site/xdoc/index.xml @@ -0,0 +1,62 @@ +<?xml version="1.0"?> + +<!-- + 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. + --> + +<document> + + <properties> + <title>Commons RNG Simple</title> + </properties> + + <body> + + <section name="Apache Commons RNG: Random Numbers Generators" href="summary"> + <p> + Commons RNG provides implementations of pseudo-random numbers generators that are + either faster or of higher quality (and sometimes both) than <code>java.util.Random</code>. + </p> + + <p> + The "simple" module contains factory methods for easy instantiation of the + generation algorithms implemented in the "commons-rng-core" module. + </p> + + <p> + Example: + +<source>import org.apache.commons.rng.UniformRandomProvider; +import org.apache.commons.rng.simple.RandomSource; + +public class Dice { + private final UniformRandomProvider rng = RandomSource.create(RandomSource.MT); + + public int roll() { + return 1 + rng.nextInt(6); + } +} +</source> + </p> + + <p> + Browse the <a href="apidocs/index.html">Javadoc</a> for more information. + </p> + </section> + + </body> + +</document>
