Cleanup.
Project: http://git-wip-us.apache.org/repos/asf/commons-numbers/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-numbers/commit/7a4a3a61 Tree: http://git-wip-us.apache.org/repos/asf/commons-numbers/tree/7a4a3a61 Diff: http://git-wip-us.apache.org/repos/asf/commons-numbers/diff/7a4a3a61 Branch: refs/heads/master Commit: 7a4a3a61e75d23ae0e35c7b261b0f1daa2a1f94a Parents: 69d3b62 Author: Gilles Sadowski <[email protected]> Authored: Fri Jan 20 13:38:52 2017 +0100 Committer: Gilles Sadowski <[email protected]> Committed: Fri Jan 20 13:38:52 2017 +0100 ---------------------------------------------------------------------- src/site/apt/userguide/special.apt | 136 ------------------------ src/site/design/differentiation.puml | 105 ------------------- src/site/design/oneD.puml | 81 -------------- src/site/design/partitioning.puml | 118 --------------------- src/site/design/solver.puml | 102 ------------------ src/site/design/threeD.puml | 86 --------------- src/site/design/twoD.puml | 84 --------------- src/site/xdoc/download_math.xml | 168 ------------------------------ src/site/xdoc/proposal.xml | 131 ----------------------- 9 files changed, 1011 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/7a4a3a61/src/site/apt/userguide/special.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/userguide/special.apt b/src/site/apt/userguide/special.apt deleted file mode 100644 index 420e055..0000000 --- a/src/site/apt/userguide/special.apt +++ /dev/null @@ -1,136 +0,0 @@ -~~ -~~ 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. -~~ - - ----------------------------------------------- - The Commons Math User Guide - Special Functions - ----------------------------------------------- - -5 Special Functions - -* 5.1 Overview - - The <<<special>>> package of Commons-Math gathers several useful special - functions not provided by <<<java.lang.Math>>>. - -* 5.2 Erf functions - - {{{../apidocs/org/apache/commons/math4/special/Erf.html}Erf}} contains - several useful functions involving the Error Function, Erf. - -*----------------+---------+-------------------------------------------------------------------+ -|| Function || Method || Reference | -*----------------+---------+-------------------------------------------------------------------+ -| Error Function |erf | See {{{http://mathworld.wolfram.com/Erf.html}Erf}} from MathWorld | -*----------------+---------+-------------------------------------------------------------------+ - -* 5.3 Gamma functions - - Class {{{../apidocs/org/apache/commons/math4/special/Gamma.html}<<<Gamma>>>}} - contains several useful functions involving the Gamma Function. - -** Gamma - - <<<Gamma.gamma(x)>>> computes the Gamma function, Î(x) - (see {{{http://mathworld.wolfram.com/GammaFunction.html}MathWorld}}, - {{{http://dlmf.nist.gov/5}DLMF}}). The accuracy of the Commons-Math - implementation is assessed by comparison with high precision values computed - with the {{{http://maxima.sourceforge.net/}Maxima}} Computer Algebra System. - -*----------------+-----------------------------------------------+-----------------+----------------------+----------------+ -|| Interval || Values tested || Average error || Standard deviation || Maximum error | -*----------------+-----------------------------------------------+-----------------+----------------------+----------------+ -| -5 \< x \< -4 | <<<x[i] = i / 1024, i = -5119, ..., -4097>>> | 0.49 ulps | 0.57 ulps | 3.0 ulps | -*----------------+-----------------------------------------------+-----------------+----------------------+----------------+ -| -4 \< x \< -3 | <<<x[i] = i / 1024, i = -4095, ..., -3073>>> | 0.36 ulps | 0.51 ulps | 2.0 ulps | -*----------------+-----------------------------------------------+-----------------+----------------------+----------------+ -| -3 \< x \< -2 | <<<x[i] = i / 1024, i = -3071, ..., -2049>>> | 0.41 ulps | 0.53 ulps | 2.0 ulps | -*----------------+-----------------------------------------------+-----------------+----------------------+----------------+ -| -2 \< x \< -1 | <<<x[i] = i / 1024, i = -2047, ..., -1025>>> | 0.37 ulps | 0.50 ulps | 2.0 ulps | -*----------------+-----------------------------------------------+-----------------+----------------------+----------------+ -| -1 \< x \< 0 | <<<x[i] = i / 1024, i = -1023, ..., -1>>> | 0.46 ulps | 0.54 ulps | 2.0 ulps | -*----------------+-----------------------------------------------+-----------------+----------------------+----------------+ -| 0 \< x ⤠8 | <<<x[i] = i / 1024, i = 1, ..., 8192>>> | 0.33 ulps | 0.48 ulps | 2.0 ulps | -*----------------+-----------------------------------------------+-----------------+----------------------+----------------+ -| 8 \< x ⤠141 | <<<x[i] = i / 64, i = 513, ..., 9024>>> | 1.32 ulps | 1.19 ulps | 7.0 ulps | -*----------------+-----------------------------------------------+-----------------+----------------------+----------------+ - -** Log Gamma - - <<<Gamma.logGamma(x)>>> computes the natural logarithm of the Gamma function, - log \u0393(x), for x > 0 - (see {{{http://mathworld.wolfram.com/LogGammaFunction.html}MathWorld}}, - {{{http://dlmf.nist.gov/5}DLMF}}). The accuracy of the Commons-Math - implementation is assessed by comparaison with high precision values computed - with the {{{http://maxima.sourceforge.net/}Maxima}} Computer Algebra System. - -*------------------------------------------------+-----------------------------------------------+-----------------+----------------------+----------------+ -|| Interval || Values tested || Average error || Standard deviation || Maximum error | -*------------------------------------------------+-----------------------------------------------+-----------------+----------------------+----------------+ -| 0 \< x ⤠8 | <<<x[i] = i / 1024, i = 1, ..., 8192>>> | 0.32 ulps | 0.50 ulps | 4.0 ulps | -*------------------------------------------------+-----------------------------------------------+-----------------+----------------------+----------------+ -| 8 \< x ⤠1024 | <<<x[i] = i / 8, i = 65, ..., 8192>>> | 0.43 ulps | 0.53 ulps | 3.0 ulps | -*------------------------------------------------+-----------------------------------------------+-----------------+----------------------+----------------+ -| 1024 \< x ⤠8192 | <<<x[i], i = 1025, ..., 8192>>> | 0.53 ulps | 0.56 ulps | 3.0 ulps | -*------------------------------------------------+-----------------------------------------------+-----------------+----------------------+----------------+ -| 8933.439345993791 ⤠x ⤠1.75555970201398e+305 | <<<x[i] = 2**(i / 8), i = 105, ..., 8112>>> | 0.35 ulps | 0.49 ulps | 2.0 ulps | -*------------------------------------------------+-----------------------------------------------+-----------------+----------------------+----------------+ - -** Regularized Gamma - - <<<Gamma.regularizedGammaP(a, x)>>> computes the value of the regularized - Gamma function, P(a, x) - (see {{{http://mathworld.wolfram.com/RegularizedGammaFunction.html}MathWorld}}). - -* 5.4 Beta functions - - {{{../apidocs/org/apache/commons/math4/special/Beta.html}Beta}} contains - several useful functions involving the Beta Function. - -** Log Beta - - <<<Beta.logBeta(a, b)>>> computes the value of the natural logarithm of the - Beta function, log B(a, b). - (see {{{http://mathworld.wolfram.com/BetaFunction.html}MathWorld}}, - {{{http://dlmf.nist.gov/5.12}DLMF}}). The accuracy of the Commons-Math - implementation is assessed by comparison with high precision values computed - with the {{{http://maxima.sourceforge.net/}Maxima}} Computer Algebra System. - -*----------------+-----------------------------------------+-----------------+----------------------+----------------+ -|| Interval || Values tested || Average error || Standard deviation || Maximum error | -*----------------+-----------------------------------------+-----------------+----------------------+-----------------+ -| 0 \< x ⤠8\ | <<<x[i] = i / 32, i = 1, ..., 256>>>\ | 1.80 ulps | 81.08 ulps | 14031.0 ulps | -| 0 \< y ⤠8 | <<<y[j] = j / 32, j = 1, ..., 256>>> | | | | -*----------------+-----------------------------------------+-----------------+----------------------+-----------------+ -| 0 \< x ⤠8\ | <<<x[i] = i / 32, i = 1, ..., 256>>>\ | 0.50 ulps | 3.64 ulps | 694.0 ulps | -| 8 \< y ⤠16 | <<<y[j] = j / 32, j = 257, ..., 512>>> | | | | -*----------------+-----------------------------------------+-----------------+----------------------+-----------------+ -| 0 \< x ⤠8\ | <<<x[i] = i / 32, i = 1, ..., 256>>>\ | 1.04 ulps | 139.32 ulps | 34509.0 ulps | -| 16 \< y ⤠256 | <<<y[j] = j, j = 17, ..., 256>>> | | | | -*----------------+-----------------------------------------+-----------------+----------------------+-----------------+ -| 8 \< x ⤠16\ | <<<x[i] = i / 32, i = 257, ..., 512>>>\ | 0.35 ulps | 0.48 ulps | 2.0 ulps | -| 8 \< y ⤠16 | <<<y[j] = j / 32, j = 257, ..., 512>>> | | | | -*----------------+-----------------------------------------+-----------------+----------------------+-----------------+ -| 8 \< x ⤠16\ | <<<x[i] = i / 32, i = 257, ..., 512>>>\ | 0.31 ulps | 0.47 ulps | 2.0 ulps | -| 16 \< y ⤠256 | <<<y[j] = j, j = 17, ..., 256>>> | | | | -*----------------+-----------------------------------------+-----------------+----------------------+-----------------+ -| 16 \< x ⤠256\ | <<<x[i] = i, i = 17, ..., 256>>>\ | 0.35 ulps | 0.49 ulps | 2.0 ulps | -| 16 \< y ⤠256 | <<<y[j] = j, j = 17, ..., 256>>> | | | | -*----------------+-----------------------------------------+-----------------+----------------------+-----------------+ - -** Regularized Beta - - (see {{{http://mathworld.wolfram.com/RegularizedBetaFunction.html}MathWorld}}) http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/7a4a3a61/src/site/design/differentiation.puml ---------------------------------------------------------------------- diff --git a/src/site/design/differentiation.puml b/src/site/design/differentiation.puml deleted file mode 100644 index 8649345..0000000 --- a/src/site/design/differentiation.puml +++ /dev/null @@ -1,105 +0,0 @@ -' 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. - -@startuml - - skinparam svek true - skinparam ClassBackgroundColor #F3EFEB - skinparam ClassArrowColor #691616 - skinparam ClassBorderColor #691616 - skinparam NoteBackgroundColor #F3EFEB - skinparam NoteBorderColor #691616 - skinparam NoteFontColor #691616 - skinparam ClassFontSize 11 - - package org.apache.commons.math4 #ECEBD8 { - - interface "FieldElement<T>" as FieldElement_T_ { - T add(T a) - T subtract(T a) - T negate() - T multiply(int n) - T multiply(T a) - T divide(T a) - T reciprocal() - Field<T> getField() - } - - package analysis #DDEBD8 { - interface UnivariateFunction { - double value(double x) - } - - package differentiation #DDDBD8 { - - class DerivativeStructure { - -DerivativeStructure(DSCompiler compiler) - +DerivativeStructure(int parameters, int order, double value) - +DerivativeStructure(int parameters, int order, int index, double value) - +int getFreeParameters() - +int getOrder() - +double getValue() - +double getPartialDerivative(int[] orders) - +double taylor(double[] delta) - +int getExponent() - +DerivativeStructure compose(double[] f) - +DerivativeStructure cos() - +DerivativeStructure sin() - +DerivativeStructure exp() - +DerivativeStructure sqrt() - } - note bottom - lots of mathematical methods - and constructors ommitted for clarity - end note - - class DSCompiler { - {static} +DSCompiler getCompiler(int parameters, int order) - +int getPartialDerivativeIndex(int[] orders) - +int[] getPartialDerivativeOrders(int index) - +int getFreeParameters() - +int getOrder() - +int getSize() - +void checkCompatibility(DSCompiler compiler) - +void compose(double[] operand, int operandOffset, double[] f, double[] result, int resultOffset) - +double taylor(double[] ds, int dsOffset, double[] delta) - +void add(double[] lhs, int lhsOffset, double[] rhs, int rhsOffset, double[] result, int resultOffset) - +void exp(double[] operand, int operandOffset, double[] result, int resultOffset) - } - note bottom - one compiler is built for each pair - (number of parameters, derivation order) - they are cached for efficiency - end note - - interface UnivariateDifferentiable { - DerivativeStructure value(DerivativeStructure t) - } - - interface UnivariateDifferentiator { - UnivariateDifferentiable differentiate(UnivariateFunction function) - } - - FieldElement_T_ <.. DerivativeStructure - DerivativeStructure o--> "1" DSCompiler : delegates computation - UnivariateFunction <|.. UnivariateDifferentiable - UnivariateDifferentiable <-- UnivariateDifferentiator : creates - UnivariateDifferentiable --> DerivativeStructure : uses - - } - } - } - -@enduml http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/7a4a3a61/src/site/design/oneD.puml ---------------------------------------------------------------------- diff --git a/src/site/design/oneD.puml b/src/site/design/oneD.puml deleted file mode 100644 index 8620f84..0000000 --- a/src/site/design/oneD.puml +++ /dev/null @@ -1,81 +0,0 @@ -' 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. - -@startuml - - skinparam svek true - skinparam ClassBackgroundColor #F3EFEB - skinparam ClassArrowColor #691616 - skinparam ClassBorderColor #691616 - skinparam NoteBackgroundColor #F3EFEB - skinparam NoteBorderColor #691616 - skinparam NoteFontColor #691616 - skinparam ClassFontSize 11 - - package org.apache.commons.complex.geometry #ECEBD8 { - - interface Space { - +int getDimension() - +Space getSubSpace() - } - note top - Space is mainly used as a parameter - for generics and to link d-dimensional - space with (d-1)-dimensional space - end note - - interface "Vector<S extends Space>" as Vector_S_ { - +Space getSpace() - +Vector getZero() - +double getNorm() - +Vector add() - +Vector subtract() - +Vector negate() - +Vector normalize() - +Vector scalarMultiply() - +boolean isNaN() - +boolean isInfinite() - +double distance() - +double dotProduct() - } - - Space <-- Vector_S_ - - package partitioning #DDEBD8 { - interface "Region<S extends Space>" as Region_S_ - interface "Hyperplane<S extends Space>" as Hyperplane_S_ - interface "SubHyperplane<S extends Space>" as SubHyperplane_S_ - } - - package euclidean #DDEBD8 { - - package oned #DDDBD8 { - - class Euclidean1D - class OrientedPoint - class Interval - class IntervalSet - - Space <|.. Euclidean1D - Vector_S_ <|.. OrientedPoint - Region_S_ <|.. IntervalSet - - } - - } - - } - -@enduml http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/7a4a3a61/src/site/design/partitioning.puml ---------------------------------------------------------------------- diff --git a/src/site/design/partitioning.puml b/src/site/design/partitioning.puml deleted file mode 100644 index 5d52e7e..0000000 --- a/src/site/design/partitioning.puml +++ /dev/null @@ -1,118 +0,0 @@ -' 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. - -@startuml - - skinparam svek true - skinparam ClassBackgroundColor #F3EFEB - skinparam ClassArrowColor #691616 - skinparam ClassBorderColor #691616 - skinparam NoteBackgroundColor #F3EFEB - skinparam NoteBorderColor #691616 - skinparam NoteFontColor #691616 - skinparam ClassFontSize 11 - - package org.apache.commons.complex.geometry #ECEBD8 { - - package partitioning #DDEBD8 { - - abstract "AbstractSubHyperplane<S extends Space, T extends Space>" as AbstractSubHyperplane_S_T_ - note left - an abstract sub-hyperplane contains - - an hyperplane defined in space S - - a region defined in space T - T being a sub-space of S - end note - - interface "Hyperplane<S extends Space>" as Hyperplane_S_ { - +double getOffset(Vector point) - +boolean sameOrientationAs(Hyperplane other) - +SubHyperplane wholeHyperplane() - +Region wholeSpace() - } - - interface "SubHyperplane<S extends Space>" as SubHyperplane_S_ { - +Hyperplane getHyperplane() - +boolean isEmpty() - +double getSize() - +Side side(Hyperplane hyperplane) - +SplitSubHyperplane split(Hyperplane hyperplane) - +SubHyperplane reunite(SubHyperplane other) - } - - class "BSPTree<S extends Space>" as BSPTree_S_ { - +boolean insertCut(Hyperplane hyperplane) - +void setAttribute(Object attribute) - +Object getAttribute() - +void visit(BSPTreeVisitor visitor) - +BSPTree getCell(Vector point) - +BSPTree split(SubHyperplane sub) - } - - interface "BSPTreeVisitor<S extends Space>" as BSPTreeVisitor_S_ { - +Order visitOrder(BSPTree node) - +void visitInternalNode(BSPTree node) - +void visitLeafNode(BSPTree node) - } - - interface "Region<S extends Space>" as Region_S_ { - +boolean isEmpty() - +boolean contains(Region region) - +Location checkPoint(Vector point) - +double getBoundarySize() - +double getSize() - +Vector getBarycenter() - +Side side(Hyperplane hyperplane) - +SubHyperplane intersection(SubHyperplane sub) - } - note top - a region is a part of the space - it may be empty, - it may cover the whole space, - it may have infinite non-closed boundaries, - it may be in several disconnected sub-parts, - it may contain holes - end note - - enum Location { - +INSIDE - +OUTSIDE - +BOUNDARY - } - - enum Side { - +PLUS - +MINUS - +BOTH - +HYPER - } - - Hyperplane_S_ "1" <--* "1" SubHyperplane_S_ - SubHyperplane_S_ "0..1" <--* BSPTree_S_ : cut - BSPTree_S_ <--o BSPTree_S_ : "parent " - BSPTree_S_ o--> BSPTree_S_ : "children" - Region_S_ *--> "1" BSPTree_S_ - Hyperplane_S_ <-- Region_S_ - AbstractSubHyperplane_S_T_ ..|> SubHyperplane_S_ - AbstractSubHyperplane_S_T_ *--> "1" Hyperplane_S_ : hyperplane - AbstractSubHyperplane_S_T_ *--> "1" Region_S_ : region - Region_S_ --> Location - Region_S_ --> Side - BSPTree_S_ <-- BSPTreeVisitor_S_ : visits - - } - - } -@enduml http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/7a4a3a61/src/site/design/solver.puml ---------------------------------------------------------------------- diff --git a/src/site/design/solver.puml b/src/site/design/solver.puml deleted file mode 100644 index d02d895..0000000 --- a/src/site/design/solver.puml +++ /dev/null @@ -1,102 +0,0 @@ -' 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. - -@startuml - - skinparam svek true - skinparam ClassBackgroundColor #F3EFEB - skinparam ClassArrowColor #691616 - skinparam ClassBorderColor #691616 - skinparam NoteBackgroundColor #F3EFEB - skinparam NoteBorderColor #691616 - skinparam NoteFontColor #691616 - skinparam ClassFontSize 11 - - package org.apache.commons.complex.differentiation.solvers #ECEBD8 { - - enum AllowedSolution { - ANY_SIDE - LEFT_SIDE - RIGHT_SIDE - BELOW_SIDE - ABOVE_SIDE - } - - interface "BaseUnivariateSolver<FUNC extends UnivariateFunction>" as BaseUnivariateSolver_FUNC_ { - +int getMaxEvaluations() - +int getEvaluations() - +double getAbsoluteAccuracy() - +double getRelativeAccuracy() - +double getFunctionValueAccuracy() - +double solve(int maxEval, FUNC f, double min, double max) - +double solve(int maxEval, FUNC f, double min, double max, double startValue) - +double solve(int maxEval, FUNC f, double startValue) - } - - abstract class "BaseAbstractUnivariateSolver<FUNC extends UnivariateFunction>" as BaseAbstractUnivariateSolver_FUNC_ { - #{Abstract} double doSolve() - } - - interface UnivariateSolver - abstract class AbstractUnivariateSolver - - interface DifferentiableUnivariateSolver - abstract class AbstractDifferentiableUnivariateSolver - - interface PolynomialSolver - abstract class AbstractPolynomialSolver - - BaseUnivariateSolver_FUNC_ <|.. BaseAbstractUnivariateSolver_FUNC_ - - BaseUnivariateSolver_FUNC_ <|.. UnivariateSolver - UnivariateSolver <|.. AbstractUnivariateSolver - BaseAbstractUnivariateSolver_FUNC_ <|-- AbstractUnivariateSolver - - BaseUnivariateSolver_FUNC_ <|.. DifferentiableUnivariateSolver - DifferentiableUnivariateSolver <|.. AbstractDifferentiableUnivariateSolver - BaseAbstractUnivariateSolver_FUNC_ <|-- AbstractDifferentiableUnivariateSolver - - BaseUnivariateSolver_FUNC_ <|.. PolynomialSolver - PolynomialSolver <|.. AbstractPolynomialSolver - BaseAbstractUnivariateSolver_FUNC_ <|-- AbstractPolynomialSolver - - -interface "BracketedUnivariateSolver<FUNC extends UnivariateFunction>" as BracketedUnivariateSolver_FUNC_ -AllowedSolution <-- BracketedUnivariateSolver_FUNC_ : solution side selector -BaseUnivariateSolver_FUNC_ <|.. BracketedUnivariateSolver_FUNC_ - -abstract class BaseSecantSolver - - AbstractUnivariateSolver <|-- BaseSecantSolver - BracketedUnivariateSolver_FUNC_ <|.. BaseSecantSolver - BaseSecantSolver <|-- IllinoisSolver - BaseSecantSolver <|-- PegasusSolver - BaseSecantSolver <|-- RegulaFalsiSolver - - AbstractUnivariateSolver <|-- BracketingNthOrderBrentSolver - BracketedUnivariateSolver_FUNC_ <|.. BracketingNthOrderBrentSolver - - AbstractUnivariateSolver <|-- BrentSolver - AbstractUnivariateSolver <|-- SecantSolver - AbstractUnivariateSolver <|-- RiddersSolver - AbstractUnivariateSolver <|-- MullerSolver - AbstractUnivariateSolver <|-- MullerSolver2 - AbstractDifferentiableUnivariateSolver <|-- NewtonSolver -AbstractPolynomialSolver <|-- LaguerreSolver - -AbstractUnivariateSolver <|-- BisectionSolver - } - -@enduml http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/7a4a3a61/src/site/design/threeD.puml ---------------------------------------------------------------------- diff --git a/src/site/design/threeD.puml b/src/site/design/threeD.puml deleted file mode 100644 index 1dc3605..0000000 --- a/src/site/design/threeD.puml +++ /dev/null @@ -1,86 +0,0 @@ -' 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. - -@startuml - - skinparam svek true - skinparam ClassBackgroundColor #F3EFEB - skinparam ClassArrowColor #691616 - skinparam ClassBorderColor #691616 - skinparam NoteBackgroundColor #F3EFEB - skinparam NoteBorderColor #691616 - skinparam NoteFontColor #691616 - skinparam ClassFontSize 11 - - package org.apache.commons.complex.geometry #ECEBD8 { - - interface Space { - +int getDimension() - +Space getSubSpace() - } - note top - Space is mainly used as a parameter - for generics and to link d-dimensional - space with (d-1)-dimensional space - end note - - interface "Vector<S extends Space>" as Vector_S_ { - +Space getSpace() - +Vector getZero() - +double getNorm() - +Vector add() - +Vector subtract() - +Vector negate() - +Vector normalize() - +Vector scalarMultiply() - +boolean isNaN() - +boolean isInfinite() - +double distance() - +double dotProduct() - } - - Space <-- Vector_S_ - - package partitioning #DDEBD8 { - interface "Region<S extends Space>" as Region_S_ - interface "Hyperplane<S extends Space>" as Hyperplane_S_ - interface "SubHyperplane<S extends Space>" as SubHyperplane_S_ - } - - package euclidean #DDEBD8 { - - package threed #DDDBD8 { - - class Euclidean3D - class Vector3D - class Line - class SubLine - class Plane - class SubPlane - class PolyhedronsSet - - Space <|.. Euclidean3D - Vector_S_ <|.. Vector3D - Hyperplane_S_ <|.. Plane - SubHyperplane_S_ <|.. SubPlane - Region_S_ <|.. PolyhedronsSet - - } - - } - - } - -@enduml http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/7a4a3a61/src/site/design/twoD.puml ---------------------------------------------------------------------- diff --git a/src/site/design/twoD.puml b/src/site/design/twoD.puml deleted file mode 100644 index 9182417..0000000 --- a/src/site/design/twoD.puml +++ /dev/null @@ -1,84 +0,0 @@ -' 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. - -@startuml - - skinparam svek true - skinparam ClassBackgroundColor #F3EFEB - skinparam ClassArrowColor #691616 - skinparam ClassBorderColor #691616 - skinparam NoteBackgroundColor #F3EFEB - skinparam NoteBorderColor #691616 - skinparam NoteFontColor #691616 - skinparam ClassFontSize 11 - - package org.apache.commons.complex.geometry #ECEBD8 { - - interface Space { - +int getDimension() - +Space getSubSpace() - } - note top - Space is mainly used as a parameter - for generics and to link d-dimensional - space with (d-1)-dimensional space - end note - - interface "Vector<S extends Space>" as Vector_S_ { - +Space getSpace() - +Vector getZero() - +double getNorm() - +Vector add() - +Vector subtract() - +Vector negate() - +Vector normalize() - +Vector scalarMultiply() - +boolean isNaN() - +boolean isInfinite() - +double distance() - +double dotProduct() - } - - Space <-- Vector_S_ - - package partitioning #DDEBD8 { - interface "Region<S extends Space>" as Region_S_ - interface "Hyperplane<S extends Space>" as Hyperplane_S_ - interface "SubHyperplane<S extends Space>" as SubHyperplane_S_ - } - - package euclidean #DDEBD8 { - - package twod #DDDBD8 { - - class Euclidean2D - class Vector2D - class Line - class SubLine - class PolygonsSet - - Space <|.. Euclidean2D - Vector_S_ <|.. Vector2D - Hyperplane_S_ <|.. Line - SubHyperplane_S_ <|.. SubLine - Region_S_ <|.. PolygonsSet - - } - - } - - } - -@enduml http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/7a4a3a61/src/site/xdoc/download_math.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/download_math.xml b/src/site/xdoc/download_math.xml deleted file mode 100644 index a934068..0000000 --- a/src/site/xdoc/download_math.xml +++ /dev/null @@ -1,168 +0,0 @@ -<?xml version="1.0"?> -<!-- -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. ---> -<!-- - +======================================================================+ - |**** ****| - |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| - |**** DO NOT EDIT DIRECTLY ****| - |**** ****| - +======================================================================+ - | TEMPLATE FILE: download-page-template.xml | - | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | - +======================================================================+ - | | - | 1) Re-generate using: mvn commons:download-page | - | | - | 2) Set the following properties in the component's pom: | - | - commons.componentid (required, alphabetic, lower case) | - | - commons.release.version (required) | - | - commons.binary.suffix (optional) | - | (defaults to "-bin", set to "" for pre-maven2 releases) | - | | - | 3) Example Properties | - | | - | <properties> | - | <commons.componentid>math</commons.componentid> | - | <commons.release.version>1.2</commons.release.version> | - | </properties> | - | | - +======================================================================+ ---> -<document> - <properties> - <title>Download Apache Commons Math</title> - <author email="[email protected]">Commons Documentation Team</author> - </properties> - <body> - <section name="Download Apache Commons Math"> - <subsection name="Using a Mirror"> - <p> - We recommend you use a mirror to download our release - builds, but you <strong>must</strong> verify the integrity of - the downloaded files using signatures downloaded from our main - distribution directories. Recent releases (48 hours) may not yet - be available from the mirrors. - </p> - - <p> - You are currently using <b>[preferred]</b>. If you - encounter a problem with this mirror, please select another - mirror. If all mirrors are failing, there are <i>backup</i> - mirrors (at the end of the mirrors list) that should be - available. - <br></br> - [if-any logo]<a href="[link]"><img align="right" src="[logo]" border="0"></img></a>[end] - </p> - - <form action="[location]" method="get" id="SelectMirror"> - <p> - Other mirrors: - <select name="Preferred"> - [if-any http] - [for http]<option value="[http]">[http]</option>[end] - [end] - [if-any ftp] - [for ftp]<option value="[ftp]">[ftp]</option>[end] - [end] - [if-any backup] - [for backup]<option value="[backup]">[backup] (backup)</option>[end] - [end] - </select> - <input type="submit" value="Change"></input> - </p> - </form> - - <p> - The <a href="http://www.apache.org/dist/commons/KEYS";>KEYS</a> - link links to the code signing keys used to sign the product. - The <code>PGP</code> link downloads the OpenPGP compatible signature from our main site. - The <code>MD5</code> link downloads the checksum from the main site. - </p> - </subsection> - </section> - <section name="Apache Commons Math 3.4.1 (requires Java 1.5+)"> - <subsection name="Binaries"> - <table> - <tr> - <td><a href="[preferred]/commons/math/binaries/commons-math3-3.4.1-bin.tar.gz">commons-math3-3.4.1-bin.tar.gz</a></td> - <td><a href="http://www.apache.org/dist/commons/math/binaries/commons-math3-3.4.1-bin.tar.gz.md5";>md5</a></td> - <td><a href="http://www.apache.org/dist/commons/math/binaries/commons-math3-3.4.1-bin.tar.gz.asc";>pgp</a></td> - </tr> - <tr> - <td><a href="[preferred]/commons/math/binaries/commons-math3-3.4.1-bin.zip">commons-math3-3.4.1-bin.zip</a></td> - <td><a href="http://www.apache.org/dist/commons/math/binaries/commons-math3-3.4.1-bin.zip.md5";>md5</a></td> - <td><a href="http://www.apache.org/dist/commons/math/binaries/commons-math3-3.4.1-bin.zip.asc";>pgp</a></td> - </tr> - </table> - </subsection> - <subsection name="Source"> - <table> - <tr> - <td><a href="[preferred]/commons/math/source/commons-math3-3.4.1-src.tar.gz">commons-math3-3.4.1-src.tar.gz</a></td> - <td><a href="http://www.apache.org/dist/commons/math/source/commons-math3-3.4.1-src.tar.gz.md5";>md5</a></td> - <td><a href="http://www.apache.org/dist/commons/math/source/commons-math3-3.4.1-src.tar.gz.asc";>pgp</a></td> - </tr> - <tr> - <td><a href="[preferred]/commons/math/source/commons-math3-3.4.1-src.zip">commons-math3-3.4.1-src.zip</a></td> - <td><a href="http://www.apache.org/dist/commons/math/source/commons-math3-3.4.1-src.zip.md5";>md5</a></td> - <td><a href="http://www.apache.org/dist/commons/math/source/commons-math3-3.4.1-src.zip.asc";>pgp</a></td> - </tr> - </table> - </subsection> - </section> - <section name="Apache Commons Math 2.2 (requires Java 1.5+)"> - <subsection name="Binaries"> - <table> - <tr> - <td><a href="[preferred]/commons/math/binaries/commons-math-2.2.tar.gz">commons-math-2.2.tar.gz</a></td> - <td><a href="http://www.apache.org/dist/commons/math/binaries/commons-math-2.2.tar.gz.md5";>md5</a></td> - <td><a href="http://www.apache.org/dist/commons/math/binaries/commons-math-2.2.tar.gz.asc";>pgp</a></td> - </tr> - <tr> - <td><a href="[preferred]/commons/math/binaries/commons-math-2.2.zip">commons-math-2.2.zip</a></td> - <td><a href="http://www.apache.org/dist/commons/math/binaries/commons-math-2.2.zip.md5";>md5</a></td> - <td><a href="http://www.apache.org/dist/commons/math/binaries/commons-math-2.2.zip.asc";>pgp</a></td> - </tr> - </table> - </subsection> - <subsection name="Source"> - <table> - <tr> - <td><a href="[preferred]/commons/math/source/commons-math-2.2-src.tar.gz">commons-math-2.2-src.tar.gz</a></td> - <td><a href="http://www.apache.org/dist/commons/math/source/commons-math-2.2-src.tar.gz.md5";>md5</a></td> - <td><a href="http://www.apache.org/dist/commons/math/source/commons-math-2.2-src.tar.gz.asc";>pgp</a></td> - </tr> - <tr> - <td><a href="[preferred]/commons/math/source/commons-math-2.2-src.zip">commons-math-2.2-src.zip</a></td> - <td><a href="http://www.apache.org/dist/commons/math/source/commons-math-2.2-src.zip.md5";>md5</a></td> - <td><a href="http://www.apache.org/dist/commons/math/source/commons-math-2.2-src.zip.asc";>pgp</a></td> - </tr> - </table> - </subsection> - </section> - <section name="Archives"> - <p> - Older releases can be obtained from the archives. - </p> - <ul> - <li class="download"><a href="[preferred]/commons/math/">browse download area</a></li> - <li><a href="http://archive.apache.org/dist/commons/math/";>archives...</a></li> - </ul> - </section> - </body> -</document> http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/7a4a3a61/src/site/xdoc/proposal.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/proposal.xml b/src/site/xdoc/proposal.xml deleted file mode 100644 index d277c5b..0000000 --- a/src/site/xdoc/proposal.xml +++ /dev/null @@ -1,131 +0,0 @@ -<?xml version="1.0"?> - -<!-- - 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. - --> - -<document> - - <properties> - <title>Proposal for math Package</title> - <author email="[email protected]">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>[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 - [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:[email protected]";>Robert Burrell Donkin</a></li> - <li><a href="mailto:[email protected]";>Tim O'Brien</a></li> -</ul> -</p> - </subsection> - </section> - </body> -</document>
