Author: luc
Date: Tue Apr 15 06:15:03 2008
New Revision: 648233
URL: http://svn.apache.org/viewvc?rev=648233&view=rev
Log:
checking in proposal and license information for Nabla
Added:
commons/sandbox/nabla/trunk/LICENSE.txt (with props)
commons/sandbox/nabla/trunk/NOTICE.txt (with props)
commons/sandbox/nabla/trunk/PROPOSAL.html (with props)
commons/sandbox/nabla/trunk/license-header.txt (with props)
Added: commons/sandbox/nabla/trunk/LICENSE.txt
URL:
http://svn.apache.org/viewvc/commons/sandbox/nabla/trunk/LICENSE.txt?rev=648233&view=auto
==============================================================================
--- commons/sandbox/nabla/trunk/LICENSE.txt (added)
+++ commons/sandbox/nabla/trunk/LICENSE.txt Tue Apr 15 06:15:03 2008
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed 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.
Propchange: commons/sandbox/nabla/trunk/LICENSE.txt
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/sandbox/nabla/trunk/NOTICE.txt
URL:
http://svn.apache.org/viewvc/commons/sandbox/nabla/trunk/NOTICE.txt?rev=648233&view=auto
==============================================================================
--- commons/sandbox/nabla/trunk/NOTICE.txt (added)
+++ commons/sandbox/nabla/trunk/NOTICE.txt Tue Apr 15 06:15:03 2008
@@ -0,0 +1,5 @@
+Apache Commons Nabla
+Copyright 2008 The Apache Software Foundation
+
+This product includes software developed by
+The Apache Software Foundation (http://www.apache.org/).
Propchange: commons/sandbox/nabla/trunk/NOTICE.txt
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/sandbox/nabla/trunk/PROPOSAL.html
URL:
http://svn.apache.org/viewvc/commons/sandbox/nabla/trunk/PROPOSAL.html?rev=648233&view=auto
==============================================================================
--- commons/sandbox/nabla/trunk/PROPOSAL.html (added)
+++ commons/sandbox/nabla/trunk/PROPOSAL.html Tue Apr 15 06:15:03 2008
@@ -0,0 +1,171 @@
+<!--
+ 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.
+ -->
+
+<html>
+<head>
+<title>Proposal for nabla Package</title>
+</head>
+<body bgcolor="white">
+
+<div align="center">
+<h1>Proposal for <em>nabla</em> Package</h1>
+</div>
+
+<h3>(0) Rationale</h3>
+
+<p>
+ Scientific computing involves sophisticated models driven by numerous
equations.
+ It is often required to compute both the values of these models, but also
their
+ sensitivity to input parameters. This sensitivity is related to their
derivative.
+ Computing the derivative of a function is called <em>differentiation</em>,
there
+ are two ways to do this.
+</p>
+
+<p>
+ Differentiation can be done numerically by finite differences schemes, but
this has limitations:
+ <ul>
+ <li>result is only an approximation, even if the base function is
perfectly known</li>
+ <li>computation cost overhead can be large if more than 2 points are used
+ for finite differences</li>
+ <li>there is always a compromise between accuracy and computation cost</li>
+ <li>step size choice is always problem-dependent</li>
+ <li>step size depends on parameter units (micrometers or kilometers,
nanoseconds
+ or years ...)</li>
+ <li>step size for multivariate methods involving parameters of different
kinds
+ and orders of magnitude is a nightmare (distances in meters, angles in
radians ...)</li>
+ <li>it doesn't work near boundaries of function definition domains</li>
+ </ul>
+</p>
+
+<p>
+ Differentiation can be done symbolically, but this has drawbacks:
+ <ul>
+ <li>only the simplest cases can be handled manually without errors</li>
+ <li>automatic symbolic computation packages that can handle more complex
+ equations and generate code are expensive and not widely available</li>
+ <li>they use their own domain-specific (and often package-specific)
language
+ as input, requiring manual creation and manual edition</li>
+ <li> they generate source code that cannot be maintained and has a fixed
form
+ which must be manually integrated within the application</li>
+ <li>they are never fully integrated in a development workflow,
+ there are many manual steps, both for using them and for integrating the
+ generated code in the application</li>
+ <li>they handle only fully defined and standalone functions one at a
time</li>
+ <li>using such packages is unrealistic when hundred of models and equations
+ are to be used, there is too much manual overhead</li>
+ <li>they often generate only Fortran or C source code</li>
+ <li>programming languages control structures like loops and conditionals
+ are not supported as they do not belong to pure mathematics</li>
+ <li>they cannot do roundtrip engineering</li>
+ <li>they can be used only if the team needing the derivative can ask for
+ it to the team developing the models, not at all if the latter publish its
+ work or libraries without knowledge of who will use it</li>
+ </ul>
+</p>
+
+<p>
+ The nabla package (∇) is intended to be a symbolic derivator for Java
+ scientific applications that is completely automated and acts directly on the
+ bytecode representation of compiled functions to remove all the drawbacks of
+ symbolic differentiation.
+</p>
+
+
+<h3>(1) Scope of the Package</h3>
+
+<p>
+ The Nabla project shall create and maintain a tool providing automatic
+ differentiation for bytecode functions. Here are the specifications of the
+ package:
+ <ul>
+ <li>a public API <strong>must</strong> be available to perform
differentiation
+ at runtime</li>
+ <li>differentiation <strong>must</strong> be exact symbolic
differentiation</li>
+ <li>the main (almost unique) function of the public API
<strong>must</strong> have
+ a form similar to
+ <div align="center" ><tt>derivative =
nablaDifferentiator.differentiate(differentiable)</tt></div>
+ where <tt>differentiable</tt> is an instance of some class providing a
univariate
+ function <tt>double f(double t)</tt> and derivative implements a
Nabla-defined interface
+ computing both the value of the function <tt>f</tt> and its derivative
with respect to
+ <tt>t</tt></li>
+ <li>all standard mathematical functions provided by the Math and
StrictMath classes
+ <strong>must</strong> be supported</li>
+ <li>all arithmetic operators applying to double primitive types
<strong>must</strong> be
+ supported (including remainder)</li>
+ <li>functions involving loops and conditionals <strong>must</strong> be
supported</li>
+ <li>number of classes, functions, or
+ parameters involved <strong>must</strong> be unlimited</li>
+ <li>generated bytecode <strong>must</strong> be cached</li>
+ <li>for functions calling native code, a fallback using finite differences
+ <strong>must</strong> be available, this <strong>may</strong> use a
different API
+ (i.e. it is possible to add a step size specification if needed)</li>
+ <li>functions calling other bytecode functions, either in the same class or
+ in another class from same or another package <strong>shall</strong> be
supported</li>
+ <li>recursive functions <strong>shall</strong> be supported</li>
+ <li>after a call to the <tt>differentiate</tt> method specified above, the
+ <tt>derivative</tt> instance should remain tightly linked to the
<tt>differentiable</tt>
+ instance in such a way that any subsequent change to the
<tt>differentiable</tt>
+ instance <strong>shall</strong> be reflected by the <tt>derivative</tt>
instance</li>
+ <li>standalone utilities, maven or IDE plugins may be provided to generate
+ derivatives at compile time <strong>shall</strong> be provided</li>
+ </ul>
+</p>
+
+<h3>(1.5) Interaction With Other Packages</h3>
+
+<p>Nabla should rely on standard Java (version To be Defined) and on an
existing bytecode
+engineering library at runtime. For development, it utilizes the JUnit unit
testing framework,
+either ant or maven 2 and general quality checking tools (coding style, test
coverage,
+classical error patterns monitoring).</p>
+
+<p>No external configuration files are utilized.</p>
+
+
+<h3>(2) Initial Source of the Package</h3>
+
+<p>The initial codebase will be imported from an unpublished proof of concept
developed by the
+proposal creator. This codebase supports basic differentiation only.</p>
+
+<p>The proposed package name for the new component is
+<code>org.apache.commons.nabla</code>.</p>
+
+
+<h3>(3) Required Commons Resources</h3>
+
+<ul>
+<li>Subversion Repository - New directory <code>nabla</code> in the
+ <code>commons</code> subversion repository.</li>
+<li>Mailing List - Discussions will take place on the general
+ <em>[EMAIL PROTECTED]</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
+ [nabla].</li>
+<li>Jira - New component "nabla" under the "Commons" product
+ category, with appropriate version identifiers as needed.</li>
+</ul>
+
+
+<h3>(4) Initial Committers</h3>
+
+<p>The initial committers on the math component shall be:
+<ul>
+ <li><a href="mailto:[EMAIL PROTECTED]">Luc Maisonobe</a></li>
+</ul>
+</p>
+
+</body>
+</html>
Propchange: commons/sandbox/nabla/trunk/PROPOSAL.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/sandbox/nabla/trunk/license-header.txt
URL:
http://svn.apache.org/viewvc/commons/sandbox/nabla/trunk/license-header.txt?rev=648233&view=auto
==============================================================================
--- commons/sandbox/nabla/trunk/license-header.txt (added)
+++ commons/sandbox/nabla/trunk/license-header.txt Tue Apr 15 06:15:03 2008
@@ -0,0 +1,16 @@
+/*
+ * 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.
+ */
Propchange: commons/sandbox/nabla/trunk/license-header.txt
------------------------------------------------------------------------------
svn:eol-style = native
