Updated documentation for the release.

Hipparchus-Math · Apr 20, 2022 · 447c489 · 447c489
1 parent 3731e4a
commit 447c489
Show file tree

Hide file tree

Showing 15 changed files with 35 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ Alternatively you can pull it from the central Maven repositories using `pom.xml
 ```xml
 <properties>
   <!-- change the Hipparchus version number to the one suiting your needs -->
-  <myprojectname.hipparchus.version>2.0</myprojectname.hipparchus.version>
+  <myprojectname.hipparchus.version>2.1</myprojectname.hipparchus.version>
 </properties>
 
 <dependency>

diff --git a/hipparchus-clustering/src/site/site.xml b/hipparchus-clustering/src/site/site.xml
@@ -79,6 +79,7 @@
       <item name="1.7 API docs"                  href="https://hipparchus.org/apidocs-1.7/index.html"/>
       <item name="1.8 API docs"                  href="https://hipparchus.org/apidocs-1.8/index.html"/>
       <item name="2.0 API docs"                  href="https://hipparchus.org/apidocs-2.0/index.html"/>
+      <item name="2.1 API docs"                  href="https://hipparchus.org/apidocs-2.1/index.html"/>
       <item name="Source Repository (current)"   href="https://github.com/Hipparchus-Math/hipparchus"/>
       <item name="Global Coverage"               href="../hipparchus-coverage/jacoco-aggregate/index.html"/>
       <item name="Developers Guide"              href="../developers.html"/>

diff --git a/hipparchus-core/src/site/site.xml b/hipparchus-core/src/site/site.xml
@@ -83,6 +83,7 @@
       <item name="1.7 API docs"                  href="https://hipparchus.org/apidocs-1.7/index.html"/>
       <item name="1.8 API docs"                  href="https://hipparchus.org/apidocs-1.8/index.html"/>
       <item name="2.0 API docs"                  href="https://hipparchus.org/apidocs-2.0/index.html"/>
+      <item name="2.1 API docs"                  href="https://hipparchus.org/apidocs-2.1/index.html"/>
       <item name="Source Repository (current)"   href="https://github.com/Hipparchus-Math/hipparchus"/>
       <item name="Global Coverage"               href="../hipparchus-coverage/jacoco-aggregate/index.html"/>
       <item name="Developers Guide"              href="../developers.html"/>

diff --git a/hipparchus-fft/src/site/site.xml b/hipparchus-fft/src/site/site.xml
@@ -79,6 +79,7 @@
       <item name="1.7 API docs"                  href="https://hipparchus.org/apidocs-1.7/index.html"/>
       <item name="1.8 API docs"                  href="https://hipparchus.org/apidocs-1.8/index.html"/>
       <item name="2.0 API docs"                  href="https://hipparchus.org/apidocs-2.0/index.html"/>
+      <item name="2.1 API docs"                  href="https://hipparchus.org/apidocs-2.1/index.html"/>
       <item name="Source Repository (current)"   href="https://github.com/Hipparchus-Math/hipparchus"/>
       <item name="Global Coverage"               href="../hipparchus-coverage/jacoco-aggregate/index.html"/>
       <item name="Developers Guide"              href="../developers.html"/>

diff --git a/hipparchus-filtering/src/site/site.xml b/hipparchus-filtering/src/site/site.xml
@@ -79,6 +79,7 @@
       <item name="1.7 API docs"                  href="https://hipparchus.org/apidocs-1.7/index.html"/>
       <item name="1.8 API docs"                  href="https://hipparchus.org/apidocs-1.8/index.html"/>
       <item name="2.0 API docs"                  href="https://hipparchus.org/apidocs-2.0/index.html"/>
+      <item name="2.1 API docs"                  href="https://hipparchus.org/apidocs-2.1/index.html"/>
       <item name="Source Repository (current)"   href="https://github.com/Hipparchus-Math/hipparchus"/>
       <item name="Global Coverage"               href="../hipparchus-coverage/jacoco-aggregate/index.html"/>
       <item name="Developers Guide"              href="../developers.html"/>

diff --git a/hipparchus-fitting/src/site/site.xml b/hipparchus-fitting/src/site/site.xml
@@ -79,6 +79,7 @@
       <item name="1.7 API docs"                  href="https://hipparchus.org/apidocs-1.7/index.html"/>
       <item name="1.8 API docs"                  href="https://hipparchus.org/apidocs-1.8/index.html"/>
       <item name="2.0 API docs"                  href="https://hipparchus.org/apidocs-2.0/index.html"/>
+      <item name="2.1 API docs"                  href="https://hipparchus.org/apidocs-2.1/index.html"/>
       <item name="Source Repository (current)"   href="https://github.com/Hipparchus-Math/hipparchus"/>
       <item name="Global Coverage"               href="../hipparchus-coverage/jacoco-aggregate/index.html"/>
       <item name="Developers Guide"              href="../developers.html"/>

diff --git a/hipparchus-geometry/src/site/site.xml b/hipparchus-geometry/src/site/site.xml
@@ -79,6 +79,7 @@
       <item name="1.7 API docs"                  href="https://hipparchus.org/apidocs-1.7/index.html"/>
       <item name="1.8 API docs"                  href="https://hipparchus.org/apidocs-1.8/index.html"/>
       <item name="2.0 API docs"                  href="https://hipparchus.org/apidocs-2.0/index.html"/>
+      <item name="2.1 API docs"                  href="https://hipparchus.org/apidocs-2.1/index.html"/>
       <item name="Source Repository (current)"   href="https://github.com/Hipparchus-Math/hipparchus"/>
       <item name="Global Coverage"               href="../hipparchus-coverage/jacoco-aggregate/index.html"/>
       <item name="Developers Guide"              href="../developers.html"/>

diff --git a/hipparchus-migration/src/site/site.xml b/hipparchus-migration/src/site/site.xml
@@ -79,6 +79,7 @@
       <item name="1.7 API docs"                  href="https://hipparchus.org/apidocs-1.7/index.html"/>
       <item name="1.8 API docs"                  href="https://hipparchus.org/apidocs-1.8/index.html"/>
       <item name="2.0 API docs"                  href="https://hipparchus.org/apidocs-2.0/index.html"/>
+      <item name="2.1 API docs"                  href="https://hipparchus.org/apidocs-2.1/index.html"/>
       <item name="Source Repository (current)"   href="https://github.com/Hipparchus-Math/hipparchus"/>
       <item name="Global Coverage"               href="../hipparchus-coverage/jacoco-aggregate/index.html"/>
       <item name="Developers Guide"              href="../developers.html"/>

diff --git a/hipparchus-ode/src/site/site.xml b/hipparchus-ode/src/site/site.xml
@@ -79,6 +79,7 @@
       <item name="1.7 API docs"                  href="https://hipparchus.org/apidocs-1.7/index.html"/>
       <item name="1.8 API docs"                  href="https://hipparchus.org/apidocs-1.8/index.html"/>
       <item name="2.0 API docs"                  href="https://hipparchus.org/apidocs-2.0/index.html"/>
+      <item name="2.1 API docs"                  href="https://hipparchus.org/apidocs-2.1/index.html"/>
       <item name="Source Repository (current)"   href="https://github.com/Hipparchus-Math/hipparchus"/>
       <item name="Global Coverage"               href="../hipparchus-coverage/jacoco-aggregate/index.html"/>
       <item name="Developers Guide"              href="../developers.html"/>

diff --git a/hipparchus-optim/src/site/site.xml b/hipparchus-optim/src/site/site.xml
@@ -79,6 +79,7 @@
       <item name="1.7 API docs"                  href="https://hipparchus.org/apidocs-1.7/index.html"/>
       <item name="1.8 API docs"                  href="https://hipparchus.org/apidocs-1.8/index.html"/>
       <item name="2.0 API docs"                  href="https://hipparchus.org/apidocs-2.0/index.html"/>
+      <item name="2.1 API docs"                  href="https://hipparchus.org/apidocs-2.1/index.html"/>
       <item name="Source Repository (current)"   href="https://github.com/Hipparchus-Math/hipparchus"/>
       <item name="Global Coverage"               href="../hipparchus-coverage/jacoco-aggregate/index.html"/>
       <item name="Developers Guide"              href="../developers.html"/>

diff --git a/hipparchus-samples/src/site/site.xml b/hipparchus-samples/src/site/site.xml
@@ -79,6 +79,7 @@
       <item name="1.7 API docs"                  href="https://hipparchus.org/apidocs-1.7/index.html"/>
       <item name="1.8 API docs"                  href="https://hipparchus.org/apidocs-1.8/index.html"/>
       <item name="2.0 API docs"                  href="https://hipparchus.org/apidocs-2.0/index.html"/>
+      <item name="2.1 API docs"                  href="https://hipparchus.org/apidocs-2.1/index.html"/>
       <item name="Source Repository (current)"   href="https://github.com/Hipparchus-Math/hipparchus"/>
       <item name="Global Coverage"               href="../hipparchus-coverage/jacoco-aggregate/index.html"/>
       <item name="Developers Guide"              href="../developers.html"/>

diff --git a/hipparchus-stat/src/site/site.xml b/hipparchus-stat/src/site/site.xml
@@ -79,6 +79,7 @@
       <item name="1.7 API docs"                  href="https://hipparchus.org/apidocs-1.7/index.html"/>
       <item name="1.8 API docs"                  href="https://hipparchus.org/apidocs-1.8/index.html"/>
       <item name="2.0 API docs"                  href="https://hipparchus.org/apidocs-2.0/index.html"/>
+      <item name="2.1 API docs"                  href="https://hipparchus.org/apidocs-2.1/index.html"/>
       <item name="Source Repository (current)"   href="https://github.com/Hipparchus-Math/hipparchus"/>
       <item name="Global Coverage"               href="../hipparchus-coverage/jacoco-aggregate/index.html"/>
       <item name="Developers Guide"              href="../developers.html"/>

diff --git a/src/site/markdown/downloads.md b/src/site/markdown/downloads.md
@@ -42,6 +42,16 @@ Maven's internal mechanism will automatically download any internal dependencies
 
 ---
 
+|     package       |                                  link                                                     | hash | signature |
+|-------------------|-------------------------------------------------------------------------------------------|------|-----------|
+|  source (zip)     | [hipparchus-2.1-src.zip](downloads/hipparchus-2.1-src.zip) | [md5](downloads/hipparchus-2.1-src.zip.md5)| [sig](downloads/hipparchus-2.1-src.zip.asc)|
+|  source (tar.bz2) | [hipparchus-2.1-src.tar.bz2](downloads/hipparchus-2.1-src.tar.bz2) | [md5](downloads/hipparchus-2.1-src.tar.bz2.md5) | [sig](downloads/hipparchus-2.1-src.tar.bz2.asc)|
+|  binary (zip)     | [hipparchus-2.1-bin.zip](downloads/hipparchus-2.1-bin.zip)| [md5](downloads/hipparchus-2.1-bin.zip.md5) | [sig](downloads/hipparchus-2.1-bin.zip.asc)|
+|  binary (tar.bz2) | [hipparchus-2.1-bin.tar.bz2](downloads/hipparchus-2.1-bin.tar.bz2) | [md5](downloads/hipparchus-2.1-bin.tar.bz2.md5) | [sig](downloads/hipparchus-2.1-bin.tar.bz2.asc)
+version 2.1 downloads (release date: 2022-04-24)
+
+---
+
 |     package       |                                  link                                                     | hash | signature |
 |-------------------|-------------------------------------------------------------------------------------------|------|-----------|
 |  source (zip)     | [hipparchus-2.0-src.zip](downloads/hipparchus-2.0-src.zip) | [md5](downloads/hipparchus-2.0-src.zip.md5)| [sig](downloads/hipparchus-2.0-src.zip.asc)|

diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
@@ -66,16 +66,15 @@ at fork time.
 
  ---
 
-## 2.0 Release is out!
-
-Hipparchus 2.0 is now available for download from the [Hipparchus download page](downloads.html) or on
-Maven central and its mirrors under the groupId **org.hipparchus**. Highlights in the 2.0 release are:
-
-  * addition of a sequential Gauss-Newton optimizer
-  * improved relative scheduling of step handlers and events handlers in ODE
-  * addition of a finish callback in step handlers
-  * replacement of RealFieldElement by CalculusFieldElement interface
-  * many improvements in Complex to fully implement CalculusFieldElement with correct branch cuts
-  * addition of FieldComplex
-  * implementation of elliptic functions and integrals (for real, complex and general fields)
-  * faster simultaneous computation of sinh/cosh
+## 2.1 Release is out!
+
+Hipparchus 2.1 is now available for download from the [Hipparchus download page](downloads.html) or on
+Maven central and its mirrors under the groupId **org.hipparchus**. Highlights in the 2.1 release are:
+
+  * addition of 3D version of complex function plotter,
+  * addition of ConvergenceCheckerOrMultiplexer and ConvergenceCheckerAndMultiplexer,
+  * addition of inverse Jacobi elliptic functions,
+  * optional modified weights to Akima interpolation,
+  * modified Gram-Schmidt basis orthonormalization process,
+  * generation of convergents streams in continued fractions,
+  * addition of equalsIee754 to points in all topologies to handle NaN coordinates.
diff --git a/src/site/site.xml b/src/site/site.xml
@@ -99,6 +99,7 @@
       <item name="1.7 API docs"                  href="https://hipparchus.org/apidocs-1.7/index.html"/>
       <item name="1.8 API docs"                  href="https://hipparchus.org/apidocs-1.8/index.html"/>
       <item name="2.0 API docs"                  href="https://hipparchus.org/apidocs-2.0/index.html"/>
+      <item name="2.1 API docs"                  href="https://hipparchus.org/apidocs-2.1/index.html"/>
       <item name="Source Repository (current)"   href="https://github.com/Hipparchus-Math/hipparchus"/>
       <item name="Global Coverage"               href="hipparchus-coverage/jacoco-aggregate/index.html"/>
       <item name="Developers Guide"              href="developers.html"/>