You are viewing a plain text version of this content. The canonical link for it is here.
Posted to s4-commits@incubator.apache.org by mm...@apache.org on 2012/07/26 10:52:41 UTC
[11/16] Javadoc updates - added package docs - updated existing
javadoc, added some missing javadoc - removed unused classes
http://git-wip-us.apache.org/repos/asf/incubator-s4/blob/c349777b/subprojects/s4-example/src/main/java/org/apache/s4/example/model/MaximizerPE.java
----------------------------------------------------------------------
diff --git a/subprojects/s4-example/src/main/java/org/apache/s4/example/model/MaximizerPE.java b/subprojects/s4-example/src/main/java/org/apache/s4/example/model/MaximizerPE.java
index 8d08871..73b0108 100644
--- a/subprojects/s4-example/src/main/java/org/apache/s4/example/model/MaximizerPE.java
+++ b/subprojects/s4-example/src/main/java/org/apache/s4/example/model/MaximizerPE.java
@@ -25,11 +25,9 @@ import org.apache.s4.core.Stream;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-
final public class MaximizerPE extends ProcessingElement {
- private static final Logger logger = LoggerFactory
- .getLogger(MaximizerPE.class);
+ private static final Logger logger = LoggerFactory.getLogger(MaximizerPE.class);
private int numClasses;
private Stream<ObsEvent> assignmentStream;
@@ -41,10 +39,6 @@ final public class MaximizerPE extends ProcessingElement {
super(app);
}
- /**
- * @param countStream
- * the countStream to set
- */
public void setAssignmentStream(Stream<ObsEvent> stream) {
assignmentStream = stream;
}
@@ -77,8 +71,7 @@ final public class MaximizerPE extends ProcessingElement {
if (++numEventsReceived == numClasses) {
/* Got all the distances. Send class id with minimum distance. */
- ObsEvent outEvent = new ObsEvent(inEvent.getIndex(), obs,
- maxLogProb, inEvent.getClassId(), hypID, false);
+ ObsEvent outEvent = new ObsEvent(inEvent.getIndex(), obs, maxLogProb, inEvent.getClassId(), hypID, false);
logger.trace("IN: " + inEvent.toString());
logger.trace("OUT: " + outEvent.toString());
http://git-wip-us.apache.org/repos/asf/incubator-s4/blob/c349777b/subprojects/s4-example/src/main/java/org/apache/s4/example/model/Module.java
----------------------------------------------------------------------
diff --git a/subprojects/s4-example/src/main/java/org/apache/s4/example/model/Module.java b/subprojects/s4-example/src/main/java/org/apache/s4/example/model/Module.java
index 50b6479..2564360 100644
--- a/subprojects/s4-example/src/main/java/org/apache/s4/example/model/Module.java
+++ b/subprojects/s4-example/src/main/java/org/apache/s4/example/model/Module.java
@@ -18,7 +18,6 @@
package org.apache.s4.example.model;
-
import java.io.InputStream;
import org.apache.commons.configuration.ConfigurationConverter;
@@ -34,10 +33,7 @@ import com.google.inject.name.Names;
/**
* Configures the controller.
*
- * Reads a properties file, provides a {@link Communicator} singleton, and
- * configures Guice bindings.
*
- * @author Leo Neumeyer
*/
public class Module extends AbstractModule {
@@ -46,8 +42,7 @@ public class Module extends AbstractModule {
private void loadProperties(Binder binder) {
try {
- InputStream is = this.getClass().getResourceAsStream(
- "/model.properties");
+ InputStream is = this.getClass().getResourceAsStream("/model.properties");
config = new PropertiesConfiguration();
config.load(is);
@@ -55,8 +50,7 @@ public class Module extends AbstractModule {
// TODO - validate properties.
/* Make all properties injectable. Do we need this? */
- Names.bindProperties(binder,
- ConfigurationConverter.getProperties(config));
+ Names.bindProperties(binder, ConfigurationConverter.getProperties(config));
} catch (ConfigurationException e) {
binder.addError(e);
e.printStackTrace();
@@ -72,8 +66,7 @@ public class Module extends AbstractModule {
int numGaussians = config.getInt("model.num_gaussians");
/*
- * Here we bind a specific Model implementation. This one is the
- * GaussianMixtureModel
+ * Here we bind a specific Model implementation. This one is the GaussianMixtureModel
*/
bind(Model.class).toInstance(
new org.apache.s4.model.GaussianMixtureModel(vectorSize, numGaussians,
http://git-wip-us.apache.org/repos/asf/incubator-s4/blob/c349777b/subprojects/s4-example/src/main/java/org/apache/s4/example/model/MyApp.java
----------------------------------------------------------------------
diff --git a/subprojects/s4-example/src/main/java/org/apache/s4/example/model/MyApp.java b/subprojects/s4-example/src/main/java/org/apache/s4/example/model/MyApp.java
index 61314e1..4ca32e1 100644
--- a/subprojects/s4-example/src/main/java/org/apache/s4/example/model/MyApp.java
+++ b/subprojects/s4-example/src/main/java/org/apache/s4/example/model/MyApp.java
@@ -132,8 +132,6 @@ public class MyApp extends App {
/**
* Check if a test is complete.
*
- * @param number
- * of test vectors.
* @return true when testing is complete.
*/
public boolean isTested(long numTestVectors) {
http://git-wip-us.apache.org/repos/asf/incubator-s4/blob/c349777b/subprojects/s4-example/src/main/java/org/apache/s4/model/GaussianMixtureModel.java
----------------------------------------------------------------------
diff --git a/subprojects/s4-example/src/main/java/org/apache/s4/model/GaussianMixtureModel.java b/subprojects/s4-example/src/main/java/org/apache/s4/model/GaussianMixtureModel.java
index 01a9bb1..7047a7d 100644
--- a/subprojects/s4-example/src/main/java/org/apache/s4/model/GaussianMixtureModel.java
+++ b/subprojects/s4-example/src/main/java/org/apache/s4/model/GaussianMixtureModel.java
@@ -29,7 +29,6 @@ import org.ejml.ops.CommonOps;
* A multivariate Gaussian mixture model. Only diagonal covariance matrices are
* supported.
*
- * @author Leo Neumeyer
*
*/
public class GaussianMixtureModel extends Model {
http://git-wip-us.apache.org/repos/asf/incubator-s4/blob/c349777b/subprojects/s4-example/src/main/java/org/apache/s4/model/GaussianModel.java
----------------------------------------------------------------------
diff --git a/subprojects/s4-example/src/main/java/org/apache/s4/model/GaussianModel.java b/subprojects/s4-example/src/main/java/org/apache/s4/model/GaussianModel.java
index 805b6ee..6f86deb 100644
--- a/subprojects/s4-example/src/main/java/org/apache/s4/model/GaussianModel.java
+++ b/subprojects/s4-example/src/main/java/org/apache/s4/model/GaussianModel.java
@@ -28,7 +28,6 @@ import org.ejml.ops.CommonOps;
* A multivariate Gaussian model with parameters mean (mu) and variance (sigma
* squared). Only diagonal covariance matrices are supported.
*
- * @author Leo Neumeyer
*
*/
public class GaussianModel extends Model {
http://git-wip-us.apache.org/repos/asf/incubator-s4/blob/c349777b/subprojects/s4-example/src/main/java/org/apache/s4/model/Model.java
----------------------------------------------------------------------
diff --git a/subprojects/s4-example/src/main/java/org/apache/s4/model/Model.java b/subprojects/s4-example/src/main/java/org/apache/s4/model/Model.java
index aefd16b..68d3cf0 100644
--- a/subprojects/s4-example/src/main/java/org/apache/s4/model/Model.java
+++ b/subprojects/s4-example/src/main/java/org/apache/s4/model/Model.java
@@ -22,7 +22,6 @@ package org.apache.s4.model;
*
* Base class for statistical models.
*
- * @author Leo Neumeyer
*
*/
abstract public class Model {
@@ -82,10 +81,6 @@ abstract public class Model {
return isTrain;
}
- /**
- * @param train
- * set train.
- */
public void setTrain(boolean isTrain) {
this.isTrain = isTrain;
}
http://git-wip-us.apache.org/repos/asf/incubator-s4/blob/c349777b/subprojects/s4-example/src/main/java/org/apache/s4/util/MatrixOps.java
----------------------------------------------------------------------
diff --git a/subprojects/s4-example/src/main/java/org/apache/s4/util/MatrixOps.java b/subprojects/s4-example/src/main/java/org/apache/s4/util/MatrixOps.java
index 1efde2b..c56f39a 100644
--- a/subprojects/s4-example/src/main/java/org/apache/s4/util/MatrixOps.java
+++ b/subprojects/s4-example/src/main/java/org/apache/s4/util/MatrixOps.java
@@ -26,7 +26,6 @@ import org.ejml.data.DenseMatrix64F;
/**
* Extensions to the EJML library.
*
- * @author Leo Neumeyer
*/
public class MatrixOps {
http://git-wip-us.apache.org/repos/asf/incubator-s4/blob/c349777b/subprojects/s4-tools/src/main/java/org/apache/s4/tools/package-info.java
----------------------------------------------------------------------
diff --git a/subprojects/s4-tools/src/main/java/org/apache/s4/tools/package-info.java b/subprojects/s4-tools/src/main/java/org/apache/s4/tools/package-info.java
new file mode 100644
index 0000000..940025e
--- /dev/null
+++ b/subprojects/s4-tools/src/main/java/org/apache/s4/tools/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Implementations of S4-related commands. Includes parsing, validation and interpretation of the various commands and options available.
+ */
+package org.apache.s4.tools;
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-s4/blob/c349777b/test-apps/producer-app/src/main/java/s4app/ProducerPE.java
----------------------------------------------------------------------
diff --git a/test-apps/producer-app/src/main/java/s4app/ProducerPE.java b/test-apps/producer-app/src/main/java/s4app/ProducerPE.java
index c4809e4..91dfac3 100644
--- a/test-apps/producer-app/src/main/java/s4app/ProducerPE.java
+++ b/test-apps/producer-app/src/main/java/s4app/ProducerPE.java
@@ -37,7 +37,7 @@ public class ProducerPE extends ProcessingElement {
/**
* @param targetStreams
- * the {@link UserEvent} streams.
+ * the {@link Streamable} streams.
*/
public void setStreams(Streamable... targetStreams) {
this.targetStreams = targetStreams;