| <?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 Client API</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 "client API" module contains the code that defines the API for client code. |
| </p> |
| |
| <p> |
| Example: |
| </p> |
| |
| <source class="prettyprint">import org.apache.commons.rng.UniformRandomProvider; |
| |
| public class Dice { |
| public int roll(UniformRandomProvider rng) { |
| return 1 + rng.nextInt(6); |
| } |
| } |
| </source> |
| |
| <p> |
| Browse the <a href="apidocs/index.html">Javadoc</a> to see the complete API. |
| </p> |
| </section> |
| |
| </body> |
| |
| </document> |
