Created outline documentation. This will be built using maven. Lots more content needed.
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/math/trunk@140840 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Robert Burrell Donkin
parent
2ebf818b42
commit
526e1c4171
|
|
@ -0,0 +1,23 @@
|
|||
<?xml version="1.0"?>
|
||||
|
||||
<document>
|
||||
<properties>
|
||||
<title>Developers Guide</title>
|
||||
<author email="rdonkin@apache.org">Robert Burrell Donkin</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Aims">
|
||||
<p>
|
||||
Creating and maintaining a mathematical and statistical library that is accurate requires a greater
|
||||
degree of communication than might be the case for other components. It is important that developers
|
||||
follow guidelines laid down by the community to ensure that the code they create can be successfully
|
||||
maintained by others.
|
||||
</p>
|
||||
</section>
|
||||
<section name='Guidelines'>
|
||||
Still under development...!
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
<?xml version="1.0"?>
|
||||
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Commons-Math: The Jakarta Mathematics Library</title>
|
||||
<author email="rdonkin@apache.org">Robert Burrell Donkin</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
|
||||
<section name="Commons-Math: The Jakarta Mathematics Library">
|
||||
<p>
|
||||
The Java programming language and the math extensions in commons-lang provide
|
||||
implementations for only the most basic mathematical algorithms. Routine development
|
||||
tasks such as computing basic statistics or solving a system of linear equations require
|
||||
components not available in java or commons-lang.
|
||||
</p>
|
||||
<p>
|
||||
Most basic mathematical or statistical algorithms are available in open source
|
||||
implementations, but to assemble a simple set of capabilities one has to use multiple
|
||||
libraries, many of which have more restrictive licensing terms than the ASF. In addition,
|
||||
many of the best open source implementations (e.g. the R statistical package) are either
|
||||
not available in Java or require large support libraries and/or external dependencies to work.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
Commons-Math is a library of lightweight, self-contained mathematics and statistics
|
||||
components addressing the most common practical problems not immediately available in the
|
||||
Java programming language or commons-lang. The guiding principles for commons-math are:
|
||||
|
||||
<ol>
|
||||
<li>Real-world application use cases determine priority</li>
|
||||
<li>Emphasis on small, easily integrated components rather than large libraries with
|
||||
complex dependencies</li>
|
||||
<li>All algorithms are fully documented and follow generally accepted best practices</li>
|
||||
<li>In situations where multiple standard algorithms exist, use the Strategy pattern to
|
||||
support multiple implementations</li>
|
||||
<li>Limited dependencies. No external dependencies beyond Commons components and the JDK</li>
|
||||
</ol>
|
||||
</p>
|
||||
|
||||
<subsection name='An Apology To British Users And Developers'>
|
||||
<p>
|
||||
Yes - I know that it should be commons-maths. But think of all the bandwidth saved by losing that 's' ;)
|
||||
</p>
|
||||
</subsection>
|
||||
</section>
|
||||
|
||||
<section name="Download Math">
|
||||
<subsection name="Releases">
|
||||
<p>
|
||||
There haven't been any yet! The more people who contribute, the quicker this will happen.
|
||||
</p>
|
||||
</subsection>
|
||||
<subsection name="Nightly Builds">
|
||||
<p>
|
||||
Nightly builds are built once a day from the current CVS HEAD.
|
||||
This is (nearly) the lastest code and so should be treated with caution!
|
||||
</p>
|
||||
<p>
|
||||
You can get the nightly builds from
|
||||
<a href="http://jakarta.apache.org/builds/jakarta-commons/nightly/commons-math/">here</a>
|
||||
</p>
|
||||
</subsection>
|
||||
</section>
|
||||
|
||||
</body>
|
||||
</document>
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<project name="Math">
|
||||
|
||||
<title>Math</title>
|
||||
<organizationLogo href="/images/jakarta-logo-blue.gif">Jakarta</organizationLogo>
|
||||
|
||||
<body>
|
||||
<menu name="Math">
|
||||
<item name="Overview" href="/index.html"/>
|
||||
<item name="Proposal" href="/proposal.html"/>
|
||||
<item name="Developers Guide" href="/developers.html"/>
|
||||
<item name="Tasks: Done And To Do" href="/tasks.html"/>
|
||||
</menu>
|
||||
<menu name="User Guide">
|
||||
<item name="Overview" href="/userguide/overview.html"/>
|
||||
</menu>
|
||||
</body>
|
||||
</project>
|
||||
|
|
@ -0,0 +1,114 @@
|
|||
<?xml version="1.0"?>
|
||||
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Proposal for math Package</title>
|
||||
<author email="martin@mvdb.net">Robert Burrell Donkin</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
|
||||
<section name='Proposal for math Package'>
|
||||
|
||||
<subsection name='(0) Rationale'>
|
||||
<p>The Java programming language and the math extensions in commons-lang provide implementations
|
||||
for only the most basic mathematical algorithms. Routine development tasks such as computing
|
||||
basic statistics or solving a system of linear equations require components not available in java
|
||||
or commons-lang.</p>
|
||||
|
||||
<p>Most basic mathematical or statistical algorithms are available in open source implementations,
|
||||
but to assemble a simple set of capabilities one has to use multiple libraries, many of which have
|
||||
more restrictive licensing terms than the ASF. In addition, many of the best open source
|
||||
implementations (e.g. the R statistical package) are either not available in Java or require large
|
||||
support libraries and/or external dependencies to work.</p>
|
||||
|
||||
<p>A commons-math community will provide a productive environment for aggregation, testing and
|
||||
support of efficient Java implementations of commonly used mathematical and statistical algorithms.</p>
|
||||
|
||||
</subsection>
|
||||
|
||||
<subsection name='(1) Scope of the Package'>
|
||||
|
||||
<p>The Math project shall create and maintain a library of lightweight, self-contained mathematics
|
||||
and statistics components addressing the most common practical problems not immediately available in
|
||||
the Java programming language or commons-lang. The guiding principles for commons-math will be:
|
||||
|
||||
<ol>
|
||||
<li>Real-world application use cases determine priority</li>
|
||||
<li>Emphasis on small, easily integrated components rather than large libraries with complex
|
||||
dependencies</li>
|
||||
<li>All algorithms are fully documented and follow generally accepted best practices</li>
|
||||
<li>In situations where multiple standard algorithms exist, use the Strategy pattern to support
|
||||
multiple implementations</li>
|
||||
<li>Limited dependencies. No external dependencies beyond Commons components and the JDK</li>
|
||||
</ol>
|
||||
</p>
|
||||
</subsection>
|
||||
|
||||
<subsection name='(1.5) Interaction With Other Packages'>
|
||||
|
||||
<p><em>math</em> relies only on standard JDK 1.2 (or later) APIs for
|
||||
production deployment. It utilizes the JUnit unit testing framework for
|
||||
developing and executing unit tests, but this is of interest only to
|
||||
developers of the component.</p>
|
||||
|
||||
<p>No external configuration files are utilized.</p>
|
||||
|
||||
</subsection>
|
||||
<subsection name='(2) Initial Source of the Package'>
|
||||
|
||||
<p>The initial codebase will consist of implementations of basic statistical algorithms such
|
||||
as the following:
|
||||
<ul>
|
||||
<li>Simple univariate statistics (mean, standard deviation, n, confidence intervals)</li>
|
||||
<li>Frequency distributions</li>
|
||||
<li>t-test, chi-square test</li>
|
||||
<li>Random numbers from Gaussian, Exponential, Poisson distributions</li>
|
||||
<li>Random sampling/resampling</li>
|
||||
<li>Bivariate regression, corellation</li>
|
||||
</ul>
|
||||
|
||||
and mathematical algorithms such as the following:
|
||||
<ul>
|
||||
<li>Basic Complex Number representation with algebraic operations</li>
|
||||
<li>Newton's method for finding roots</li>
|
||||
<li>Binomial coefficients</li>
|
||||
<li>Exponential growth and decay (set up for financial applications)</li>
|
||||
<li>Polynomial Interpolation (curve fitting)</li>
|
||||
<li>Basic Matrix representation with algebraic operations</li>
|
||||
</ul>
|
||||
</p>
|
||||
|
||||
<p>The proposed package name for the new component is
|
||||
<code>org.apache.commons.math</code>.</p>
|
||||
|
||||
</subsection>
|
||||
<subsection name='(3) Required Jakarta-Commons Resources'>
|
||||
|
||||
<ul>
|
||||
<li>CVS Repository - New directory <code>math</code> in the
|
||||
<code>jakarta-commons</code> CVS repository.</li>
|
||||
<li>Mailing List - Discussions will take place on the general
|
||||
<em>commons-dev@jakarta.apache.org</em> mailing list. To help
|
||||
list subscribers identify messages of interest, it is suggested that
|
||||
the message subject of messages about this component be prefixed with
|
||||
[math].</li>
|
||||
<li>Bugzilla - New component "math" under the "Commons" product
|
||||
category, with appropriate version identifiers as needed.</li>
|
||||
<li>Jyve FAQ - New category "commons-math" (when available).</li>
|
||||
</ul>
|
||||
|
||||
</subsection>
|
||||
<subsection name='(4) Initial Committers'>
|
||||
|
||||
<p>The initial committers on the math component shall be:
|
||||
<ul>
|
||||
<li><a href="mailto:rdonkin@apache.org">Robert Burrell Donkin</a></li>
|
||||
<li><a href="mailto:tobrien@apache.org">Tim O'Brien</a></li>
|
||||
</ul>
|
||||
</p>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
<?xml version="1.0"?>
|
||||
|
||||
<document>
|
||||
<properties>
|
||||
<title>Tasks: Done And To Do</title>
|
||||
<author email="jstrachan@apache.org">James Strachan</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name='Aim'>
|
||||
<p>
|
||||
This page aims to be a handy reference not only of the work done but also of work pending.
|
||||
Users who want new features should submit patches to this page. Developers who want to lend
|
||||
a hand can grab tasks from this page. Everyone can see the progress which is being made.
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<section name="TODO list">
|
||||
<p>
|
||||
The following is a list of items still <code>TODO</code> for
|
||||
Math. Contributions are welcome!
|
||||
</p>
|
||||
|
||||
<subsection name="High priority">
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Fill Me In!</strong>
|
||||
With A High Priority Task
|
||||
</li>
|
||||
</ul>
|
||||
</subsection>
|
||||
|
||||
<subsection name="Medium priority">
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Fill Me In</strong>
|
||||
With A Medium Priority Task
|
||||
</li>
|
||||
</ul>
|
||||
</subsection>
|
||||
|
||||
<subsection name="Low priority">
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Fill Me In</strong>
|
||||
With A Low Priority Task
|
||||
</li>
|
||||
</ul>
|
||||
</subsection>
|
||||
</section>
|
||||
<section name='Completed'>
|
||||
<subsection name='Since Conception'>
|
||||
<ul>
|
||||
</ul>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
||||
Loading…
Reference in New Issue