Skip to content

Commit

Permalink
Another round of Hipparchusation of Apache Commons Math.
Browse files Browse the repository at this point in the history
  • Loading branch information
@maisonobe
maisonobe committed Apr 24, 2016
1 parent 2665c25 commit c384ebc
Show file tree
Hide file tree
Showing 91 changed files with 1,369 additions and 5,126 deletions.
46 changes: 10 additions & 36 deletions CONTRIBUTING.md
View file
Expand Up @@ -14,30 +14,6 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<!---
+======================================================================+
|**** ****|
|**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
|**** DO NOT EDIT DIRECTLY ****|
|**** ****|
+======================================================================+
| TEMPLATE FILE: contributing-md-template.md |
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
| 1) Re-generate using: mvn commons:contributing-md |
| |
| 2) Set the following properties in the component's pom: |
| - commons.jira.id (required, alphabetic, upper case) |
| |
| 3) Example Properties |
| |
| <properties> |
| <commons.jira.id>MATH</commons.jira.id> |
| </properties> |
| |
+======================================================================+
--->
Contributing to Hipparchus
======================

Expand All @@ -48,9 +24,8 @@ follow so that we can have a chance of keeping on top of things.
Getting Started
---------------

+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
+ Make sure you have a [GitHub account](https://github.com/signup/free).
+ If you're planning to implement a new feature it makes sense to discuss you're changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Hipparchus's scope.
+ If you're planning to implement a new feature it makes sense to discuss you're changes on the [FIXME! dev list](https://hipparchus.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Hipparchus's scope.
+ Submit a ticket for your issue, assuming one does not already exist.
+ Clearly describe the issue including steps to reproduce when it is a bug.
+ Make sure you fill in the earliest version that you know has the issue.
Expand All @@ -65,33 +40,32 @@ Making Changes
+ Only use spaces for indentation.
+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
+ Check for unnecessary whitespace with git diff --check before committing.
+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
+ Make sure your commit messages are in the proper format.
+ Make sure you have added the necessary tests for your changes.
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.

Making Trivial Changes
----------------------

For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in GitHub.
In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.

Submitting Changes
------------------

+ Sign the [Contributor License Agreement][cla] if you haven't already.
+ Sign the [Contributor License Agreement][FIXME! cla] if you haven't already.
+ Push your changes to a topic branch in your fork of the repository.
+ Submit a pull request to the repository in the apache organization.
+ Update your JIRA ticket and include a link to the pull request in the ticket.
+ Update your GitHub ticket and include a link to the pull request in the ticket.

Additional Resources
--------------------

+ [Contributing patches](https://commons.apache.org/patches.html)
+ [Hipparchus JIRA project page](https://issues.apache.org/jira/browse/MATH)
+ [Contributor License Agreement][cla]
+ [Project home page](https://hipparchus.org/)
+ [Contributor License Agreement][FIXME! cla]
+ [Mailing lists][FIXME! ml]
+ [General GitHub documentation](https://help.github.com/)
+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
+ #apachecommons IRC channel on freenode.org

[cla]:https://www.apache.org/licenses/#clas
[FIXME! cla]:https://hipparchus.org/licenses/#clas
[FIXME! ml]:https://hipparchus.org/mail-lists.html
46 changes: 29 additions & 17 deletions LICENSE.txt
View file
Expand Up @@ -201,39 +201,51 @@
limitations under the License.


Hipparchus includes the following code provided to the ASF under the
Apache License 2.0:
Hipparchus includes the following code provided to the Apache
Software Foundation under the Apache License 2.0:

- The inverse error function implementation in the Erf class is based on CUDA
code developed by Mike Giles, Oxford-Man Institute of Quantitative Finance,
and published in GPU Computing Gems, volume 2, 2010 (grant received on
March 23th 2013)
- The LinearConstraint, LinearObjectiveFunction, LinearOptimizer,
RelationShip, SimplexSolver and SimplexTableau classes in package
org.apache.commons.math3.optimization.linear include software developed by
org.hipparchus.optim.linear include software developed by
Benjamin McCann (http://www.benmccann.com) and distributed with
the following copyright: Copyright 2009 Google Inc. (grant received on
March 16th 2009)
- The class "org.apache.commons.math3.exception.util.LocalizedFormatsTest" which
the following copyright: Copyright 2009 Google Inc. (grant received by
Apache Software Foundation on March 16th 2009)
- The class "org.hipparchus.exception.util.LocalizedFormatsTest" which
is an adapted version of "OrekitMessagesTest" test class for the Orekit library
- The "org.apache.commons.math3.analysis.interpolation.HermiteInterpolator"
- The "org.hipparchus.analysis.interpolation.HermiteInterpolator"
has been imported from the Orekit space flight dynamics library.

===============================================================================



Apache Commons Math fork

The Hipparchus library started as a fork of Apache Commons Math
(http://commons.apache.org/commons-math). As such, most of its
original code came from the Apache Software Foundation contributors
and developers. This code was already distributed under the terms
of the Apache Software Licence V2.0.

===============================================================================



Hipparchus DERIVATIVE WORKS:

The Apache commons-math library includes a number of subcomponents
The Hipparchus library includes a number of subcomponents
whose implementation is derived from original sources written
in C or Fortran. License terms of the original sources
are reproduced below.

===============================================================================
For the lmder, lmpar and qrsolv Fortran routine from minpack and translated in
the LevenbergMarquardtOptimizer class in package
org.apache.commons.math3.optimization.general
org.hipparchus.fitting.leastsquares
Original source copyright and license statement:

Minpack Copyright Notice (1999) University of Chicago. All rights reserved
Expand Down Expand Up @@ -291,7 +303,7 @@ POSSIBILITY OF SUCH LOSS OR DAMAGES.

Copyright and license statement for the odex Fortran routine developed by
E. Hairer and G. Wanner and translated in GraggBulirschStoerIntegrator class
in package org.apache.commons.math3.ode.nonstiff:
in package org.hipparchus.ode.nonstiff:


Copyright (c) 2004, Ernst Hairer
Expand Down Expand Up @@ -322,7 +334,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Copyright and license statement for the original Mersenne twister C
routines translated in MersenneTwister class in package
org.apache.commons.math3.random:
org.hipparchus.random:

Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
All rights reserved.
Expand Down Expand Up @@ -357,8 +369,8 @@ org.apache.commons.math3.random:
===============================================================================

The initial code for shuffling an array (originally in class
"org.apache.commons.math3.random.RandomDataGenerator", now replaced by
a method in class "org.apache.commons.math3.util.MathArrays") was
"org.apache.hipparchus.random.RandomDataGenerator", now replaced by
a method in class "org.hipparchus.util.MathArrays") was
inspired from the algorithm description provided in
"Algorithms", by Ian Craw and John Pulham (University of Aberdeen 1999).
The textbook (containing a proof that the shuffle is uniformly random) is
Expand Down Expand Up @@ -402,22 +414,22 @@ ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
===============================================================================

The initial commit of package "org.apache.commons.math3.ml.neuralnet" is
The initial commit of package "org.hipparchus.ml.neuralnet" is
an adapted version of code developed in the context of the Data Processing
and Analysis Consortium (DPAC) of the "Gaia" project of the European Space
Agency (ESA).
===============================================================================

The initial commit of the class "org.apache.commons.math3.special.BesselJ" is
The initial commit of the class "org.hipparchus.special.BesselJ" is
an adapted version of code translated from the netlib Fortran program, rjbesl
http://www.netlib.org/specfun/rjbesl by R.J. Cody at Argonne National
Laboratory (USA). There is no license or copyright statement included with the
original Fortran sources.
===============================================================================


The BracketFinder (package org.apache.commons.math3.optimization.univariate)
and PowellOptimizer (package org.apache.commons.math3.optimization.general)
The BracketFinder (package org.apache.hipparchus.optim.univariate)
and PowellOptimizer (package org.hipparchus.optim.lonlinear.scalar.noderiv)
classes are based on the Python code in module "optimize.py" (version 0.5)
developed by Travis E. Oliphant for the SciPy library (http://www.scipy.org/)
Copyright © 2003-2009 SciPy Developers.
Expand Down
113 changes: 0 additions & 113 deletions PROPOSAL.html
View file

This file was deleted.

0 comments on commit c384ebc

Please sign in to comment.