[marf-cvs] marf/src/marf/math ComplexMatrix.java, 1.11, 1.12 ComplexNumber.java, 1.2, 1.3 ComplexVe
Brought to you by:
mokhov
Menu
▾
▴
[marf-cvs] marf/src/marf/math ComplexMatrix.java, 1.11, 1.12 ComplexNumber.java, 1.2, 1.3 ComplexVector.java, 1.2, 1.3 MathException.java, 1.5, 1.6 Matrix.java, 1.46, 1.47 Vector.java, 1.13, 1.14
|
From: Serguei A. M. <mo...@us...> - 2007-12-18 03:45:46
|
Update of /cvsroot/marf/marf/src/marf/math In directory sc8-pr-cvs16.sourceforge.net:/tmp/cvs-serv1905/math Modified Files: ComplexMatrix.java ComplexNumber.java ComplexVector.java MathException.java Matrix.java Vector.java Log Message: With Eclipse Europa review primarily spelling in comments. Massage a few other places WRT comments and coding convention. There is a lot more work to do in this area, but this can be done as a gap filler. Index: ComplexMatrix.java =================================================================== RCS file: /cvsroot/marf/marf/src/marf/math/ComplexMatrix.java,v retrieving revision 1.11 retrieving revision 1.12 diff -C2 -d -r1.11 -r1.12 *** ComplexMatrix.java 28 May 2006 05:06:00 -0000 1.11 --- ComplexMatrix.java 18 Dec 2007 03:45:42 -0000 1.12 *************** *** 123,126 **** --- 123,130 ---- } + /** + * @param pao1DMatrix + * @param pbTransposed + */ public ComplexMatrix(final ComplexNumber[] pao1DMatrix, boolean pbTransposed) { *************** *** 154,158 **** } ! public ComplexMatrix(final ComplexNumber[][] paoo2DMatrix) { --- 158,164 ---- } ! /** ! * @param paoo2DMatrix ! */ public ComplexMatrix(final ComplexNumber[][] paoo2DMatrix) { *************** *** 212,215 **** --- 218,226 ---- } + /** + * @param poLHSMatrix + * @param poRHSMatrix + * @return + */ public static ComplexMatrix add(final Matrix poLHSMatrix, final ComplexMatrix poRHSMatrix) { *************** *** 218,221 **** --- 229,237 ---- } + /** + * @param poLHSMatrix + * @param poRHSMatrix + * @return + */ public static ComplexMatrix add(final ComplexMatrix poLHSMatrix, final Matrix poRHSMatrix) { *************** *** 225,228 **** --- 241,249 ---- + /** + * @param poLHSMatrix + * @param poRHSMatrix + * @return + */ public static ComplexMatrix minus(final ComplexMatrix poLHSMatrix, final ComplexMatrix poRHSMatrix) { *************** *** 230,233 **** --- 251,259 ---- } + /** + * @param poLHSMatrix + * @param poRHSMatrix + * @return + */ public static ComplexMatrix minus(final Matrix poLHSMatrix, final ComplexMatrix poRHSMatrix) { *************** *** 236,239 **** --- 262,270 ---- } + /** + * @param poLHSMatrix + * @param poRHSMatrix + * @return + */ public static ComplexMatrix minus(final ComplexMatrix poLHSMatrix, final Matrix poRHSMatrix) { *************** *** 243,246 **** --- 274,282 ---- + /** + * @param poLHSMatrix + * @param poRHSMatrix + * @return + */ public static ComplexMatrix multiply(final ComplexMatrix poLHSMatrix, final ComplexMatrix poRHSMatrix) { *************** *** 248,251 **** --- 284,292 ---- } + /** + * @param poLHSMatrix + * @param poRHSMatrix + * @return + */ public static ComplexMatrix multiply(final Matrix poLHSMatrix, final ComplexMatrix poRHSMatrix) { *************** *** 254,257 **** --- 295,303 ---- } + /** + * @param poLHSMatrix + * @param poRHSMatrix + * @return + */ public static ComplexMatrix multiply(final ComplexMatrix poLHSMatrix, final Matrix poRHSMatrix) { *************** *** 261,264 **** --- 307,315 ---- + /** + * @param poLHSMatrix + * @param poRHSMatrix + * @return + */ public static ComplexMatrix divide(final ComplexMatrix poLHSMatrix, final ComplexMatrix poRHSMatrix) { *************** *** 266,269 **** --- 317,325 ---- } + /** + * @param poLHSMatrix + * @param poRHSMatrix + * @return + */ public static ComplexMatrix divide(final Matrix poLHSMatrix, final ComplexMatrix poRHSMatrix) { *************** *** 272,275 **** --- 328,336 ---- } + /** + * @param poLHSMatrix + * @param poRHSMatrix + * @return + */ public static ComplexMatrix divide(final ComplexMatrix poLHSMatrix, final Matrix poRHSMatrix) { *************** *** 279,282 **** --- 340,348 ---- + /** + * @param poLHSMatrix + * @param pdNum + * @return + */ public static ComplexMatrix add(final ComplexMatrix poLHSMatrix, double pdNum) { *************** *** 284,287 **** --- 350,358 ---- } + /** + * @param poLHSMatrix + * @param pdNum + * @return + */ public static ComplexMatrix add(final ComplexMatrix poLHSMatrix, final ComplexNumber pdNum) { *************** *** 299,302 **** --- 370,378 ---- } + /** + * @param poMatrix + * @param pdNum + * @return + */ public static ComplexMatrix multiply(final ComplexMatrix poMatrix, final double pdNum) { *************** *** 304,307 **** --- 380,388 ---- } + /** + * @param pdNum + * @param poMatrix + * @return + */ public static ComplexMatrix multiply(final double pdNum, final ComplexMatrix poMatrix) { *************** *** 309,312 **** --- 390,398 ---- } + /** + * @param poMatrix + * @param piPow + * @return + */ public static ComplexMatrix pow(final ComplexMatrix poMatrix, int piPow) { *************** *** 314,317 **** --- 400,407 ---- } + /** + * @param piPow + * @return + */ public ComplexMatrix powComplex(int piPow) { *************** *** 338,341 **** --- 428,434 ---- } + /* (non-Javadoc) + * @see marf.math.Matrix#applyMultiply(marf.math.Matrix, marf.math.Matrix, int, int) + */ protected Matrix applyMultiply(final Matrix poLHSMatrix, final Matrix poRHSMatrix, int i, int j) { *************** *** 356,359 **** --- 449,455 ---- } + /* (non-Javadoc) + * @see marf.math.Matrix#applyMultiply(marf.math.Matrix, marf.math.Matrix) + */ protected Matrix applyMultiply(final Matrix poLHSMatrix, final Matrix poRHSMatrix) { *************** *** 468,471 **** --- 564,571 ---- } + /** + * @param iRawOffset + * @param poNumber + */ protected void setComplexNumber(int iRawOffset, final ComplexNumber poNumber) { *************** *** 506,509 **** --- 606,612 ---- } + /** + * @param poMatrix + */ private void setMatrixData(final Matrix poMatrix) { *************** *** 512,515 **** --- 615,621 ---- } + /* (non-Javadoc) + * @see marf.math.Matrix#getNewMatrix() + */ protected Matrix getNewMatrix() { *************** *** 518,521 **** --- 624,630 ---- } + /* (non-Javadoc) + * @see marf.math.Matrix#getNewMatrix(int, int) + */ protected /*static*/ Matrix getNewMatrix(int piRows, int piCols) { *************** *** 779,782 **** --- 888,895 ---- } + /** + * @param piColNum + * @return + */ public ComplexVector getComplexColumn(final int piColNum) { *************** *** 803,806 **** --- 916,923 ---- } + /** + * @param piRowNum + * @return + */ public ComplexVector getComplexRow(final int piRowNum) { *************** *** 1079,1082 **** --- 1196,1202 ---- } + /** + * @param paoo2DMatrix + */ public void setMatrix2D(final ComplexNumber[][] paoo2DMatrix) { Index: MathException.java =================================================================== RCS file: /cvsroot/marf/marf/src/marf/math/MathException.java,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** MathException.java 13 Aug 2005 23:09:39 -0000 1.5 --- MathException.java 18 Dec 2007 03:45:42 -0000 1.6 *************** *** 6,19 **** * <p>Indicates exceptional situations in MARF's math.</p> * ! * <p>$Id$</p> * * @author Serguei Mokhov * @version $Revision$ ! * @since 0.3.0 */ public class MathException extends MARFException { ! /** * For serialization versioning. * When adding new members or make other structural --- 6,19 ---- * <p>Indicates exceptional situations in MARF's math.</p> * ! * $Id$ * * @author Serguei Mokhov * @version $Revision$ ! * @since 0.3.0.2 */ public class MathException extends MARFException { ! /** * For serialization versioning. * When adding new members or make other structural Index: ComplexNumber.java =================================================================== RCS file: /cvsroot/marf/marf/src/marf/math/ComplexNumber.java,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** ComplexNumber.java 12 May 2006 22:18:43 -0000 1.2 --- ComplexNumber.java 18 Dec 2007 03:45:42 -0000 1.3 *************** *** 1,5 **** - /** - * - */ package marf.math; --- 1,2 ---- *************** *** 8,12 **** /** ! * <p>Implements complex number ariphmetic.</p> * * $Id$ --- 5,9 ---- /** ! * <p>Implements complex number arithmetic.</p> * * $Id$ *************** *** 14,22 **** --- 11,27 ---- * @author Serguei Mokhov * @since 0.3.0.6 + * @version $Revision$ */ public final class ComplexNumber implements Cloneable, Serializable { + /** + * + */ protected double dReal = 0; + + /** + * + */ protected double dImaginary = 0; *************** *** 29,32 **** --- 34,41 ---- } + /** + * @param pdReal + * @param pdImaginary + */ public ComplexNumber(double pdReal, double pdImaginary) { *************** *** 35,38 **** --- 44,50 ---- } + /** + * @param pdReal + */ public ComplexNumber(double pdReal) { *************** *** 268,271 **** --- 280,287 ---- } + /** + * @param pdPhaseAngle + * @param pdRadius + */ public void setPolarCoordinates(double pdPhaseAngle, double pdRadius) { *************** *** 274,277 **** --- 290,296 ---- } + /** + * @return + */ public double getPhaseAngle() { *************** *** 279,282 **** --- 298,304 ---- } + /** + * @return + */ public double getRadius() { Index: Matrix.java =================================================================== RCS file: /cvsroot/marf/marf/src/marf/math/Matrix.java,v retrieving revision 1.46 retrieving revision 1.47 diff -C2 -d -r1.46 -r1.47 *** Matrix.java 28 May 2006 05:06:01 -0000 1.46 --- Matrix.java 18 Dec 2007 03:45:42 -0000 1.47 *************** *** 9,13 **** /** * <p>Provides linear math and storage matrix operations. ! * This class implementes a 2-dimensional matrix of doubles; * internally implemented as a single-dimensional array with * a common linear algebra operations as well as methods to --- 9,13 ---- /** * <p>Provides linear math and storage matrix operations. ! * This class implements a 2-dimensional matrix of doubles; * internally implemented as a single-dimensional array with * a common linear algebra operations as well as methods to *************** *** 236,240 **** /** ! * Allows getting internal array represeting the matrix data. * @return inner array of doubles */ --- 236,240 ---- /** ! * Allows getting internal array representing the matrix data. * @return inner array of doubles */ *************** *** 246,250 **** /** * Allows setting the new internal array of matrix data ! * from the paramter. The cardinality is kept before * the setting as no assumptions is made about the new * data. The array is copied entirely into internal storage. --- 246,250 ---- /** * Allows setting the new internal array of matrix data ! * from the parameter. The cardinality is kept before * the setting as no assumptions is made about the new * data. The array is copied entirely into internal storage. *************** *** 310,314 **** /** ! * Analoguous to <code>getElements()</code>. * @return element count * @since 0.3.0.1 --- 310,314 ---- /** ! * Analogous to <code>getElements()</code>. * @return element count * @since 0.3.0.1 *************** *** 609,616 **** /** ! * Extends this matrix by another (by glueing two matrices together) assuming * the extension direction of <code>Direction.EAST</code>. NOTICE, if doubling ! * the same <code>this</code> matrix, make a copy for the argument istead. ! * @param poExtensionMatrix the matrix to exten the current by * @return <code>true</code> if the operation was successful * @see Direction#EAST --- 609,616 ---- /** ! * Extends this matrix by another (by gluing two matrices together) assuming * the extension direction of <code>Direction.EAST</code>. NOTICE, if doubling ! * the same <code>this</code> matrix, make a copy for the argument instead. ! * @param poExtensionMatrix the matrix to extend the current by * @return <code>true</code> if the operation was successful * @see Direction#EAST *************** *** 622,630 **** /** ! * Extends this matrix by another (by glueing two matrices together) given * the extension direction. NOTICE, if doubling the same matrix, ! * make a copy for the argument istead. * ! * @param poExtensionMatrix the matrix to exten the current by * @param poDirection in which direction the extension should happen * @return <code>true</code> if the operation was successful --- 622,630 ---- /** ! * Extends this matrix by another (by gluing two matrices together) given * the extension direction. NOTICE, if doubling the same matrix, ! * make a copy for the argument instead. * ! * @param poExtensionMatrix the matrix to extend the current by * @param poDirection in which direction the extension should happen * @return <code>true</code> if the operation was successful *************** *** 1105,1109 **** } ! // If the first colum, just crop it. if(piColNum == 0) { --- 1105,1109 ---- } ! // If the first column, just crop it. if(piColNum == 0) { *************** *** 1111,1115 **** } ! // If the last colum, just crop it. if(piColNum == this.iCols - 1) { --- 1111,1115 ---- } ! // If the last column, just crop it. if(piColNum == this.iCols - 1) { *************** *** 1188,1191 **** --- 1188,1194 ---- } + /** + * @return + */ protected Matrix getNewMatrix() { *************** *** 1194,1197 **** --- 1197,1205 ---- } + /** + * @param piRows + * @param piCols + * @return + */ protected /*static*/ Matrix getNewMatrix(int piRows, int piCols) { *************** *** 1323,1327 **** /** * Checks for strict identity matrix. ! * Any diviations due to errors in floarting point arithmetic * will return <code>false</code>. If imprecise values are allowed, * consider using <code>isNearlyIdentity()</code>. --- 1331,1335 ---- /** * Checks for strict identity matrix. ! * Any deviations due to errors in floating point arithmetic * will return <code>false</code>. If imprecise values are allowed, * consider using <code>isNearlyIdentity()</code>. *************** *** 1341,1345 **** * Tests nearly-identity matrices with the specified delta. * @param pdDelta the FP error to assume when checking for identity ! * @return <code>true</code> if the matrix is nearly indentity */ public final boolean isNearlyIdentity(final double pdDelta) --- 1349,1353 ---- * Tests nearly-identity matrices with the specified delta. * @param pdDelta the FP error to assume when checking for identity ! * @return <code>true</code> if the matrix is nearly identity */ public final boolean isNearlyIdentity(final double pdDelta) *************** *** 1371,1375 **** /** * Tests nearly-identity matrices with the default delta. ! * @return <code>true</code> if the matrix is nearly indentity * @see #DEFAULT_ERROR_DELTA */ --- 1379,1383 ---- /** * Tests nearly-identity matrices with the default delta. ! * @return <code>true</code> if the matrix is nearly identity * @see #DEFAULT_ERROR_DELTA */ *************** *** 2269,2273 **** /** ! * Retrieves curret direction. * @return current value of direction */ --- 2277,2281 ---- /** ! * Retrieves current direction. * @return current value of direction */ Index: Vector.java =================================================================== RCS file: /cvsroot/marf/marf/src/marf/math/Vector.java,v retrieving revision 1.13 retrieving revision 1.14 diff -C2 -d -r1.13 -r1.14 *** Vector.java 27 Apr 2006 13:27:09 -0000 1.13 --- Vector.java 18 Dec 2007 03:45:42 -0000 1.14 *************** *** 85,89 **** /** ! * Allows having a transposed vector upon consuctrion. * Useful for example before doing linear operations. * @param pad1DMatrix vector data --- 85,89 ---- /** ! * Allows having a transposed vector upon construction. * Useful for example before doing linear operations. * @param pad1DMatrix vector data *************** *** 112,116 **** /** * Allows setting the value of vector's element at specified position. ! * @param piPosition index to det the element at * @param pdValue the element's value */ --- 112,116 ---- /** * Allows setting the value of vector's element at specified position. ! * @param piPosition index to set the element at * @param pdValue the element's value */ *************** *** 285,289 **** /** * Creates a unit-vector "i". ! * @return a new vector instante of {1, 0, 0} */ public final static Vector i() --- 285,289 ---- /** * Creates a unit-vector "i". ! * @return a new vector instance of {1, 0, 0} */ public final static Vector i() *************** *** 294,298 **** /** * Creates a unit-vector "j". ! * @return a new vector instante of {0, 1, 0} */ public final static Vector j() --- 294,298 ---- /** * Creates a unit-vector "j". ! * @return a new vector instance of {0, 1, 0} */ public final static Vector j() *************** *** 303,307 **** /** * Creates a unit-vector "k". ! * @return a new vector instante of {0, 0, 1} */ public final static Vector k() --- 303,307 ---- /** * Creates a unit-vector "k". ! * @return a new vector instance of {0, 0, 1} */ public final static Vector k() Index: ComplexVector.java =================================================================== RCS file: /cvsroot/marf/marf/src/marf/math/ComplexVector.java,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** ComplexVector.java 28 May 2006 05:06:00 -0000 1.2 --- ComplexVector.java 18 Dec 2007 03:45:42 -0000 1.3 *************** *** 84,88 **** /** ! * Allows having a transposed ComplexVector upon consuctrion. * Useful for example before doing linear operations. * @param pad1DMatrix ComplexVector data --- 84,88 ---- /** ! * Allows having a transposed ComplexVector upon construction. * Useful for example before doing linear operations. * @param pad1DMatrix ComplexVector data *************** *** 108,111 **** --- 108,115 ---- } + /** + * @param piPosition + * @return + */ public final ComplexNumber getComplexElement(final int piPosition) { |