http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/clusterers/ClustreamClustererAdapter.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/clusterers/ClustreamClustererAdapter.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/clusterers/ClustreamClustererAdapter.java index 829d448..bfc091a 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/clusterers/ClustreamClustererAdapter.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/clusterers/ClustreamClustererAdapter.java @@ -127,13 +127,12 @@ public class ClustreamClustererAdapter implements LocalClustererAdapter, Configu } /** - * Predicts the class memberships for a given instance. If an instance is - * unclassified, the returned array elements must be all zero. + * Predicts the class memberships for a given instance. If an instance is unclassified, the returned array elements + * must be all zero. * * @param inst * the instance to be classified - * @return an array containing the estimated membership probabilities of the - * test instance in each class + * @return an array containing the estimated membership probabilities of the test instance in each class */ @Override public double[] getVotesForInstance(Instance inst) { @@ -148,8 +147,7 @@ public class ClustreamClustererAdapter implements LocalClustererAdapter, Configu } /** - * Resets this classifier. It must be similar to starting a new classifier - * from scratch. + * Resets this classifier. It must be similar to starting a new classifier from scratch. * */ @Override
http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/clusterers/LocalClustererAdapter.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/clusterers/LocalClustererAdapter.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/clusterers/LocalClustererAdapter.java index 4e4cd6e..e9fad7c 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/clusterers/LocalClustererAdapter.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/learners/clusterers/LocalClustererAdapter.java @@ -40,19 +40,17 @@ public interface LocalClustererAdapter extends Serializable { LocalClustererAdapter create(); /** - * Predicts the class memberships for a given instance. If an instance is - * unclassified, the returned array elements must be all zero. + * Predicts the class memberships for a given instance. If an instance is unclassified, the returned array elements + * must be all zero. * * @param inst * the instance to be classified - * @return an array containing the estimated membership probabilities of the - * test instance in each class + * @return an array containing the estimated membership probabilities of the test instance in each class */ double[] getVotesForInstance(Instance inst); /** - * Resets this classifier. It must be similar to starting a new classifier - * from scratch. + * Resets this classifier. It must be similar to starting a new classifier from scratch. * */ void resetLearning(); http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/AbstractMOAObject.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/AbstractMOAObject.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/AbstractMOAObject.java index 45fa228..e89bb87 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/AbstractMOAObject.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/AbstractMOAObject.java @@ -25,8 +25,8 @@ import com.yahoo.labs.samoa.moa.core.SerializeUtils; //import moa.core.SizeOf; /** - * Abstract MOA Object. All classes that are serializable, copiable, can measure - * its size, and can give a description, extend this class. + * Abstract MOA Object. All classes that are serializable, copiable, can measure its size, and can give a description, + * extend this class. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/MOAObject.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/MOAObject.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/MOAObject.java index cd98892..8cc8d5c 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/MOAObject.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/MOAObject.java @@ -23,9 +23,8 @@ package com.yahoo.labs.samoa.moa; import java.io.Serializable; /** - * Interface implemented by classes in MOA, so that all are serializable, can - * produce copies of their objects, and can measure its memory size. They also - * give a string description. + * Interface implemented by classes in MOA, so that all are serializable, can produce copies of their objects, and can + * measure its memory size. They also give a string description. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ @@ -47,9 +46,8 @@ public interface MOAObject extends Serializable { public MOAObject copy(); /** - * Returns a string representation of this object. Used in - * <code>AbstractMOAObject.toString</code> to give a string representation of - * the object. + * Returns a string representation of this object. Used in <code>AbstractMOAObject.toString</code> to give a string + * representation of the object. * * @param sb * the stringbuilder to add the description http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/AbstractClassifier.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/AbstractClassifier.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/AbstractClassifier.java index 21bbf4b..b77bb6d 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/AbstractClassifier.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/AbstractClassifier.java @@ -61,8 +61,7 @@ public abstract class AbstractClassifier extends AbstractOptionHandler implement public Random classifierRandom; /** - * Creates an classifier and setups the random seed option if the classifier - * is randomizable. + * Creates an classifier and setups the random seed option if the classifier is randomizable. */ public AbstractClassifier() { if (isRandomizable()) { @@ -273,12 +272,10 @@ public abstract class AbstractClassifier extends AbstractOptionHandler implement * Rule 1: num classes can increase but never decrease<br> * Rule 2: num attributes can increase but never decrease<br> * Rule 3: num nominal attribute values can increase but never decrease<br> - * Rule 4: attribute types must stay in the same order (although class can - * move; is always skipped over)<br> + * Rule 4: attribute types must stay in the same order (although class can move; is always skipped over)<br> * <br> * - * Attribute names are free to change, but should always still represent the - * original attributes. + * Attribute names are free to change, but should always still represent the original attributes. * * @param originalContext * the first context to compare @@ -327,13 +324,11 @@ public abstract class AbstractClassifier extends AbstractOptionHandler implement } /** - * Resets this classifier. It must be similar to starting a new classifier - * from scratch. <br> + * Resets this classifier. It must be similar to starting a new classifier from scratch. <br> * <br> * - * The reason for ...Impl methods: ease programmer burden by not requiring - * them to remember calls to super in overridden methods. Note that this will - * produce compiler errors if not overridden. + * The reason for ...Impl methods: ease programmer burden by not requiring them to remember calls to super in + * overridden methods. Note that this will produce compiler errors if not overridden. */ public abstract void resetLearningImpl(); @@ -341,9 +336,8 @@ public abstract class AbstractClassifier extends AbstractOptionHandler implement * Trains this classifier incrementally using the given instance.<br> * <br> * - * The reason for ...Impl methods: ease programmer burden by not requiring - * them to remember calls to super in overridden methods. Note that this will - * produce compiler errors if not overridden. + * The reason for ...Impl methods: ease programmer burden by not requiring them to remember calls to super in + * overridden methods. Note that this will produce compiler errors if not overridden. * * @param inst * the instance to be used for training @@ -354,9 +348,8 @@ public abstract class AbstractClassifier extends AbstractOptionHandler implement * Gets the current measurements of this classifier.<br> * <br> * - * The reason for ...Impl methods: ease programmer burden by not requiring - * them to remember calls to super in overridden methods. Note that this will - * produce compiler errors if not overridden. + * The reason for ...Impl methods: ease programmer burden by not requiring them to remember calls to super in + * overridden methods. Note that this will produce compiler errors if not overridden. * * @return an array of measurements to be used in evaluation tasks */ @@ -373,8 +366,7 @@ public abstract class AbstractClassifier extends AbstractOptionHandler implement public abstract void getModelDescription(StringBuilder out, int indent); /** - * Gets the index of the attribute in the instance, given the index of the - * attribute in the learner. + * Gets the index of the attribute in the instance, given the index of the attribute in the learner. * * @param index * the index of the attribute in the learner http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/Classifier.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/Classifier.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/Classifier.java index bdda15a..dba0dbc 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/Classifier.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/Classifier.java @@ -33,8 +33,7 @@ import com.yahoo.labs.samoa.moa.learners.Learner; public interface Classifier extends Learner<Example<Instance>> { /** - * Gets the classifiers of this ensemble. Returns null if this learner is a - * single learner. + * Gets the classifiers of this ensemble. Returns null if this learner is a single learner. * * @return an array of the learners of the ensemble */ @@ -48,9 +47,8 @@ public interface Classifier extends Learner<Example<Instance>> { public Classifier copy(); /** - * Gets whether this classifier correctly classifies an instance. Uses - * getVotesForInstance to obtain the prediction and the instance to obtain its - * true class. + * Gets whether this classifier correctly classifies an instance. Uses getVotesForInstance to obtain the prediction + * and the instance to obtain its true class. * * * @param inst @@ -68,13 +66,12 @@ public interface Classifier extends Learner<Example<Instance>> { public void trainOnInstance(Instance inst); /** - * Predicts the class memberships for a given instance. If an instance is - * unclassified, the returned array elements must be all zero. + * Predicts the class memberships for a given instance. If an instance is unclassified, the returned array elements + * must be all zero. * * @param inst * the instance to be classified - * @return an array containing the estimated membership probabilities of the - * test instance in each class + * @return an array containing the estimated membership probabilities of the test instance in each class */ public double[] getVotesForInstance(Instance inst); } http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/Regressor.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/Regressor.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/Regressor.java index 53d86a2..8e90d18 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/Regressor.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/Regressor.java @@ -21,8 +21,7 @@ package com.yahoo.labs.samoa.moa.classifiers; */ /** - * Regressor interface for incremental regression models. It is used only in the - * GUI Regression Tab. + * Regressor interface for incremental regression models. It is used only in the GUI Regression Tab. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/AttributeClassObserver.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/AttributeClassObserver.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/AttributeClassObserver.java index a6cdf80..f4a68b4 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/AttributeClassObserver.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/AttributeClassObserver.java @@ -25,9 +25,8 @@ import com.yahoo.labs.samoa.moa.classifiers.core.splitcriteria.SplitCriterion; import com.yahoo.labs.samoa.moa.options.OptionHandler; /** - * Interface for observing the class data distribution for an attribute. This - * observer monitors the class distribution of a given attribute. Used in naive - * Bayes and decision trees to monitor data statistics on leaves. + * Interface for observing the class data distribution for an attribute. This observer monitors the class distribution + * of a given attribute. Used in naive Bayes and decision trees to monitor data statistics on leaves. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ @@ -35,8 +34,7 @@ import com.yahoo.labs.samoa.moa.options.OptionHandler; public interface AttributeClassObserver extends OptionHandler { /** - * Updates statistics of this observer given an attribute value, a class and - * the weight of the instance observed + * Updates statistics of this observer given an attribute value, a class and the weight of the instance observed * * @param attVal * the value of the attribute http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/BinaryTreeNumericAttributeClassObserver.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/BinaryTreeNumericAttributeClassObserver.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/BinaryTreeNumericAttributeClassObserver.java index 2b45209..af763ef 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/BinaryTreeNumericAttributeClassObserver.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/BinaryTreeNumericAttributeClassObserver.java @@ -30,10 +30,9 @@ import com.yahoo.labs.samoa.moa.options.AbstractOptionHandler; import com.yahoo.labs.samoa.moa.tasks.TaskMonitor; /** - * Class for observing the class data distribution for a numeric attribute using - * a binary tree. This observer monitors the class distribution of a given - * attribute. Used in naive Bayes and decision trees to monitor data statistics - * on leaves. + * Class for observing the class data distribution for a numeric attribute using a binary tree. This observer monitors + * the class distribution of a given attribute. Used in naive Bayes and decision trees to monitor data statistics on + * leaves. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/BinaryTreeNumericAttributeClassObserverRegression.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/BinaryTreeNumericAttributeClassObserverRegression.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/BinaryTreeNumericAttributeClassObserverRegression.java index eeffebd..c05b76e 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/BinaryTreeNumericAttributeClassObserverRegression.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/BinaryTreeNumericAttributeClassObserverRegression.java @@ -28,13 +28,12 @@ import com.yahoo.labs.samoa.moa.options.AbstractOptionHandler; import com.yahoo.labs.samoa.moa.tasks.TaskMonitor; /** - * Class for observing the class data distribution for a numeric attribute using - * a binary tree. This observer monitors the class distribution of a given - * attribute. + * Class for observing the class data distribution for a numeric attribute using a binary tree. This observer monitors + * the class distribution of a given attribute. * * <p> - * Learning Adaptive Model Rules from High-Speed Data Streams, ECML 2013, E. - * Almeida, C. Ferreira, P. Kosina and J. Gama; + * Learning Adaptive Model Rules from High-Speed Data Streams, ECML 2013, E. Almeida, C. Ferreira, P. Kosina and J. + * Gama; * </p> * * @author E. Almeida, J. Gama http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/DiscreteAttributeClassObserver.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/DiscreteAttributeClassObserver.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/DiscreteAttributeClassObserver.java index fe16447..3253216 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/DiscreteAttributeClassObserver.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/DiscreteAttributeClassObserver.java @@ -21,10 +21,8 @@ package com.yahoo.labs.samoa.moa.classifiers.core.attributeclassobservers; */ /** - * Interface for observing the class data distribution for a discrete (nominal) - * attribute. This observer monitors the class distribution of a given - * attribute. Used in naive Bayes and decision trees to monitor data statistics - * on leaves. + * Interface for observing the class data distribution for a discrete (nominal) attribute. This observer monitors the + * class distribution of a given attribute. Used in naive Bayes and decision trees to monitor data statistics on leaves. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/FIMTDDNumericAttributeClassObserver.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/FIMTDDNumericAttributeClassObserver.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/FIMTDDNumericAttributeClassObserver.java index dac0b7d..e256e84 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/FIMTDDNumericAttributeClassObserver.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/FIMTDDNumericAttributeClassObserver.java @@ -62,8 +62,7 @@ public class FIMTDDNumericAttributeClassObserver extends BinaryTreeNumericAttrib } /** - * Insert a new value into the tree, updating both the sum of values and sum - * of squared values arrays + * Insert a new value into the tree, updating both the sum of values and sum of squared values arrays */ public void insertValue(double val, double label, double weight) { @@ -192,16 +191,14 @@ public class FIMTDDNumericAttributeClassObserver extends BinaryTreeNumericAttrib } /** - * A method to remove all nodes in the E-BST in which it and all it's children - * represent 'bad' split points + * A method to remove all nodes in the E-BST in which it and all it's children represent 'bad' split points */ public void removeBadSplits(SplitCriterion criterion, double lastCheckRatio, double lastCheckSDR, double lastCheckE) { removeBadSplitNodes(criterion, this.root, lastCheckRatio, lastCheckSDR, lastCheckE); } /** - * Recursive method that first checks all of a node's children before deciding - * if it is 'bad' and may be removed + * Recursive method that first checks all of a node's children before deciding if it is 'bad' and may be removed */ private boolean removeBadSplitNodes(SplitCriterion criterion, Node currentNode, double lastCheckRatio, double lastCheckSDR, double lastCheckE) { http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/GaussianNumericAttributeClassObserver.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/GaussianNumericAttributeClassObserver.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/GaussianNumericAttributeClassObserver.java index 107fa29..7491270 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/GaussianNumericAttributeClassObserver.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/GaussianNumericAttributeClassObserver.java @@ -37,10 +37,9 @@ import com.yahoo.labs.samoa.moa.options.AbstractOptionHandler; import com.github.javacliparser.IntOption; /** - * Class for observing the class data distribution for a numeric attribute using - * gaussian estimators. This observer monitors the class distribution of a given - * attribute. Used in naive Bayes and decision trees to monitor data statistics - * on leaves. + * Class for observing the class data distribution for a numeric attribute using gaussian estimators. This observer + * monitors the class distribution of a given attribute. Used in naive Bayes and decision trees to monitor data + * statistics on leaves. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/GreenwaldKhannaNumericAttributeClassObserver.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/GreenwaldKhannaNumericAttributeClassObserver.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/GreenwaldKhannaNumericAttributeClassObserver.java index 9aaf0b8..dbc6285 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/GreenwaldKhannaNumericAttributeClassObserver.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/GreenwaldKhannaNumericAttributeClassObserver.java @@ -34,10 +34,9 @@ import com.github.javacliparser.IntOption; import com.yahoo.labs.samoa.moa.tasks.TaskMonitor; /** - * Class for observing the class data distribution for a numeric attribute using - * Greenwald and Khanna methodology. This observer monitors the class - * distribution of a given attribute. Used in naive Bayes and decision trees to - * monitor data statistics on leaves. + * Class for observing the class data distribution for a numeric attribute using Greenwald and Khanna methodology. This + * observer monitors the class distribution of a given attribute. Used in naive Bayes and decision trees to monitor data + * statistics on leaves. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NominalAttributeClassObserver.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NominalAttributeClassObserver.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NominalAttributeClassObserver.java index 7b34fa4..d62fcce 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NominalAttributeClassObserver.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NominalAttributeClassObserver.java @@ -33,9 +33,8 @@ import com.yahoo.labs.samoa.moa.core.DoubleVector; import com.yahoo.labs.samoa.moa.options.AbstractOptionHandler; /** - * Class for observing the class data distribution for a nominal attribute. This - * observer monitors the class distribution of a given attribute. Used in naive - * Bayes and decision trees to monitor data statistics on leaves. + * Class for observing the class data distribution for a nominal attribute. This observer monitors the class + * distribution of a given attribute. Used in naive Bayes and decision trees to monitor data statistics on leaves. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NullAttributeClassObserver.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NullAttributeClassObserver.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NullAttributeClassObserver.java index ab14d97..ed62596 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NullAttributeClassObserver.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NullAttributeClassObserver.java @@ -27,9 +27,8 @@ import com.yahoo.labs.samoa.moa.options.AbstractOptionHandler; import com.yahoo.labs.samoa.moa.tasks.TaskMonitor; /** - * Class for observing the class data distribution for a null attribute. This - * method is used to disable the observation for an attribute. Used in decision - * trees to monitor data statistics on leaves. + * Class for observing the class data distribution for a null attribute. This method is used to disable the observation + * for an attribute. Used in decision trees to monitor data statistics on leaves. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NumericAttributeClassObserver.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NumericAttributeClassObserver.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NumericAttributeClassObserver.java index ca7a50a..914cc63 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NumericAttributeClassObserver.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/NumericAttributeClassObserver.java @@ -21,9 +21,8 @@ package com.yahoo.labs.samoa.moa.classifiers.core.attributeclassobservers; */ /** - * Interface for observing the class data distribution for a numeric attribute. - * This observer monitors the class distribution of a given attribute. Used in - * naive Bayes and decision trees to monitor data statistics on leaves. + * Interface for observing the class data distribution for a numeric attribute. This observer monitors the class + * distribution of a given attribute. Used in naive Bayes and decision trees to monitor data statistics on leaves. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/VFMLNumericAttributeClassObserver.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/VFMLNumericAttributeClassObserver.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/VFMLNumericAttributeClassObserver.java index 9650532..d79f38d 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/VFMLNumericAttributeClassObserver.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/attributeclassobservers/VFMLNumericAttributeClassObserver.java @@ -36,9 +36,8 @@ import com.github.javacliparser.IntOption; import com.yahoo.labs.samoa.moa.tasks.TaskMonitor; /** - * Class for observing the class data distribution for a numeric attribute as in - * VFML. Used in naive Bayes and decision trees to monitor data statistics on - * leaves. + * Class for observing the class data distribution for a numeric attribute as in VFML. Used in naive Bayes and decision + * trees to monitor data statistics on leaves. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/InstanceConditionalBinaryTest.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/InstanceConditionalBinaryTest.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/InstanceConditionalBinaryTest.java index b273c33..9f60be2 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/InstanceConditionalBinaryTest.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/InstanceConditionalBinaryTest.java @@ -21,8 +21,7 @@ package com.yahoo.labs.samoa.moa.classifiers.core.conditionaltests; */ /** - * Abstract binary conditional test for instances to use to split nodes in - * Hoeffding trees. + * Abstract binary conditional test for instances to use to split nodes in Hoeffding trees. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/InstanceConditionalTest.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/InstanceConditionalTest.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/InstanceConditionalTest.java index b893e06..0d4453a 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/InstanceConditionalTest.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/InstanceConditionalTest.java @@ -25,8 +25,7 @@ import com.yahoo.labs.samoa.instances.InstancesHeader; import com.yahoo.labs.samoa.instances.Instance; /** - * Abstract conditional test for instances to use to split nodes in Hoeffding - * trees. + * Abstract conditional test for instances to use to split nodes in Hoeffding trees. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ @@ -60,8 +59,7 @@ public abstract class InstanceConditionalTest extends AbstractMOAObject { public abstract int maxBranches(); /** - * Gets the text that describes the condition of a branch. It is used to - * describe the branch. + * Gets the text that describes the condition of a branch. It is used to describe the branch. * * @param branch * the number of the branch to describe http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NominalAttributeBinaryTest.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NominalAttributeBinaryTest.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NominalAttributeBinaryTest.java index 5056737..a6205bf 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NominalAttributeBinaryTest.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NominalAttributeBinaryTest.java @@ -24,8 +24,7 @@ import com.yahoo.labs.samoa.instances.InstancesHeader; import com.yahoo.labs.samoa.instances.Instance; /** - * Nominal binary conditional test for instances to use to split nodes in - * Hoeffding trees. + * Nominal binary conditional test for instances to use to split nodes in Hoeffding trees. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NominalAttributeMultiwayTest.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NominalAttributeMultiwayTest.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NominalAttributeMultiwayTest.java index 5c64070..f264b73 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NominalAttributeMultiwayTest.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NominalAttributeMultiwayTest.java @@ -24,8 +24,7 @@ import com.yahoo.labs.samoa.instances.InstancesHeader; import com.yahoo.labs.samoa.instances.Instance; /** - * Nominal multi way conditional test for instances to use to split nodes in - * Hoeffding trees. + * Nominal multi way conditional test for instances to use to split nodes in Hoeffding trees. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NumericAttributeBinaryTest.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NumericAttributeBinaryTest.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NumericAttributeBinaryTest.java index 0a05742..0f6ae24 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NumericAttributeBinaryTest.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/conditionaltests/NumericAttributeBinaryTest.java @@ -24,8 +24,7 @@ import com.yahoo.labs.samoa.instances.InstancesHeader; import com.yahoo.labs.samoa.instances.Instance; /** - * Numeric binary conditional test for instances to use to split nodes in - * Hoeffding trees. + * Numeric binary conditional test for instances to use to split nodes in Hoeffding trees. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ADWIN.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ADWIN.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ADWIN.java index efacc93..5a52cf8 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ADWIN.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ADWIN.java @@ -23,11 +23,9 @@ package com.yahoo.labs.samoa.moa.classifiers.core.driftdetection; import com.yahoo.labs.samoa.moa.AbstractMOAObject; /** - * ADaptive sliding WINdow method. This method is a change detector and - * estimator. It keeps a variable-length window of recently seen items, with the - * property that the window has the maximal length statistically consistent with - * the hypothesis "there has been no change in the average value inside the - * window". + * ADaptive sliding WINdow method. This method is a change detector and estimator. It keeps a variable-length window of + * recently seen items, with the property that the window has the maximal length statistically consistent with the + * hypothesis "there has been no change in the average value inside the window". * * * @author Albert Bifet (abifet at cs dot waikato dot ac dot nz) http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ADWINChangeDetector.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ADWINChangeDetector.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ADWINChangeDetector.java index 4e7b3dc..a715517 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ADWINChangeDetector.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ADWINChangeDetector.java @@ -25,11 +25,9 @@ import com.yahoo.labs.samoa.moa.core.ObjectRepository; import com.yahoo.labs.samoa.moa.tasks.TaskMonitor; /** - * Drift detection method based in ADWIN. ADaptive sliding WINdow is a change - * detector and estimator. It keeps a variable-length window of recently seen - * items, with the property that the window has the maximal length statistically - * consistent with the hypothesis "there has been no change in the average value - * inside the window". + * Drift detection method based in ADWIN. ADaptive sliding WINdow is a change detector and estimator. It keeps a + * variable-length window of recently seen items, with the property that the window has the maximal length statistically + * consistent with the hypothesis "there has been no change in the average value inside the window". * * * @author Albert Bifet (abifet at cs dot waikato dot ac dot nz) http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/AbstractChangeDetector.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/AbstractChangeDetector.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/AbstractChangeDetector.java index a06707c..ba0e9f9 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/AbstractChangeDetector.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/AbstractChangeDetector.java @@ -52,8 +52,7 @@ public abstract class AbstractChangeDetector extends AbstractOptionHandler protected double delay; /** - * Resets this change detector. It must be similar to starting a new change - * detector from scratch. + * Resets this change detector. It must be similar to starting a new change detector from scratch. * */ public void resetLearning() { @@ -67,8 +66,7 @@ public abstract class AbstractChangeDetector extends AbstractOptionHandler * Adding a numeric value to the change detector<br> * <br> * - * The output of the change detector is modified after the insertion of a new - * item inside. + * The output of the change detector is modified after the insertion of a new item inside. * * @param inputValue * the number to insert into the change detector @@ -85,8 +83,7 @@ public abstract class AbstractChangeDetector extends AbstractOptionHandler } /** - * Gets whether the change detector is in the warning zone, after a warning - * alert and before a change alert. + * Gets whether the change detector is in the warning zone, after a warning alert and before a change alert. * * @return true if the change detector is in the warning zone */ @@ -115,8 +112,7 @@ public abstract class AbstractChangeDetector extends AbstractOptionHandler /** * Gets the output state of the change detection. * - * @return an array with the number of change detections, number of warnings, - * delay, and estimation. + * @return an array with the number of change detections, number of warnings, delay, and estimation. */ public double[] getOutput() { return new double[] { this.isChangeDetected ? 1 : 0, this.isWarningZone ? 1 : 0, this.delay, this.estimation }; http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ChangeDetector.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ChangeDetector.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ChangeDetector.java index d2bae2b..1f58ea0 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ChangeDetector.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/ChangeDetector.java @@ -31,8 +31,7 @@ import com.yahoo.labs.samoa.moa.options.OptionHandler; public interface ChangeDetector extends OptionHandler { /** - * Resets this change detector. It must be similar to starting a new change - * detector from scratch. + * Resets this change detector. It must be similar to starting a new change detector from scratch. * */ public void resetLearning(); @@ -41,8 +40,7 @@ public interface ChangeDetector extends OptionHandler { * Adding a numeric value to the change detector<br> * <br> * - * The output of the change detector is modified after the insertion of a new - * item inside. + * The output of the change detector is modified after the insertion of a new item inside. * * @param inputValue * the number to insert into the change detector @@ -57,8 +55,7 @@ public interface ChangeDetector extends OptionHandler { public boolean getChange(); /** - * Gets whether the change detector is in the warning zone, after a warning - * alert and before a change alert. + * Gets whether the change detector is in the warning zone, after a warning alert and before a change alert. * * @return true if the change detector is in the warning zone */ @@ -81,8 +78,7 @@ public interface ChangeDetector extends OptionHandler { /** * Gets the output state of the change detection. * - * @return an array with the number of change detections, number of warnings, - * delay, and estimation. + * @return an array with the number of change detections, number of warnings, delay, and estimation. */ public double[] getOutput(); http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/DDM.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/DDM.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/DDM.java index 1bf2cdd..bfbab0e 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/DDM.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/DDM.java @@ -28,8 +28,7 @@ import com.yahoo.labs.samoa.moa.tasks.TaskMonitor; * Drift detection method based in DDM method of Joao Gama SBIA 2004. * * <p> - * João Gama, Pedro Medas, Gladys Castillo, Pedro Pereira Rodrigues: Learning - * with Drift Detection. SBIA 2004: 286-295 + * João Gama, Pedro Medas, Gladys Castillo, Pedro Pereira Rodrigues: Learning with Drift Detection. SBIA 2004: 286-295 * </p> * * @author Manuel Baena ([email protected]) http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/EDDM.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/EDDM.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/EDDM.java index b845120..dd41bab 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/EDDM.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/EDDM.java @@ -27,9 +27,8 @@ import com.yahoo.labs.samoa.moa.tasks.TaskMonitor; * Drift detection method based in EDDM method of Manuel Baena et al. * * <p> - * Early Drift Detection Method. Manuel Baena-Garcia, Jose Del Campo-Avila, Raúl - * Fidalgo, Albert Bifet, Ricard Gavalda, Rafael Morales-Bueno. In Fourth - * International Workshop on Knowledge Discovery from Data Streams, 2006. + * Early Drift Detection Method. Manuel Baena-Garcia, Jose Del Campo-Avila, Raúl Fidalgo, Albert Bifet, Ricard Gavalda, + * Rafael Morales-Bueno. In Fourth International Workshop on Knowledge Discovery from Data Streams, 2006. * </p> * * @author Manuel Baena ([email protected]) http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/EWMAChartDM.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/EWMAChartDM.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/EWMAChartDM.java index 6394259..b838e7d 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/EWMAChartDM.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/driftdetection/EWMAChartDM.java @@ -26,8 +26,7 @@ import com.yahoo.labs.samoa.moa.core.ObjectRepository; import com.yahoo.labs.samoa.moa.tasks.TaskMonitor; /** - * Drift detection method based in EWMA Charts of Ross, Adams, Tasoulis and Hand - * 2012 + * Drift detection method based in EWMA Charts of Ross, Adams, Tasoulis and Hand 2012 * * * @author Manuel Baena ([email protected]) http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/GiniSplitCriterion.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/GiniSplitCriterion.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/GiniSplitCriterion.java index b5135ea..61cc021 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/GiniSplitCriterion.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/GiniSplitCriterion.java @@ -26,9 +26,8 @@ import com.yahoo.labs.samoa.moa.options.AbstractOptionHandler; import com.yahoo.labs.samoa.moa.tasks.TaskMonitor; /** - * Class for computing splitting criteria using Gini with respect to - * distributions of class values. The split criterion is used as a parameter on - * decision trees and decision stumps. + * Class for computing splitting criteria using Gini with respect to distributions of class values. The split criterion + * is used as a parameter on decision trees and decision stumps. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/InfoGainSplitCriterion.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/InfoGainSplitCriterion.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/InfoGainSplitCriterion.java index bcf3c31..ac8da2f 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/InfoGainSplitCriterion.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/InfoGainSplitCriterion.java @@ -27,9 +27,8 @@ import com.yahoo.labs.samoa.moa.options.AbstractOptionHandler; import com.yahoo.labs.samoa.moa.tasks.TaskMonitor; /** - * Class for computing splitting criteria using information gain with respect to - * distributions of class values. The split criterion is used as a parameter on - * decision trees and decision stumps. + * Class for computing splitting criteria using information gain with respect to distributions of class values. The + * split criterion is used as a parameter on decision trees and decision stumps. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/InfoGainSplitCriterionMultilabel.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/InfoGainSplitCriterionMultilabel.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/InfoGainSplitCriterionMultilabel.java index c06754a..814fd5f 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/InfoGainSplitCriterionMultilabel.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/InfoGainSplitCriterionMultilabel.java @@ -23,9 +23,8 @@ package com.yahoo.labs.samoa.moa.classifiers.core.splitcriteria; import com.yahoo.labs.samoa.moa.core.Utils; /** - * Class for computing splitting criteria using information gain with respect to - * distributions of class values for Multilabel data. The split criterion is - * used as a parameter on decision trees and decision stumps. + * Class for computing splitting criteria using information gain with respect to distributions of class values for + * Multilabel data. The split criterion is used as a parameter on decision trees and decision stumps. * * @author Richard Kirkby ([email protected]) * @author Jesse Read ([email protected]) http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/SplitCriterion.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/SplitCriterion.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/SplitCriterion.java index ce5d661..77ebafa 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/SplitCriterion.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/core/splitcriteria/SplitCriterion.java @@ -23,10 +23,9 @@ package com.yahoo.labs.samoa.moa.classifiers.core.splitcriteria; import com.yahoo.labs.samoa.moa.options.OptionHandler; /** - * Interface for computing splitting criteria. with respect to distributions of - * class values. The split criterion is used as a parameter on decision trees - * and decision stumps. The two split criteria most used are Information Gain - * and Gini. + * Interface for computing splitting criteria. with respect to distributions of class values. The split criterion is + * used as a parameter on decision trees and decision stumps. The two split criteria most used are Information Gain and + * Gini. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ @@ -34,8 +33,7 @@ import com.yahoo.labs.samoa.moa.options.OptionHandler; public interface SplitCriterion extends OptionHandler { /** - * Computes the merit of splitting for a given ditribution before the split - * and after it. + * Computes the merit of splitting for a given ditribution before the split and after it. * * @param preSplitDist * the class distribution before the split http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/attributeclassobservers/FIMTDDNumericAttributeClassLimitObserver.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/attributeclassobservers/FIMTDDNumericAttributeClassLimitObserver.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/attributeclassobservers/FIMTDDNumericAttributeClassLimitObserver.java index 6633da8..fed3398 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/attributeclassobservers/FIMTDDNumericAttributeClassLimitObserver.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/attributeclassobservers/FIMTDDNumericAttributeClassLimitObserver.java @@ -70,8 +70,7 @@ public class FIMTDDNumericAttributeClassLimitObserver extends FIMTDDNumericAttri protected Node root = null; /** - * Insert a new value into the tree, updating both the sum of values and sum - * of squared values arrays + * Insert a new value into the tree, updating both the sum of values and sum of squared values arrays */ @Override public void insertValue(double val, double label, double weight) { http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/conditionaltests/NumericAttributeBinaryRulePredicate.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/conditionaltests/NumericAttributeBinaryRulePredicate.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/conditionaltests/NumericAttributeBinaryRulePredicate.java index 94edc33..d84b0a8 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/conditionaltests/NumericAttributeBinaryRulePredicate.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/conditionaltests/NumericAttributeBinaryRulePredicate.java @@ -45,8 +45,7 @@ import com.yahoo.labs.samoa.moa.classifiers.core.conditionaltests.InstanceCondit import com.yahoo.labs.samoa.moa.classifiers.rules.core.Predicate; /** - * Numeric binary conditional test for instances to use to split nodes in - * AMRules. + * Numeric binary conditional test for instances to use to split nodes in AMRules. * * @version $Revision: 1 $ */ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/AbstractErrorWeightedVote.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/AbstractErrorWeightedVote.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/AbstractErrorWeightedVote.java index dcd975d..a80e258 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/AbstractErrorWeightedVote.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/AbstractErrorWeightedVote.java @@ -26,8 +26,7 @@ import java.util.List; import com.yahoo.labs.samoa.moa.AbstractMOAObject; /** - * AbstractErrorWeightedVote class for weighted votes based on estimates of - * errors. + * AbstractErrorWeightedVote class for weighted votes based on estimates of errors. * * @author Joao Duarte ([email protected]) * @version $Revision: 1 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/ErrorWeightedVote.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/ErrorWeightedVote.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/ErrorWeightedVote.java index fca7115..21d2d3e 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/ErrorWeightedVote.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/ErrorWeightedVote.java @@ -31,8 +31,7 @@ import com.yahoo.labs.samoa.moa.MOAObject; public interface ErrorWeightedVote { /** - * Adds a vote and the corresponding error for the computation of the weighted - * vote and respective weighted error. + * Adds a vote and the corresponding error for the computation of the weighted vote and respective weighted error. * * @param vote * a vote returned by a classifier http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/InverseErrorWeightedVote.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/InverseErrorWeightedVote.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/InverseErrorWeightedVote.java index 2e2cb56..8ed0799 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/InverseErrorWeightedVote.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/classifiers/rules/core/voting/InverseErrorWeightedVote.java @@ -21,8 +21,7 @@ package com.yahoo.labs.samoa.moa.classifiers.rules.core.voting; */ /** - * InverseErrorWeightedVote class for weighted votes based on estimates of - * errors. + * InverseErrorWeightedVote class for weighted votes based on estimates of errors. * * @author Joao Duarte ([email protected]) * @version $Revision: 1 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/CFCluster.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/CFCluster.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/CFCluster.java index b8f22c3..3eee093 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/CFCluster.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/CFCluster.java @@ -156,8 +156,7 @@ public abstract class CFCluster extends SphereCluster { } /** - * Adds the second array to the first array element by element. The arrays - * must have the same length. + * Adds the second array to the first array element by element. The arrays must have the same length. * * @param a1 * Vector to which the second vector is added. http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/Cluster.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/Cluster.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/Cluster.java index 82cdb3b..60aef8c 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/Cluster.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/Cluster.java @@ -47,8 +47,8 @@ public abstract class Cluster extends AbstractMOAObject { public abstract double[] getCenter(); /** - * Returns the weight of this cluster, not neccessarily normalized. It could, - * for instance, simply return the number of points contined in this cluster. + * Returns the weight of this cluster, not neccessarily normalized. It could, for instance, simply return the number + * of points contined in this cluster. * * @return the weight */ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/SphereCluster.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/SphereCluster.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/SphereCluster.java index 4a5cc97..c2a6c24 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/SphereCluster.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/cluster/SphereCluster.java @@ -26,9 +26,8 @@ import java.util.List; import java.util.Random; /** - * A simple implementation of the <code>Cluster</code> interface representing - * spherical clusters. The inclusion probability is one inside the sphere and - * zero everywhere else. + * A simple implementation of the <code>Cluster</code> interface representing spherical clusters. The inclusion + * probability is one inside the sphere and zero everywhere else. * */ public class SphereCluster extends Cluster { @@ -87,9 +86,8 @@ public class SphereCluster extends Cluster { } /** - * Checks whether two <code>SphereCluster</code> overlap based on radius NOTE: - * overlapRadiusDegree only calculates the overlap based on the centers and - * the radi, so not the real overlap + * Checks whether two <code>SphereCluster</code> overlap based on radius NOTE: overlapRadiusDegree only calculates the + * overlap based on the centers and the radi, so not the real overlap * * TODO: should we do this by MC to get the real overlap??? * @@ -266,14 +264,12 @@ public class SphereCluster extends Cluster { } /* - */ + */ /** - * When a clusters looses points the new minimal bounding sphere can be partly - * outside of the originating cluster. If a another cluster is right next to - * the original cluster (without overlapping), the new cluster can be - * overlapping with this second cluster. OverlapSave will tell you if the - * current cluster can degenerate so much that it overlaps with cluster - * 'other' + * When a clusters looses points the new minimal bounding sphere can be partly outside of the originating cluster. If + * a another cluster is right next to the original cluster (without overlapping), the new cluster can be overlapping + * with this second cluster. OverlapSave will tell you if the current cluster can degenerate so much that it overlaps + * with cluster 'other' * * @param other * the potentially overlapping cluster http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/KMeans.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/KMeans.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/KMeans.java index aa98307..0b6c063 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/KMeans.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/KMeans.java @@ -28,21 +28,19 @@ import com.yahoo.labs.samoa.moa.cluster.Clustering; import com.yahoo.labs.samoa.moa.cluster.SphereCluster; /** - * A kMeans implementation for microclusterings. For now it only uses the real - * centers of the groundtruthclustering for implementation. There should also be - * an option to use random centers. TODO: random centers TODO: Create a macro - * clustering interface to make different macro clustering algorithms available - * to micro clustering algorithms like clustream, denstream and clustree + * A kMeans implementation for microclusterings. For now it only uses the real centers of the groundtruthclustering for + * implementation. There should also be an option to use random centers. TODO: random centers TODO: Create a macro + * clustering interface to make different macro clustering algorithms available to micro clustering algorithms like + * clustream, denstream and clustree * */ public class KMeans { /** - * This kMeans implementation clusters a big number of microclusters into a - * smaller amount of macro clusters. To make it comparable to other algorithms - * it uses the real centers of the ground truth macro clustering to have the - * best possible initialization. The quality of resulting macro clustering - * yields an upper bound for kMeans on the underlying microclustering. + * This kMeans implementation clusters a big number of microclusters into a smaller amount of macro clusters. To make + * it comparable to other algorithms it uses the real centers of the ground truth macro clustering to have the best + * possible initialization. The quality of resulting macro clustering yields an upper bound for kMeans on the + * underlying microclustering. * * @param centers * of the ground truth clustering http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/Clustream.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/Clustream.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/Clustream.java index c329e5b..101d297 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/Clustream.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/Clustream.java @@ -34,8 +34,8 @@ import com.yahoo.labs.samoa.instances.DenseInstance; import com.yahoo.labs.samoa.instances.Instance; /** - * Citation: CluStream: Charu C. Aggarwal, Jiawei Han, Jianyong Wang, Philip S. - * Yu: A Framework for Clustering Evolving Data Streams. VLDB 2003: 81-92 + * Citation: CluStream: Charu C. Aggarwal, Jiawei Han, Jianyong Wang, Philip S. Yu: A Framework for Clustering Evolving + * Data Streams. VLDB 2003: 81-92 */ public class Clustream extends AbstractClusterer { http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/ClustreamKernel.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/ClustreamKernel.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/ClustreamKernel.java index d5123d2..fcbe776 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/ClustreamKernel.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/ClustreamKernel.java @@ -194,16 +194,14 @@ public class ClustreamKernel extends CFCluster { /** * Check if this cluster is empty or not. * - * @return <code>true</code> if the cluster has no data points, - * <code>false</code> otherwise. + * @return <code>true</code> if the cluster has no data points, <code>false</code> otherwise. */ public boolean isEmpty() { return this.N == 0; } /** - * Calculate the normalized euclidean distance (Mahalanobis distance for - * distribution w/o covariances) to a point. + * Calculate the normalized euclidean distance (Mahalanobis distance for distribution w/o covariances) to a point. * * @param point * The point to which the distance is calculated. http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/WithKmeans.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/WithKmeans.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/WithKmeans.java index 08cf936..ef8fed8 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/WithKmeans.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/clusterers/clustream/WithKmeans.java @@ -214,8 +214,7 @@ public class WithKmeans extends AbstractClusterer { } /** - * k-means of (micro)clusters, with ground-truth-aided initialization. (to - * produce best results) + * k-means of (micro)clusters, with ground-truth-aided initialization. (to produce best results) * * @param k * @param data @@ -288,8 +287,7 @@ public class WithKmeans extends AbstractClusterer { } /** - * (The Actual Algorithm) k-means of (micro)clusters, with specified - * initialization points. + * (The Actual Algorithm) k-means of (micro)clusters, with specified initialization points. * * @param k * @param centers @@ -351,8 +349,7 @@ public class WithKmeans extends AbstractClusterer { } /** - * Rearrange the k-means result into a set of CFClusters, cleaning up the - * redundancies. + * Rearrange the k-means result into a set of CFClusters, cleaning up the redundancies. * * @param kMeansResult * @param microclusters @@ -401,8 +398,7 @@ public class WithKmeans extends AbstractClusterer { } /** - * k-means helper: Calculate a wrapping cluster of assigned - * points[microclusters]. + * k-means helper: Calculate a wrapping cluster of assigned points[microclusters]. * * @param assigned * @param dimensions http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/FastVector.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/FastVector.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/FastVector.java index fb03c40..1c14f28 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/FastVector.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/FastVector.java @@ -36,8 +36,7 @@ import java.util.ArrayList; public class FastVector<E> extends ArrayList<E> { /** - * Adds an element to this vector. Increases its capacity if its not large - * enough. + * Adds an element to this vector. Increases its capacity if its not large enough. * * @param element * the element to add http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/GaussianEstimator.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/GaussianEstimator.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/GaussianEstimator.java index 6677bf0..74f254c 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/GaussianEstimator.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/GaussianEstimator.java @@ -23,10 +23,8 @@ package com.yahoo.labs.samoa.moa.core; import com.yahoo.labs.samoa.moa.AbstractMOAObject; /** - * Gaussian incremental estimator that uses incremental method that is more - * resistant to floating point imprecision. for more info see Donald Knuth's - * "The Art of Computer Programming, Volume 2: Seminumerical Algorithms", - * section 4.2.2. + * Gaussian incremental estimator that uses incremental method that is more resistant to floating point imprecision. for + * more info see Donald Knuth's "The Art of Computer Programming, Volume 2: Seminumerical Algorithms", section 4.2.2. * * @author Richard Kirkby ([email protected]) * @version $Revision: 7 $ http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/MiscUtils.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/MiscUtils.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/MiscUtils.java index c176369..0f1ec7c 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/MiscUtils.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/MiscUtils.java @@ -73,8 +73,7 @@ public class MiscUtils { } /** - * Returns index of maximum element in a given array of doubles. First maximum - * is returned. + * Returns index of maximum element in a given array of doubles. First maximum is returned. * * @param doubles * the array of doubles http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/5543ecd3/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/Statistics.java ---------------------------------------------------------------------- diff --git a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/Statistics.java b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/Statistics.java index c270de9..9179bc0 100644 --- a/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/Statistics.java +++ b/samoa-api/src/main/java/com/yahoo/labs/samoa/moa/core/Statistics.java @@ -129,9 +129,8 @@ public class Statistics { } /** - * Returns chi-squared probability for given value and degrees of freedom. - * (The probability that the chi-squared variate will be greater than x for - * the given degrees of freedom.) + * Returns chi-squared probability for given value and degrees of freedom. (The probability that the chi-squared + * variate will be greater than x for the given degrees of freedom.) * * @param x * the value @@ -163,9 +162,8 @@ public class Statistics { } /** - * Returns the area under the Normal (Gaussian) probability density function, - * integrated from minus infinity to <tt>x</tt> (assumes mean is zero, - * variance is one). + * Returns the area under the Normal (Gaussian) probability density function, integrated from minus infinity to + * <tt>x</tt> (assumes mean is zero, variance is one). * * <pre> * x @@ -180,8 +178,8 @@ public class Statistics { * = erfc(z) / 2 * </pre> * - * where <tt>z = x/sqrt(2)</tt>. Computation is via the functions - * <tt>errorFunction</tt> and <tt>errorFunctionComplement</tt>. + * where <tt>z = x/sqrt(2)</tt>. Computation is via the functions <tt>errorFunction</tt> and + * <tt>errorFunctionComplement</tt>. * * @param a * the z-value @@ -205,16 +203,13 @@ public class Statistics { } /** - * Returns the value, <tt>x</tt>, for which the area under the Normal - * (Gaussian) probability density function (integrated from minus infinity to - * <tt>x</tt>) is equal to the argument <tt>y</tt> (assumes mean is zero, - * variance is one). + * Returns the value, <tt>x</tt>, for which the area under the Normal (Gaussian) probability density function + * (integrated from minus infinity to <tt>x</tt>) is equal to the argument <tt>y</tt> (assumes mean is zero, variance + * is one). * <p> - * For small arguments <tt>0 < y < exp(-2)</tt>, the program computes - * <tt>z = sqrt( -2.0 * log(y) )</tt>; then the approximation is - * <tt>x = z - log(z)/z - (1/z) P(1/z) / Q(1/z)</tt>. There are two rational - * functions P/Q, one for <tt>0 < y < exp(-32)</tt> and the other for - * <tt>y</tt> up to <tt>exp(-2)</tt>. For larger arguments, + * For small arguments <tt>0 < y < exp(-2)</tt>, the program computes <tt>z = sqrt( -2.0 * log(y) )</tt>; then the + * approximation is <tt>x = z - log(z)/z - (1/z) P(1/z) / Q(1/z)</tt>. There are two rational functions P/Q, one for + * <tt>0 < y < exp(-32)</tt> and the other for <tt>y</tt> up to <tt>exp(-2)</tt>. For larger arguments, * <tt>w = y - 0.5</tt>, and <tt>x/sqrt(2pi) = w + w**3 R(w**2)/S(w**2))</tt>. * * @param y0 @@ -367,14 +362,11 @@ public class Statistics { * 0 * </pre> * - * <b>Implementation:</b> For - * <tt>0 <= |x| < 1, erf(x) = x * P4(x**2)/Q5(x**2)</tt>; otherwise + * <b>Implementation:</b> For <tt>0 <= |x| < 1, erf(x) = x * P4(x**2)/Q5(x**2)</tt>; otherwise * <tt>erf(x) = 1 - erfc(x)</tt>. * <p> - * Code adapted from the <A - * HREF="http://www.sci.usq.edu.au/staff/leighb/graph/Top.html";> Java 2D Graph - * Package 2.4</A>, which in turn is a port from the <A - * HREF="http://people.ne.mediaone.net/moshier/index.html#Cephes";>Cephes + * Code adapted from the <A HREF="http://www.sci.usq.edu.au/staff/leighb/graph/Top.html";> Java 2D Graph Package + * 2.4</A>, which in turn is a port from the <A HREF="http://people.ne.mediaone.net/moshier/index.html#Cephes";>Cephes * 2.2</A> Math Library (C). * * @param a @@ -420,13 +412,10 @@ public class Statistics { * x * </pre> * - * <b>Implementation:</b> For small x, <tt>erfc(x) = 1 - erf(x)</tt>; - * otherwise rational approximations are computed. + * <b>Implementation:</b> For small x, <tt>erfc(x) = 1 - erf(x)</tt>; otherwise rational approximations are computed. * <p> - * Code adapted from the <A - * HREF="http://www.sci.usq.edu.au/staff/leighb/graph/Top.html";> Java 2D Graph - * Package 2.4</A>, which in turn is a port from the <A - * HREF="http://people.ne.mediaone.net/moshier/index.html#Cephes";>Cephes + * Code adapted from the <A HREF="http://www.sci.usq.edu.au/staff/leighb/graph/Top.html";> Java 2D Graph Package + * 2.4</A>, which in turn is a port from the <A HREF="http://people.ne.mediaone.net/moshier/index.html#Cephes";>Cephes * 2.2</A> Math Library (C). * * @param a @@ -518,9 +507,8 @@ public class Statistics { } /** - * Evaluates the given polynomial of degree <tt>N</tt> at <tt>x</tt>. - * Evaluates polynomial when coefficient of N is 1.0. Otherwise same as - * <tt>polevl()</tt>. + * Evaluates the given polynomial of degree <tt>N</tt> at <tt>x</tt>. Evaluates polynomial when coefficient of N is + * 1.0. Otherwise same as <tt>polevl()</tt>. * * <pre> * 2 N @@ -533,9 +521,8 @@ public class Statistics { * N 0 * </pre> * - * The function <tt>p1evl()</tt> assumes that <tt>coef[N] = 1.0</tt> and is - * omitted from the array. Its calling arguments are otherwise the same as - * <tt>polevl()</tt>. + * The function <tt>p1evl()</tt> assumes that <tt>coef[N] = 1.0</tt> and is omitted from the array. Its calling + * arguments are otherwise the same as <tt>polevl()</tt>. * <p> * In the interest of speed, there are no checks for out of bounds arithmetic. * @@ -784,8 +771,7 @@ public class Statistics { } /** - * Returns the Gamma function computed by Stirling's formula. The polynomial - * STIR is valid for 33 <= x <= 172. + * Returns the Gamma function computed by Stirling's formula. The polynomial STIR is valid for 33 <= x <= 172. */ public static double stirlingFormula(double x) { @@ -1080,8 +1066,7 @@ public class Statistics { } /** - * Power series for incomplete beta integral. Use when b*x is small and x not - * too close to 1. + * Power series for incomplete beta integral. Use when b*x is small and x not too close to 1. */ public static double powerSeries(double a, double b, double x) {
