You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by lu...@apache.org on 2009/06/01 15:24:19 UTC
svn commit: r780645 - in
/commons/proper/math/trunk/src/java/org/apache/commons/math: linear/ stat/
stat/descriptive/moment/
Author: luc
Date: Mon Jun 1 13:24:19 2009
New Revision: 780645
URL: http://svn.apache.org/viewvc?rev=780645&view=rev
Log:
fixed javadoc
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldMatrix.java
commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldVector.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/Frequency.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/VectorialCovariance.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/VectorialMean.java
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldMatrix.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldMatrix.java?rev=780645&r1=780644&r2=780645&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldMatrix.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldMatrix.java Mon Jun 1 13:24:19 2009
@@ -21,11 +21,12 @@
import org.apache.commons.math.util.OpenIntToFieldHashMap;
/**
-* Sparse matrix implementation based on an open addressed map.
-*
-* @version $Revision: 762117 $ $Date: 2009-04-05 09:53:35 -0700 (Sun, 05 Apr 2009) $
-* @since 2.0
-*/
+ * Sparse matrix implementation based on an open addressed map.
+ *
+ * @param <T> the type of the field elements
+ * @version $Revision: 762117 $ $Date: 2009-04-05 09:53:35 -0700 (Sun, 05 Apr 2009) $
+ * @since 2.0
+ */
public class SparseFieldMatrix<T extends FieldElement<T>> extends AbstractFieldMatrix<T> {
/**
* Serial id
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldVector.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldVector.java?rev=780645&r1=780644&r2=780645&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldVector.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldVector.java Mon Jun 1 13:24:19 2009
@@ -26,9 +26,10 @@
/**
* This class implements the {@link FieldVector} interface with a {@link OpenIntToFieldHashMap} backing store.
+ * @param <T> the type of the field elements
* @version $Revision: 728186 $ $Date: 2009-04-25 12:39:38 -0700 (Sat, 25 Apr 2009) $
* @since 2.0
-*/
+ */
public class SparseFieldVector<T extends FieldElement<T>> implements FieldVector<T>, Serializable {
/**
@@ -50,6 +51,7 @@
* or one of the <code>append</code> method ({@link #append(Field<T>)}, {@link
* #append(Field<T>[])}, {@link #append(FieldVector)}) to gather data
* into this vector.</p>
+ * @param field field to which the elements belong
*/
public SparseFieldVector(Field<T> field) {
this(field, 0);
@@ -58,8 +60,8 @@
/**
* Construct a (dimension)-length vector of zeros.
+ * @param field field to which the elements belong
* @param dimension Size of the vector
- * @param epsilon The tolerance for having a value considered zero
*/
public SparseFieldVector(Field<T> field, int dimension) {
this.field = field;
@@ -81,9 +83,9 @@
/**
* Build a vector with known the sparseness (for advanced use only).
+ * @param field field to which the elements belong
* @param dimension The size of the vector
* @param expectedSize The expected number of non-zero entries
- * @param epsilon The tolerance for having a value considered zero
*/
public SparseFieldVector(Field<T> field, int dimension, int expectedSize) {
this.field = field;
@@ -94,8 +96,8 @@
/**
* Create from a Field array.
* Only non-zero entries will be stored
+ * @param field field to which the elements belong
* @param values The set of values to create from
- * @param epsilon The tolerance for having a value considered zero
*/
public SparseFieldVector(Field<T> field, T[] values) {
this.field = field;
@@ -129,6 +131,7 @@
/**
* Optimized method to add sparse vectors.
+ * @param v vector to add
* @return The sum of <code>this</code> and <code>v</code>
* @throws IllegalArgumentException If the dimensions don't match
*/
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/Frequency.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/Frequency.java?rev=780645&r1=780644&r2=780645&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/Frequency.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/Frequency.java Mon Jun 1 13:24:19 2009
@@ -499,21 +499,17 @@
}
}
- /* (non-Javadoc)
- * @see java.lang.Object#hashCode()
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
- result = prime * result
- + ((freqTable == null) ? 0 : freqTable.hashCode());
+ result = prime * result +
+ ((freqTable == null) ? 0 : freqTable.hashCode());
return result;
}
- /* (non-Javadoc)
- * @see java.lang.Object#equals(java.lang.Object)
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(Object obj) {
if (this == obj)
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/VectorialCovariance.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/VectorialCovariance.java?rev=780645&r1=780644&r2=780645&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/VectorialCovariance.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/VectorialCovariance.java Mon Jun 1 13:24:19 2009
@@ -118,7 +118,7 @@
Arrays.fill(productsSums, 0.0);
}
- /** @inheritDoc{} */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
final int prime = 31;
@@ -130,7 +130,7 @@
return result;
}
- /** @inheritDoc{} */
+ /** {@inheritDoc} */
@Override
public boolean equals(Object obj) {
if (this == obj)
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/VectorialMean.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/VectorialMean.java?rev=780645&r1=780644&r2=780645&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/VectorialMean.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/VectorialMean.java Mon Jun 1 13:24:19 2009
@@ -78,7 +78,7 @@
return (means.length == 0) ? 0 : means[0].getN();
}
- /* @inheritDocs{} */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
final int prime = 31;
@@ -87,7 +87,7 @@
return result;
}
- /* @inheritDocs{} */
+ /** {@inheritDoc} */
@Override
public boolean equals(Object obj) {
if (this == obj)