merging with master

apache · Apr 3, 2020 · f25159c · f25159c
2 parents f5bea42 + 2b01d3c
commit f25159c
Show file tree

Hide file tree

Showing 17 changed files with 3,174 additions and 2,967 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -206,11 +206,39 @@ Class "org.apache.commons.numbers.complex.Complex" contains
 Java code partly ported from the "Freely Distributable Math Library" in C.
 The source files contain the following notice:
 
- * ====================================================
- * Copyright (C) 1993 by Sun Microsystems, Inc. All rights reserved.
- *
- * Developed at SunSoft, a Sun Microsystems, Inc. business.
- * Permission to use, copy, modify, and distribute this
- * software is freely granted, provided that this notice
- * is preserved.
- * ====================================================
+  Copyright (C) 1993 by Sun Microsystems, Inc. All rights reserved.
+
+  Developed at SunSoft, a Sun Microsystems, Inc. business.
+  Permission to use, copy, modify, and distribute this
+  software is freely granted, provided that this notice
+  is preserved.
+
+================================================================================
+
+Class "org.apache.commons.numbers.complex.Complex" contains
+Java code partly ported from the "Boost C++ Libraries" <boost/math/complex>.
+The source files contain the following notice:
+
+  Boost Software License - Version 1.0 - August 17th, 2003
+
+  Permission is hereby granted, free of charge, to any person or organization
+  obtaining a copy of the software and accompanying documentation covered by
+  this license (the "Software") to use, reproduce, display, distribute,
+  execute, and transmit the Software, and to prepare derivative works of the
+  Software, and to permit third-parties to whom the Software is furnished to
+  do so, all subject to the following:
+
+  The copyright notices in the Software and this entire statement, including
+  the above license grant, this restriction and the following disclaimer,
+  must be included in all copies of the Software, in whole or in part, and
+  all derivative works of the Software, unless such copies or derivative
+  works are solely in the form of machine-executable object code generated by
+  a source language processor.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+  SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+  FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+  DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@
  | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
  +======================================================================+
  |                                                                      |
- | 1) Re-generate using: mvn commons:readme-md                          |
+ | 1) Re-generate using: mvn commons-build:readme-md                    |
  |                                                                      |
  | 2) Set the following properties in the component's pom:              |
  |    - commons.componentid (required, alphabetic, lower case)          |
@@ -43,19 +43,30 @@
 Apache Commons Numbers
 ===================
 
-[![Build Status](https://travis-ci.org/apache/commons-numbers.svg?branch=master)](https://travis-ci.org/apache/commons-numbers)
-[![Coverage Status](https://coveralls.io/repos/github/apache/commons-numbers/badge.svg?branch=master)](https://coveralls.io/github/apache/commons-numbers?branch=master)
-[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers/)
-[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
-[![Code Quality: Java](https://img.shields.io/lgtm/grade/java/g/apache/commons-numbers.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/apache/commons-numbers/context:java)
+[![Build Status](https://travis-ci.org/apache/commons-numbers.svg)](https://travis-ci.org/apache/commons-numbers)
+[![Coverage Status](https://coveralls.io/repos/apache/commons-numbers/badge.svg)](https://coveralls.io/r/apache/commons-numbers)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-parent/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-parent/)
 
 The Apache Commons Numbers project provides number types and utilities.
 
 Documentation
 -------------
 
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The Javadoc for each of the modules can be browsed:
+
+- [Commons Numbers Core](https://commons.apache.org/proper/commons-numbers/commons-numbers-core/apidocs/)
+- [Commons Numbers Complex](https://commons.apache.org/proper/commons-numbers/commons-numbers-complex/apidocs/)
+- [Commons Numbers Primes](https://commons.apache.org/proper/commons-numbers/commons-numbers-primes/apidocs/)
+- [Commons Numbers Quaternion](https://commons.apache.org/proper/commons-numbers/commons-numbers-quaternion/apidocs/)
+- [Commons Numbers Fraction](https://commons.apache.org/proper/commons-numbers/commons-numbers-fraction/apidocs/)
+- [Commons Numbers Angle](https://commons.apache.org/proper/commons-numbers/commons-numbers-angle/apidocs/)
+- [Commons Numbers Gamma](https://commons.apache.org/proper/commons-numbers/commons-numbers-gamma/apidocs/)
+- [Commons Numbers Combinatorics](https://commons.apache.org/proper/commons-numbers/commons-numbers-combinatorics/apidocs/)
+- [Commons Numbers Arrays](https://commons.apache.org/proper/commons-numbers/commons-numbers-arrays/apidocs/)
+- [Commons Numbers Field](https://commons.apache.org/proper/commons-numbers/commons-numbers-field/apidocs/)
+- [Commons Numbers RootFinder](https://commons.apache.org/proper/commons-numbers/commons-numbers-rootfinder/apidocs/)
+
 Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
 
 Where can I get the latest release?
@@ -67,15 +78,15 @@ Alternatively you can pull it from the central Maven repositories:
 ```xml
 <dependency>
   <groupId>org.apache.commons</groupId>
-  <artifactId>commons-numbers</artifactId>
+  <artifactId>commons-numbers-parent</artifactId>
   <version>1.0</version>
 </dependency>
 ```
 
 Contributing
 ------------
 
-We accept PRs via github. The [developer mailing list][ml] is the main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
 There are some guidelines which will make applying PRs easier for us:
 + No tabs! Please use spaces for indentation.
 + Respect the code style.
@@ -87,7 +98,9 @@ You can learn more about contributing via GitHub in our [contribution guidelines
 
 License
 -------
-Code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0.txt).
+This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
 
 Donations
 ---------
@@ -97,8 +110,8 @@ Additional Resources
 --------------------
 
 + [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
 + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ #apachecommons IRC channel on freenode.org
++ `#apache-commons` IRC channel on `irc.freenode.org`
 
 [ml]:https://commons.apache.org/mail-lists.html
diff --git a/commons-numbers-angle/README.md b/commons-numbers-angle/README.md
@@ -25,7 +25,7 @@
  | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
  +======================================================================+
  |                                                                      |
- | 1) Re-generate using: mvn commons:readme-md                          |
+ | 1) Re-generate using: mvn commons-build:readme-md                    |
  |                                                                      |
  | 2) Set the following properties in the component's pom:              |
  |    - commons.componentid (required, alphabetic, lower case)          |
@@ -43,14 +43,19 @@
 Apache Commons Numbers Angle
 ===================
 
+[![Build Status](https://travis-ci.org/apache/commons-numbers.svg)](https://travis-ci.org/apache/commons-numbers)
+[![Coverage Status](https://coveralls.io/repos/apache/commons-numbers/badge.svg)](https://coveralls.io/r/apache/commons-numbers)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-angle/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-angle/)
+[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-numbers-angle/1.0.svg)](https://javadoc.io/doc/org.apache.commons/commons-numbers-angle/1.0)
+
 Utilities related to the concept of angle.
 
 Documentation
 -------------
 
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Angle should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-angle/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
 
 Where can I get the latest release?
 -----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
 Contributing
 ------------
 
-We accept PRs via github. The [developer mailing list][ml] is the main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
 There are some guidelines which will make applying PRs easier for us:
 + No tabs! Please use spaces for indentation.
 + Respect the code style.
@@ -81,18 +86,20 @@ You can learn more about contributing via GitHub in our [contribution guidelines
 
 License
 -------
-Code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0.txt).
+This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
 
 Donations
 ---------
-You like Apache Commons Numbers Angle? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
 
 Additional Resources
 --------------------
 
 + [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
 + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ #apachecommons IRC channel on freenode.org
++ `#apache-commons` IRC channel on `irc.freenode.org`
 
 [ml]:https://commons.apache.org/mail-lists.html
diff --git a/commons-numbers-arrays/README.md b/commons-numbers-arrays/README.md
@@ -25,7 +25,7 @@
  | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
  +======================================================================+
  |                                                                      |
- | 1) Re-generate using: mvn commons:readme-md                          |
+ | 1) Re-generate using: mvn commons-build:readme-md                    |
  |                                                                      |
  | 2) Set the following properties in the component's pom:              |
  |    - commons.componentid (required, alphabetic, lower case)          |
@@ -43,14 +43,19 @@
 Apache Commons Numbers Arrays
 ===================
 
-Basic utilities.
+[![Build Status](https://travis-ci.org/apache/commons-numbers.svg)](https://travis-ci.org/apache/commons-numbers)
+[![Coverage Status](https://coveralls.io/repos/apache/commons-numbers/badge.svg)](https://coveralls.io/r/apache/commons-numbers)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-arrays/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-arrays/)
+[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-numbers-arrays/1.0.svg)](https://javadoc.io/doc/org.apache.commons/commons-numbers-arrays/1.0)
+
+Array utilities.
 
 Documentation
 -------------
 
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Arrays should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-arrays/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
 
 Where can I get the latest release?
 -----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
 Contributing
 ------------
 
-We accept PRs via github. The [developer mailing list][ml] is the main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
 There are some guidelines which will make applying PRs easier for us:
 + No tabs! Please use spaces for indentation.
 + Respect the code style.
@@ -81,18 +86,20 @@ You can learn more about contributing via GitHub in our [contribution guidelines
 
 License
 -------
-Code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0.txt).
+This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
 
 Donations
 ---------
-You like Apache Commons Numbers Arrays? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
 
 Additional Resources
 --------------------
 
 + [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
 + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ #apachecommons IRC channel on freenode.org
++ `#apache-commons` IRC channel on `irc.freenode.org`
 
 [ml]:https://commons.apache.org/mail-lists.html
diff --git a/commons-numbers-combinatorics/README.md b/commons-numbers-combinatorics/README.md
@@ -25,7 +25,7 @@
  | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
  +======================================================================+
  |                                                                      |
- | 1) Re-generate using: mvn commons:readme-md                          |
+ | 1) Re-generate using: mvn commons-build:readme-md                    |
  |                                                                      |
  | 2) Set the following properties in the component's pom:              |
  |    - commons.componentid (required, alphabetic, lower case)          |
@@ -43,14 +43,19 @@
 Apache Commons Numbers Combinatorics
 ===================
 
+[![Build Status](https://travis-ci.org/apache/commons-numbers.svg)](https://travis-ci.org/apache/commons-numbers)
+[![Coverage Status](https://coveralls.io/repos/apache/commons-numbers/badge.svg)](https://coveralls.io/r/apache/commons-numbers)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-combinatorics/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-combinatorics/)
+[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-numbers-combinatorics/1.0.svg)](https://javadoc.io/doc/org.apache.commons/commons-numbers-combinatorics/1.0)
+
 Combinatorics utilities such as factorial and binomial coefficients.
 
 Documentation
 -------------
 
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Combinatorics should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-combinatorics/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
 
 Where can I get the latest release?
 -----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
 Contributing
 ------------
 
-We accept PRs via github. The [developer mailing list][ml] is the main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
 There are some guidelines which will make applying PRs easier for us:
 + No tabs! Please use spaces for indentation.
 + Respect the code style.
@@ -81,18 +86,20 @@ You can learn more about contributing via GitHub in our [contribution guidelines
 
 License
 -------
-Code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0.txt).
+This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
 
 Donations
 ---------
-You like Apache Commons Numbers Combinatorics? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
 
 Additional Resources
 --------------------
 
 + [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
 + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ #apachecommons IRC channel on freenode.org
++ `#apache-commons` IRC channel on `irc.freenode.org`
 
 [ml]:https://commons.apache.org/mail-lists.html