diff options
Diffstat (limited to 'elki/src/main/java/de/lmu/ifi/dbs/elki/math')
255 files changed, 399 insertions, 128 deletions
diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/DoubleMinMax.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/DoubleMinMax.java index 7fc67833..e65957d8 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/DoubleMinMax.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/DoubleMinMax.java @@ -29,6 +29,7 @@ import java.util.Collection; * Class to find the minimum and maximum double values in data. * * @author Erich Schubert + * @since 0.2 */ public class DoubleMinMax { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/IntegerMinMax.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/IntegerMinMax.java index c80b0516..12b83945 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/IntegerMinMax.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/IntegerMinMax.java @@ -30,6 +30,7 @@ import java.util.Collection; * * @author Erich Schubert * @author Arthur Zimek + * @since 0.2 */ public class IntegerMinMax { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/MathUtil.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/MathUtil.java index deb3ed2c..2c9f0301 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/MathUtil.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/MathUtil.java @@ -36,6 +36,7 @@ import de.lmu.ifi.dbs.elki.math.linearalgebra.Vector; * * @author Arthur Zimek * @author Erich Schubert + * @since 0.2 * * @apiviz.landmark */ @@ -1046,16 +1047,15 @@ public final class MathUtil { return Math.pow(x, p); } double tmp = x, ret = (p & 1) == 1 ? x : 1.; - p >>= 1; while(true) { + tmp *= tmp; + p >>= 1; if(p == 1) { return ret * tmp; } if((p & 1) != 0) { ret *= tmp; } - tmp *= tmp; - p >>= 1; } } @@ -1072,16 +1072,15 @@ public final class MathUtil { return (int) Math.pow(x, p); } int tmp = x, ret = (p & 1) == 1 ? x : 1; - p >>= 1; while(true) { + tmp *= tmp; + p >>= 1; if(p == 1) { return ret * tmp; } if((p & 1) != 0) { ret *= tmp; } - tmp *= tmp; - p >>= 1; } } diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/Mean.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/Mean.java index da8bde38..0eb7f3f0 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/Mean.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/Mean.java @@ -49,6 +49,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * </p> * * @author Erich Schubert + * @since 0.4.0 */ @Reference(authors = "B. P. Welford", // title = "Note on a method for calculating corrected sums of squares and products", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/MeanVariance.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/MeanVariance.java index 5a1cd7e6..6b5f893d 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/MeanVariance.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/MeanVariance.java @@ -56,6 +56,7 @@ import de.lmu.ifi.dbs.elki.utilities.exceptions.AbortException; * </p> * * @author Erich Schubert + * @since 0.2 */ @Reference(authors = "B. P. Welford", // title = "Note on a method for calculating corrected sums of squares and products", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/MeanVarianceMinMax.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/MeanVarianceMinMax.java index fcd96f02..46ad82e0 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/MeanVarianceMinMax.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/MeanVarianceMinMax.java @@ -29,6 +29,7 @@ import de.lmu.ifi.dbs.elki.utilities.exceptions.AbortException; * Class collecting mean, variance, minimum and maximum statistics. * * @author Erich Schubert + * @since 0.5.0 */ public class MeanVarianceMinMax extends MeanVariance { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/PearsonCorrelation.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/PearsonCorrelation.java index b2821bdd..9bfe38ae 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/PearsonCorrelation.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/PearsonCorrelation.java @@ -31,6 +31,7 @@ package de.lmu.ifi.dbs.elki.math; * slightly more memory (by using arrays) but essentially does the same. * * @author Erich Schubert + * @since 0.5.0 */ public class PearsonCorrelation { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/Primes.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/Primes.java index 2a717634..adebf820 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/Primes.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/Primes.java @@ -31,6 +31,7 @@ package de.lmu.ifi.dbs.elki.math; * classes. * * @author Erich Schubert + * @since 0.5.5 */ public final class Primes { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/SinCosTable.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/SinCosTable.java index 842f7152..f224a8b3 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/SinCosTable.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/SinCosTable.java @@ -33,6 +33,7 @@ package de.lmu.ifi.dbs.elki.math; * TODO: add caching * * @author Erich Schubert + * @since 0.5.5 */ public abstract class SinCosTable { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/StatisticalMoments.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/StatisticalMoments.java index df188a7f..f9146314 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/StatisticalMoments.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/StatisticalMoments.java @@ -46,6 +46,7 @@ import de.lmu.ifi.dbs.elki.utilities.exceptions.AbortException; * </p> * * @author Erich Schubert + * @since 0.6.0 */ @Reference(authors = "T. B. Terriberry", title = "Computing Higher-Order Moments Online", booktitle = "Online - Technical Note", url = "http://people.xiph.org/~tterribe/notes/homs.html") public class StatisticalMoments extends MeanVarianceMinMax { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/CovarianceDimensionSimilarity.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/CovarianceDimensionSimilarity.java index 08f4ad86..10c0713e 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/CovarianceDimensionSimilarity.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/CovarianceDimensionSimilarity.java @@ -32,6 +32,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Class to compute the dimension similarity based on covariances. * * @author Erich Schubert + * @since 0.5.5 */ public class CovarianceDimensionSimilarity implements DimensionSimilarity<NumberVector> { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/DimensionSimilarity.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/DimensionSimilarity.java index 7e772838..1bc08dbe 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/DimensionSimilarity.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/DimensionSimilarity.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.database.relation.Relation; * dimensions in parallel coordinate plots. * * @author Erich Schubert + * @since 0.5.5 * * @apiviz.uses DimensionSimilarityMatrix - - «writes» * diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/DimensionSimilarityMatrix.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/DimensionSimilarityMatrix.java index 89d0d4eb..6e57ad00 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/DimensionSimilarityMatrix.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/DimensionSimilarityMatrix.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.math.linearalgebra.Matrix; * Class representing a similarity matrix between dimensions. * * @author Erich Schubert + * @since 0.5.5 * * @apiviz.uses PrimsMinimumSpanningTree */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/HSMDimensionSimilarity.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/HSMDimensionSimilarity.java index 4627c785..e4e55b9b 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/HSMDimensionSimilarity.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/HSMDimensionSimilarity.java @@ -49,6 +49,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Erich Schubert * @author Robert Rödler + * @since 0.5.5 */ @Reference(authors = "A. Tatu, G. Albuquerque, M. Eisemann, P. Bak, H. Theisel, M. A. Magnor, and D. A. Keim", // title = "Automated Analytical Methods to Support Visual Exploration of High-Dimensional Data", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/HiCSDimensionSimilarity.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/HiCSDimensionSimilarity.java index 1c024fc8..0e0ddcaa 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/HiCSDimensionSimilarity.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/HiCSDimensionSimilarity.java @@ -70,6 +70,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.RandomParameter; * * @author Erich Schubert * @author Robert Rödler + * @since 0.5.5 */ @Reference(authors = "Elke Achtert, Hans-Peter Kriegel, Erich Schubert, Arthur Zimek", // title = "Interactive Data Mining with 3D-Parallel-Coordinate-Trees", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/MCEDimensionSimilarity.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/MCEDimensionSimilarity.java index 048f960d..88adbf9d 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/MCEDimensionSimilarity.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/MCEDimensionSimilarity.java @@ -52,6 +52,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.5.5 */ @Reference(authors = "D. Guo", // title = "Coordinating computational and visual approaches for interactive feature selection and multivariate clustering", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/SURFINGDimensionSimilarity.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/SURFINGDimensionSimilarity.java index d7aa8ca6..4474239c 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/SURFINGDimensionSimilarity.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/SURFINGDimensionSimilarity.java @@ -62,6 +62,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Robert Rödler * @author Erich Schubert + * @since 0.5.5 * * @apiviz.uses SubspaceEuclideanDistanceFunction */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/SlopeDimensionSimilarity.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/SlopeDimensionSimilarity.java index eeb7906d..55205fcc 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/SlopeDimensionSimilarity.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/SlopeDimensionSimilarity.java @@ -46,6 +46,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Erich Schubert * @author Robert Rödler + * @since 0.5.5 */ @Reference(authors = "Elke Achtert, Hans-Peter Kriegel, Erich Schubert, Arthur Zimek", // title = "Interactive Data Mining with 3D-Parallel-Coordinate-Trees", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/SlopeInversionDimensionSimilarity.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/SlopeInversionDimensionSimilarity.java index 52b73350..aee0a9db 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/SlopeInversionDimensionSimilarity.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/dimensionsimilarity/SlopeInversionDimensionSimilarity.java @@ -48,6 +48,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Erich Schubert * @author Robert Rödler + * @since 0.5.5 */ @Reference(authors = "Elke Achtert, Hans-Peter Kriegel, Erich Schubert, Arthur Zimek", // title = "Interactive Data Mining with 3D-Parallel-Coordinate-Trees", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/AbstractEarthModel.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/AbstractEarthModel.java index 34652bd4..9122755b 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/AbstractEarthModel.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/AbstractEarthModel.java @@ -29,6 +29,7 @@ import de.lmu.ifi.dbs.elki.math.MathUtil; * Abstract base class for earth models with shared glue code. * * @author Erich Schubert + * @since 0.6.0 */ public abstract class AbstractEarthModel implements EarthModel { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/Clarke1858SpheroidEarthModel.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/Clarke1858SpheroidEarthModel.java index 4bc5560e..186c3c3a 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/Clarke1858SpheroidEarthModel.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/Clarke1858SpheroidEarthModel.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Flattening: 1 / 294.26068 * * @author Erich Schubert + * @since 0.3 */ @Alias({ "Clarke1858" }) public class Clarke1858SpheroidEarthModel extends AbstractEarthModel { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/Clarke1880SpheroidEarthModel.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/Clarke1880SpheroidEarthModel.java index b204c8c4..ef1a0d2d 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/Clarke1880SpheroidEarthModel.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/Clarke1880SpheroidEarthModel.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Flattening: 1 / 293.465 * * @author Erich Schubert + * @since 0.3 */ @Alias({ "Clarke1880" }) public class Clarke1880SpheroidEarthModel extends AbstractEarthModel { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/EarthModel.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/EarthModel.java index 332ddf64..8eb697b0 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/EarthModel.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/EarthModel.java @@ -28,6 +28,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionID; * API for handling different earth models. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.uses SphereUtil */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/GRS67SpheroidEarthModel.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/GRS67SpheroidEarthModel.java index d8468a6b..7770933f 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/GRS67SpheroidEarthModel.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/GRS67SpheroidEarthModel.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Flattening: 1 / 298.25 * * @author Erich Schubert + * @since 0.3 */ @Alias({ "GRS67", "GRS-67" }) public class GRS67SpheroidEarthModel extends AbstractEarthModel { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/GRS80SpheroidEarthModel.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/GRS80SpheroidEarthModel.java index 591dd923..8d9b59a5 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/GRS80SpheroidEarthModel.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/GRS80SpheroidEarthModel.java @@ -35,6 +35,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Flattening: 1 / 298.257222101 * * @author Erich Schubert + * @since 0.3 */ @Alias({ "GRS-80", "GRS80" }) public class GRS80SpheroidEarthModel extends AbstractEarthModel { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphereUtil.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphereUtil.java index 8fcd4d97..98a674f0 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphereUtil.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphereUtil.java @@ -42,6 +42,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * * @author Erich Schubert * @author Niels Dörre + * @since 0.5.5 */ @Reference(authors = "Ed Williams", title = "Aviation Formulary", booktitle = "", url = "http://williams.best.vwh.net/avform.htm") public final class SphereUtil { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphericalCosineEarthModel.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphericalCosineEarthModel.java index c8cc694a..f4b51dca 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphericalCosineEarthModel.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphericalCosineEarthModel.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * faster but less accurate than the Haversince or Vincenty's formula. * * @author Erich Schubert + * @since 0.6.0 */ public class SphericalCosineEarthModel extends AbstractEarthModel { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphericalHaversineEarthModel.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphericalHaversineEarthModel.java index db0c39c9..56e581a9 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphericalHaversineEarthModel.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphericalHaversineEarthModel.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * faster but less accurate than Vincenty's formula. * * @author Erich Schubert + * @since 0.6.0 */ public class SphericalHaversineEarthModel extends AbstractEarthModel { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphericalVincentyEarthModel.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphericalVincentyEarthModel.java index 7f627425..439b8e77 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphericalVincentyEarthModel.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/SphericalVincentyEarthModel.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * A simple spherical earth model using radius 6371009 m. * * @author Erich Schubert + * @since 0.6.0 */ public class SphericalVincentyEarthModel extends AbstractEarthModel { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/WGS72SpheroidEarthModel.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/WGS72SpheroidEarthModel.java index 43763328..3a23cf47 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/WGS72SpheroidEarthModel.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/WGS72SpheroidEarthModel.java @@ -35,6 +35,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Flattening: 1 / 298.26 * * @author Erich Schubert + * @since 0.3 */ @Alias({ "WGS72", "WGS-72" }) public class WGS72SpheroidEarthModel extends AbstractEarthModel { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/WGS84SpheroidEarthModel.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/WGS84SpheroidEarthModel.java index 522e769a..2265353a 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/WGS84SpheroidEarthModel.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geodesy/WGS84SpheroidEarthModel.java @@ -38,6 +38,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Flattening: 1 / 298.257223563 * * @author Erich Schubert + * @since 0.3 * * @apiviz.landmark */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/AlphaShape.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/AlphaShape.java index aefb9149..c02efca1 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/AlphaShape.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/AlphaShape.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.utilities.BitsUtil; * Compute the alpha-Shape of a point set, using Delaunay triangulation. * * @author Erich Schubert + * @since 0.5.0 * * @apiviz.uses SweepHullDelaunay2D * @apiviz.has Polygon diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/GrahamScanConvexHull2D.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/GrahamScanConvexHull2D.java index c3f69807..529ae2fe 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/GrahamScanConvexHull2D.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/GrahamScanConvexHull2D.java @@ -40,6 +40,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * classic Grahams scan. Also computes a bounding box. * * @author Erich Schubert + * @since 0.4.0 * * @apiviz.has Polygon */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/PrimsMinimumSpanningTree.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/PrimsMinimumSpanningTree.java index 578f7d12..06596cde 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/PrimsMinimumSpanningTree.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/PrimsMinimumSpanningTree.java @@ -41,6 +41,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * </p> * * @author Erich Schubert + * @since 0.5.5 * * @apiviz.composedOf Adapter * @apiviz.composedOf Collector diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/SweepHullDelaunay2D.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/SweepHullDelaunay2D.java index b404ebfb..cb2d498a 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/SweepHullDelaunay2D.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/SweepHullDelaunay2D.java @@ -47,6 +47,7 @@ import de.lmu.ifi.dbs.elki.utilities.pairs.IntIntPair; * Note: This implementation does not check or handle duplicate points! * * @author Erich Schubert + * @since 0.5.0 * * @apiviz.has Polygon */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/XYCurve.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/XYCurve.java index f3af2c8e..8c05e62e 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/XYCurve.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/XYCurve.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.DoubleArray; * the curve while adding points. * * @author Erich Schubert + * @since 0.5.0 */ public class XYCurve implements Result, TextWriteable { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/XYPlot.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/XYPlot.java index 412f19ee..76c367ff 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/XYPlot.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/geometry/XYPlot.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.result.Result; * generation. * * @author Erich Schubert + * @since 0.7.0 * * @apiviz.composedOf Curve */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/AffineTransformation.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/AffineTransformation.java index 74b19d2c..e00e3802 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/AffineTransformation.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/AffineTransformation.java @@ -36,6 +36,7 @@ import de.lmu.ifi.dbs.elki.math.MathUtil; * transformation. * * @author Erich Schubert + * @since 0.2 * * @apiviz.composedOf Matrix * @apiviz.uses Matrix diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/Centroid.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/Centroid.java index 2e7ba977..dfc0f2a2 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/Centroid.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/Centroid.java @@ -39,6 +39,7 @@ import de.lmu.ifi.dbs.elki.database.relation.RelationUtil; * easier to use APIs. * * @author Erich Schubert + * @since 0.4.0 */ public class Centroid extends Vector { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/CholeskyDecomposition.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/CholeskyDecomposition.java index ef0d5ef7..ce0f8ab0 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/CholeskyDecomposition.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/CholeskyDecomposition.java @@ -23,7 +23,6 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra; along with this program. If not, see <http://www.gnu.org/licenses/>. */ - /** * Cholesky Decomposition. * <P> @@ -34,6 +33,9 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra; * a partial decomposition and sets an internal flag that may be queried by the * isSPD() method. * + * @author Arthur Zimek + * @since 0.2 + * * @apiviz.uses Matrix - - transforms */ @SuppressWarnings("serial") diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/CovarianceMatrix.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/CovarianceMatrix.java index 1e40430f..566e0e11 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/CovarianceMatrix.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/CovarianceMatrix.java @@ -46,6 +46,7 @@ import de.lmu.ifi.dbs.elki.database.relation.RelationUtil; * stabilized covariance matrix builder! * * @author Erich Schubert + * @since 0.4.0 * * @apiviz.uses Vector oneway * @apiviz.uses NumberVector oneway diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/EigenPair.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/EigenPair.java index f2d6cec3..df4da275 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/EigenPair.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/EigenPair.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.utilities.FormatUtil; * eigenvalue. This class is used to sort eigenpairs. * * @author Elke Achtert + * @since 0.2 * * @apiviz.composedOf Matrix */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/EigenvalueDecomposition.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/EigenvalueDecomposition.java index fde453c6..88ab0688 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/EigenvalueDecomposition.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/EigenvalueDecomposition.java @@ -39,7 +39,10 @@ import de.lmu.ifi.dbs.elki.math.MathUtil; * the eigenvectors in the sense that A*V = V*D, i.e. A.times(V) equals * V.times(D). The matrix V may be badly conditioned, or even singular, so the * validity of the equation A = V*D*inverse(V) depends upon V.cond(). - * + * + * @author Arthur Zimek + * @since 0.2 + * * @apiviz.uses Matrix - - transforms */ public class EigenvalueDecomposition implements java.io.Serializable { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/LUDecomposition.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/LUDecomposition.java index be33769e..361e315e 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/LUDecomposition.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/LUDecomposition.java @@ -36,6 +36,9 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra; * decomposition is in the solution of square systems of simultaneous linear * equations. This will fail if isNonsingular() returns false. * + * @author Arthur Zimek + * @since 0.2 + * * @apiviz.uses Matrix - - transforms */ public class LUDecomposition implements java.io.Serializable { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/LinearEquationSystem.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/LinearEquationSystem.java index da723177..3d273520 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/LinearEquationSystem.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/LinearEquationSystem.java @@ -38,6 +38,7 @@ import de.lmu.ifi.dbs.elki.utilities.pairs.IntIntPair; * Class for systems of linear equations. * * @author Elke Achtert + * @since 0.2 */ public class LinearEquationSystem { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/Matrix.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/Matrix.java index cb828e50..9f6ecde9 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/Matrix.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/Matrix.java @@ -44,6 +44,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.DoubleArray; * * @author Elke Achtert * @author Erich Schubert + * @since 0.2 * * @apiviz.uses Vector * @apiviz.landmark diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/ProjectedCentroid.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/ProjectedCentroid.java index cc850ce4..b519ca9e 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/ProjectedCentroid.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/ProjectedCentroid.java @@ -40,6 +40,7 @@ import de.lmu.ifi.dbs.elki.utilities.BitsUtil; * easier to use APIs. * * @author Erich Schubert + * @since 0.4.0 */ public class ProjectedCentroid extends Centroid { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/ProjectionResult.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/ProjectionResult.java index ca1c05c2..67958078 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/ProjectionResult.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/ProjectionResult.java @@ -30,6 +30,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra; * This can either come from a full PCA, or just from an axis-parallel subspace selection * * @author Erich Schubert + * @since 0.4.0 */ // TODO: cleanup public interface ProjectionResult { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/QRDecomposition.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/QRDecomposition.java index 541987e7..be07df37 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/QRDecomposition.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/QRDecomposition.java @@ -36,6 +36,9 @@ import de.lmu.ifi.dbs.elki.math.MathUtil; * decomposition is in the least squares solution of nonsquare systems of * simultaneous linear equations. This will fail if isFullRank() returns false. * + * @author Arthur Zimek + * @since 0.2 + * * @apiviz.uses Matrix - - transforms */ public class QRDecomposition implements java.io.Serializable { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/SingularValueDecomposition.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/SingularValueDecomposition.java index 6b311ed1..2514acc6 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/SingularValueDecomposition.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/SingularValueDecomposition.java @@ -39,6 +39,9 @@ import de.lmu.ifi.dbs.elki.math.MathUtil; * fail. The matrix condition number and the effective numerical rank can be * computed from this decomposition. * + * @author Arthur Zimek + * @since 0.2 + * * @apiviz.uses Matrix - - transforms */ public class SingularValueDecomposition { @@ -326,7 +329,7 @@ public class SingularValueDecomposition { // Perform the task indicated by kase. switch(kase){ - + // Deflate negligible s(p). case 1: { double f = e[p - 2]; diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/SortedEigenPairs.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/SortedEigenPairs.java index a4cca9de..e028793c 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/SortedEigenPairs.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/SortedEigenPairs.java @@ -33,6 +33,7 @@ import java.util.List; * eigenvectors (and -values). * * @author Elke Achtert + * @since 0.2 * * @apiviz.composedOf de.lmu.ifi.dbs.elki.math.linearalgebra.EigenPair */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/VMath.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/VMath.java index a6d4ea77..31456eff 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/VMath.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/VMath.java @@ -31,6 +31,7 @@ import java.util.Arrays; * usage and VM overhead. * * @author Erich Schubert + * @since 0.5.0 * * @apiviz.landmark */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/Vector.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/Vector.java index 06198e4a..80e7e219 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/Vector.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/Vector.java @@ -39,6 +39,7 @@ import de.lmu.ifi.dbs.elki.utilities.io.ByteBufferSerializer; * A mathematical vector object, along with mathematical operations. * * @author Elke Achtert + * @since 0.2 * * @apiviz.landmark */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/FittingFunction.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/FittingFunction.java index a0da0c7b..13aa185a 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/FittingFunction.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/FittingFunction.java @@ -28,6 +28,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra.fitting; * Interface for a function used in Levenberg-Marquard-Fitting * * @author Erich Schubert + * @since 0.2 */ public interface FittingFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/FittingFunctionResult.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/FittingFunctionResult.java index bf17e4c3..52f340a8 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/FittingFunctionResult.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/FittingFunctionResult.java @@ -28,6 +28,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra.fitting; * Result returned by a fitting function. * * @author Erich Schubert + * @since 0.2 */ public class FittingFunctionResult { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/GaussianFittingFunction.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/GaussianFittingFunction.java index 6cdcff18..7d12cdff 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/GaussianFittingFunction.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/GaussianFittingFunction.java @@ -58,6 +58,7 @@ import de.lmu.ifi.dbs.elki.math.MathUtil; * number of parameters (which obviously needs to be a multiple of 3) * * @author Erich Schubert + * @since 0.2 */ public class GaussianFittingFunction implements FittingFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/LevenbergMarquardtMethod.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/LevenbergMarquardtMethod.java index b77f3b79..0ca9a643 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/LevenbergMarquardtMethod.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/fitting/LevenbergMarquardtMethod.java @@ -48,6 +48,7 @@ import de.lmu.ifi.dbs.elki.math.linearalgebra.LinearEquationSystem; * Which supposedly offers increased robustness. * * @author Erich Schubert + * @since 0.2 * * @apiviz.has FittingFunction * @apiviz.uses FittingFunctionResult oneway - - «create» diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/AbstractCovarianceMatrixBuilder.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/AbstractCovarianceMatrixBuilder.java index 8190eea5..3874b91b 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/AbstractCovarianceMatrixBuilder.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/AbstractCovarianceMatrixBuilder.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.math.linearalgebra.Matrix; * Mostly the specification of an interface. * * @author Erich Schubert + * @since 0.2 */ public abstract class AbstractCovarianceMatrixBuilder implements CovarianceMatrixBuilder { @Override diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/CompositeEigenPairFilter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/CompositeEigenPairFilter.java index c56217f8..bd88dcb8 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/CompositeEigenPairFilter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/CompositeEigenPairFilter.java @@ -36,15 +36,11 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ObjectListParamet * eigenpair filters. * * @author Elke Achtert + * @since 0.2 */ // todo parameter comments public class CompositeEigenPairFilter implements EigenPairFilter { /** - * The list of filters to use. - */ - public static final OptionID EIGENPAIR_FILTER_COMPOSITE_LIST = new OptionID("pca.filter.composite.list", "A comma separated list of the class names of the filters to be used. " + "The specified filters will be applied sequentially in the given order."); - - /** * The filters to be applied. */ private List<EigenPairFilter> filters; @@ -86,6 +82,10 @@ public class CompositeEigenPairFilter implements EigenPairFilter { */ public static class Parameterizer extends AbstractParameterizer { /** + * The list of filters to use. + */ + public static final OptionID EIGENPAIR_FILTER_COMPOSITE_LIST = new OptionID("pca.filter.composite.list", "A comma separated list of the class names of the filters to be used. " + "The specified filters will be applied sequentially in the given order."); + /** * The filters to be applied. */ private List<EigenPairFilter> filters = null; diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/CovarianceMatrixBuilder.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/CovarianceMatrixBuilder.java index e3d10297..c2b40a85 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/CovarianceMatrixBuilder.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/CovarianceMatrixBuilder.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.math.linearalgebra.Matrix; * Interface for computing covariance matrixes on a data set. * * @author Erich Schubert + * @since 0.2 */ public interface CovarianceMatrixBuilder { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/DropEigenPairFilter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/DropEigenPairFilter.java index 7d642b86..40a171df 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/DropEigenPairFilter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/DropEigenPairFilter.java @@ -37,16 +37,17 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; /** * The "drop" filter looks for the largest drop in normalized relative * eigenvalues. - * + * * Let s_1 .. s_n be the eigenvalues. - * + * * Let a_k := 1/(n-k) sum_{i=k..n} s_i - * + * * Then r_k := s_k / a_k is the relative eigenvalue. - * + * * The drop filter searches for argmax_k r_k / r_{k+1} - * + * * @author Erich Schubert + * @since 0.2 */ @Title("Drop EigenPair Filter") public class DropEigenPairFilter implements EigenPairFilter { @@ -63,7 +64,7 @@ public class DropEigenPairFilter implements EigenPairFilter { /** * Constructor. - * + * * @param walpha */ public DropEigenPairFilter(double walpha) { @@ -121,9 +122,9 @@ public class DropEigenPairFilter implements EigenPairFilter { /** * Parameterization class. - * + * * @author Erich Schubert - * + * * @apiviz.exclude */ public static class Parameterizer extends AbstractParameterizer { @@ -132,7 +133,7 @@ public class DropEigenPairFilter implements EigenPairFilter { @Override protected void makeOptions(Parameterization config) { super.makeOptions(config); - DoubleParameter walphaP = new DoubleParameter(WeakEigenPairFilter.EIGENPAIR_FILTER_WALPHA, DEFAULT_WALPHA); + DoubleParameter walphaP = new DoubleParameter(WeakEigenPairFilter.Parameterizer.EIGENPAIR_FILTER_WALPHA, DEFAULT_WALPHA); walphaP.addConstraint(CommonConstraints.GREATER_EQUAL_ZERO_DOUBLE); if (config.grab(walphaP)) { walpha = walphaP.getValue(); diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/EigenPairFilter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/EigenPairFilter.java index b0a244f6..7b3886e5 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/EigenPairFilter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/EigenPairFilter.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.math.linearalgebra.SortedEigenPairs; * and weak eigenpairs having small variances. * * @author Elke Achtert + * @since 0.2 * * @apiviz.uses SortedEigenPairs oneway - - reads * @apiviz.uses FilteredEigenPairs oneway - - «create» diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/FilteredEigenPairs.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/FilteredEigenPairs.java index b8343a24..fcc09c7c 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/FilteredEigenPairs.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/FilteredEigenPairs.java @@ -32,6 +32,7 @@ import de.lmu.ifi.dbs.elki.math.linearalgebra.EigenPair; * by an eigenpair filter. * * @author Elke Achtert + * @since 0.2 * * @apiviz.has EigenPair */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/FirstNEigenPairFilter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/FirstNEigenPairFilter.java index d2251f28..ca7d288e 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/FirstNEigenPairFilter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/FirstNEigenPairFilter.java @@ -42,6 +42,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.IntParameter; * eigenpairs, where n is a user specified number. * * @author Elke Achtert + * @since 0.2 */ // todo parameter comments @Title("First n Eigenpair filter") @@ -53,11 +54,6 @@ public class FirstNEigenPairFilter implements EigenPairFilter { private static final Logging LOG = Logging.getLogger(FirstNEigenPairFilter.class); /** - * Paremeter n - */ - public static final OptionID EIGENPAIR_FILTER_N = new OptionID("pca.filter.n", "The number of strong eigenvectors: n eigenvectors with the n highest" + "eigenvalues are marked as strong eigenvectors."); - - /** * The threshold for strong eigenvectors: n eigenvectors with the n highest * eigenvalues are marked as strong eigenvectors. */ @@ -114,6 +110,10 @@ public class FirstNEigenPairFilter implements EigenPairFilter { */ public static class Parameterizer extends AbstractParameterizer { /** + * Paremeter n + */ + public static final OptionID EIGENPAIR_FILTER_N = new OptionID("pca.filter.n", "The number of strong eigenvectors: n eigenvectors with the n highest" + "eigenvalues are marked as strong eigenvectors."); + /** * The number of eigenpairs to keep. */ protected int n = 0; diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/LimitEigenPairFilter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/LimitEigenPairFilter.java index 779ceb2e..a4047473 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/LimitEigenPairFilter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/LimitEigenPairFilter.java @@ -48,6 +48,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Flag; * others are marked as strong eigenpairs. * * @author Elke Achtert + * @since 0.2 */ @Title("Limit-based Eigenpair Filter") @Description("Filters all eigenpairs, which are lower than a given value.") @@ -58,16 +59,6 @@ public class LimitEigenPairFilter implements EigenPairFilter { private static final Logging LOG = Logging.getLogger(LimitEigenPairFilter.class); /** - * "absolute" Flag - */ - public static final OptionID EIGENPAIR_FILTER_ABSOLUTE = new OptionID("pca.filter.absolute", "Flag to mark delta as an absolute value."); - - /** - * Parameter delta - */ - public static final OptionID EIGENPAIR_FILTER_DELTA = new OptionID("pca.filter.delta", "The threshold for strong Eigenvalues. If not otherwise specified, delta " + "is a relative value w.r.t. the (absolute) highest Eigenvalues and has to be " + "a double between 0 and 1. To mark delta as an absolute value, use " + "the option -" + EIGENPAIR_FILTER_ABSOLUTE.getName() + "."); - - /** * The default value for delta. */ public static final double DEFAULT_DELTA = 0.01; @@ -154,6 +145,16 @@ public class LimitEigenPairFilter implements EigenPairFilter { */ public static class Parameterizer extends AbstractParameterizer { /** + * "absolute" Flag + */ + public static final OptionID EIGENPAIR_FILTER_ABSOLUTE = new OptionID("pca.filter.absolute", "Flag to mark delta as an absolute value."); + + /** + * Parameter delta + */ + public static final OptionID EIGENPAIR_FILTER_DELTA = new OptionID("pca.filter.delta", "The threshold for strong Eigenvalues. If not otherwise specified, delta " + "is a relative value w.r.t. the (absolute) highest Eigenvalues and has to be " + "a double between 0 and 1. To mark delta as an absolute value, use " + "the option -" + EIGENPAIR_FILTER_ABSOLUTE.getName() + "."); + + /** * Threshold for strong eigenpairs, can be absolute or relative. */ private double delta; diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/NormalizingEigenPairFilter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/NormalizingEigenPairFilter.java index fb95a68c..9f77f747 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/NormalizingEigenPairFilter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/NormalizingEigenPairFilter.java @@ -38,6 +38,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Title; * eigenvector> * eigenvalue = 1, where <,> is the standard dot product * * @author Simon Paradies + * @since 0.2 */ @Title("Perecentage based Eigenpair filter") @Description("Normalizes all eigenpairs, consisting of eigenvalue e and eigenvector v such that <v,v> * e = 1, where <,> is the standard dot product.") diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAFilteredAutotuningRunner.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAFilteredAutotuningRunner.java index 600fcf95..4abd1c6d 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAFilteredAutotuningRunner.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAFilteredAutotuningRunner.java @@ -55,6 +55,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * exhibit the clearest correlation. * * @author Erich Schubert + * @since 0.5.0 */ @Reference(authors = "Hans-Peter Kriegel, Peer Kröger, Erich Schubert, Arthur Zimek", // title = "A General Framework for Increasing the Robustness of PCA-based Correlation Clustering Algorithms",// diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAFilteredResult.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAFilteredResult.java index f7ec9e79..1b7d6910 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAFilteredResult.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAFilteredResult.java @@ -38,6 +38,7 @@ import de.lmu.ifi.dbs.elki.math.linearalgebra.SortedEigenPairs; * subspace and an "error" subspace. * * @author Erich Schubert + * @since 0.2 * * @apiviz.landmark */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAFilteredRunner.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAFilteredRunner.java index e7c31cf6..d61c7830 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAFilteredRunner.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAFilteredRunner.java @@ -42,6 +42,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ObjectParameter; * regular runner, but afterwards, an {@link EigenPairFilter} is applied. * * @author Erich Schubert + * @since 0.2 * * @apiviz.landmark * @apiviz.has PCAFilteredResult oneway - - «create» diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAResult.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAResult.java index 4c0de355..72268972 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAResult.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCAResult.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.math.linearalgebra.SortedEigenPairs; * Result class for Principal Component Analysis with some convenience methods * * @author Erich Schubert + * @since 0.2 * * @apiviz.landmark * @apiviz.has SortedEigenPairs diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCARunner.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCARunner.java index bdd4f32f..c4195506 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCARunner.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PCARunner.java @@ -46,6 +46,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ObjectParameter; * to a weighted covariance matrix builder) * * @author Erich Schubert + * @since 0.2 * * @apiviz.landmark * @apiviz.uses PCAResult oneway - - «create» @@ -53,18 +54,6 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ObjectParameter; */ public class PCARunner { /** - * Parameter to specify the class to compute the covariance matrix, must be a - * subclass of {@link CovarianceMatrixBuilder}. - * <p> - * Default value: {@link CovarianceMatrixBuilder} - * </p> - * <p> - * Key: {@code -pca.covariance} - * </p> - */ - public static final OptionID PCA_COVARIANCE_MATRIX = new OptionID("pca.covariance", "Class used to compute the covariance matrix."); - - /** * The covariance computation class. */ protected CovarianceMatrixBuilder covarianceMatrixBuilder; @@ -161,6 +150,17 @@ public class PCARunner { */ public static class Parameterizer extends AbstractParameterizer { /** + * Parameter to specify the class to compute the covariance matrix, must be a + * subclass of {@link CovarianceMatrixBuilder}. + * <p> + * Default value: {@link CovarianceMatrixBuilder} + * </p> + * <p> + * Key: {@code -pca.covariance} + * </p> + */ + public static final OptionID PCA_COVARIANCE_MATRIX = new OptionID("pca.covariance", "Class used to compute the covariance matrix."); + /** * The covariance computation class. */ protected CovarianceMatrixBuilder covarianceMatrixBuilder; diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PercentageEigenPairFilter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PercentageEigenPairFilter.java index c32ad6fc..8b445b97 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PercentageEigenPairFilter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/PercentageEigenPairFilter.java @@ -44,6 +44,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * eigenpairs. * * @author Elke Achtert + * @since 0.2 */ @Title("Percentage based Eigenpair filter") @Description("Sorts the eigenpairs in decending order of their eigenvalues and returns the first eigenpairs, whose sum of eigenvalues is higher than the given percentage of the sum of all eigenvalues.") @@ -54,18 +55,6 @@ public class PercentageEigenPairFilter implements EigenPairFilter { private static final Logging LOG = Logging.getLogger(PercentageEigenPairFilter.class); /** - * The threshold for 'strong' eigenvectors: the 'strong' eigenvectors explain - * a portion of at least alpha of the total variance. - * <p> - * Default value: {@link #DEFAULT_ALPHA} - * </p> - * <p> - * Key: {@code -pca.filter.alpha} - * </p> - */ - public static final OptionID ALPHA_ID = new OptionID("pca.filter.alpha", "The share (0.0 to 1.0) of variance that needs to be explained by the 'strong' eigenvectors." + "The filter class will choose the number of strong eigenvectors by this share."); - - /** * The default value for alpha. */ public static final double DEFAULT_ALPHA = 0.85; @@ -145,6 +134,17 @@ public class PercentageEigenPairFilter implements EigenPairFilter { */ public static class Parameterizer extends AbstractParameterizer { /** + * The threshold for 'strong' eigenvectors: the 'strong' eigenvectors explain + * a portion of at least alpha of the total variance. + * <p> + * Default value: {@link #DEFAULT_ALPHA} + * </p> + * <p> + * Key: {@code -pca.filter.alpha} + * </p> + */ + public static final OptionID ALPHA_ID = new OptionID("pca.filter.alpha", "The share (0.0 to 1.0) of variance that needs to be explained by the 'strong' eigenvectors." + "The filter class will choose the number of strong eigenvectors by this share."); + /** * The threshold for strong eigenvectors: the strong eigenvectors explain a * portion of at least alpha of the total variance. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/ProgressiveEigenPairFilter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/ProgressiveEigenPairFilter.java index 16b6d72e..242c00f4 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/ProgressiveEigenPairFilter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/ProgressiveEigenPairFilter.java @@ -46,48 +46,44 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * gives better results when clusters of different dimensionality exist, since * different percentage alpha levels might be appropriate for different * dimensionalities. - * + * * Example calculations of alpha levels: - * + * * In a 3D space, a progressive alpha value of 0.5 equals: - * + * * - 1D subspace: 50 % + 1/3 of remainder = 0.667 - * + * * - 2D subspace: 50 % + 2/3 of remainder = 0.833 - * + * * In a 4D space, a progressive alpha value of 0.5 equals: - * + * * - 1D subspace: 50% + 1/4 of remainder = 0.625 - * + * * - 2D subspace: 50% + 2/4 of remainder = 0.750 - * + * * - 3D subspace: 50% + 3/4 of remainder = 0.875 - * + * * Reasoning why this improves over PercentageEigenPairFilter: - * + * * In a 100 dimensional space, a single Eigenvector representing over 85% of the * total variance is highly significant, whereas the strongest 85 Eigenvectors * together will by definition always represent at least 85% of the variance. * PercentageEigenPairFilter can thus not be used with these parameters and * detect both dimensionalities correctly. - * + * * The second parameter introduced here, walpha, serves a different function: It * prevents the eigenpair filter to use a statistically weak Eigenvalue just to * reach the intended level, e.g. 84% + 1% >= 85% when 1% is statistically very * weak. - * + * * @author Erich Schubert - * + * @since 0.2 + * */ @Title("Progressive Eigenpair Filter") @Description("Sorts the eigenpairs in decending order of their eigenvalues and returns the first eigenpairs, whose sum of eigenvalues explains more than the a certain percentage of the unexpected variance, where the percentage increases with subspace dimensionality.") public class ProgressiveEigenPairFilter implements EigenPairFilter { /** - * Parameter progressive alpha. - */ - public static final OptionID EIGENPAIR_FILTER_PALPHA = new OptionID("pca.filter.progressivealpha", "The share (0.0 to 1.0) of variance that needs to be explained by the 'strong' eigenvectors." + "The filter class will choose the number of strong eigenvectors by this share."); - - /** * The default value for alpha. */ public static final double DEFAULT_PALPHA = 0.5; @@ -110,7 +106,7 @@ public class ProgressiveEigenPairFilter implements EigenPairFilter { /** * Constructor. - * + * * @param palpha palpha * @param walpha walpha */ @@ -177,13 +173,18 @@ public class ProgressiveEigenPairFilter implements EigenPairFilter { /** * Parameterization class. - * + * * @author Erich Schubert - * + * * @apiviz.exclude */ public static class Parameterizer extends AbstractParameterizer { /** + * Parameter progressive alpha. + */ + public static final OptionID EIGENPAIR_FILTER_PALPHA = new OptionID("pca.filter.progressivealpha", "The share (0.0 to 1.0) of variance that needs to be explained by the 'strong' eigenvectors." + "The filter class will choose the number of strong eigenvectors by this share."); + + /** * The threshold for strong eigenvectors: the strong eigenvectors explain a * portion of at least alpha of the total variance. */ @@ -204,7 +205,7 @@ public class ProgressiveEigenPairFilter implements EigenPairFilter { palpha = palphaP.getValue(); } - DoubleParameter walphaP = new DoubleParameter(WeakEigenPairFilter.EIGENPAIR_FILTER_WALPHA, DEFAULT_WALPHA); + DoubleParameter walphaP = new DoubleParameter(WeakEigenPairFilter.Parameterizer.EIGENPAIR_FILTER_WALPHA, DEFAULT_WALPHA); walphaP.addConstraint(CommonConstraints.GREATER_EQUAL_ZERO_DOUBLE); if(config.grab(walphaP)) { walpha = walphaP.getValue(); diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/RANSACCovarianceMatrixBuilder.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/RANSACCovarianceMatrixBuilder.java index 291f91b6..5553936b 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/RANSACCovarianceMatrixBuilder.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/RANSACCovarianceMatrixBuilder.java @@ -74,6 +74,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.RandomParameter; * </p> * * @author Erich Schubert + * @since 0.5.5 */ @Reference(authors = "Hans-Peter Kriegel, Peer Kröger, Erich Schubert, Arthur Zimek", // title = "Outlier Detection in Arbitrarily Oriented Subspaces", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/RelativeEigenPairFilter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/RelativeEigenPairFilter.java index 54361c4f..3011a7d8 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/RelativeEigenPairFilter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/RelativeEigenPairFilter.java @@ -50,16 +50,12 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * dimensionalities. * * @author Erich Schubert + * @since 0.2 */ @Title("Relative EigenPair Filter") @Description("Sorts the eigenpairs in decending order of their eigenvalues and returns those eigenpairs, whose eigenvalue is " + "above the average ('expected') eigenvalue of the remaining eigenvectors.") public class RelativeEigenPairFilter implements EigenPairFilter { /** - * Parameter relative alpha. - */ - public static final OptionID EIGENPAIR_FILTER_RALPHA = new OptionID("pca.filter.relativealpha", "The sensitivity niveau for weak eigenvectors: An eigenvector which is at less than " + "the given share of the statistical average variance is considered weak."); - - /** * The default value for ralpha. */ public static final double DEFAULT_RALPHA = 1.1; @@ -123,6 +119,10 @@ public class RelativeEigenPairFilter implements EigenPairFilter { * @apiviz.exclude */ public static class Parameterizer extends AbstractParameterizer { + /** + * Parameter relative alpha. + */ + public static final OptionID EIGENPAIR_FILTER_RALPHA = new OptionID("pca.filter.relativealpha", "The sensitivity niveau for weak eigenvectors: An eigenvector which is at less than " + "the given share of the statistical average variance is considered weak."); protected double ralpha; @Override diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/SignificantEigenPairFilter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/SignificantEigenPairFilter.java index dfc5347d..64dac360 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/SignificantEigenPairFilter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/SignificantEigenPairFilter.java @@ -39,18 +39,19 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * The SignificantEigenPairFilter sorts the eigenpairs in descending order of * their eigenvalues and chooses the contrast of an Eigenvalue to the remaining * Eigenvalues is maximal. - * + * * It is closely related to the WeakEigenPairFilter and RelativeEigenPairFilter. * But while the RelativeEigenPairFilter chooses the highest dimensionality that * satisfies the relative alpha levels, the SignificantEigenPairFilter will * chose the local dimensionality such that the 'contrast' is maximal. - * + * * There are some situations where one or the other is superior, especially when * it comes to handling nested clusters and strong global correlations that are * not too interesting. These benefits usually only make a difference at higher * dimensionalities. - * + * * @author Erich Schubert + * @since 0.2 */ @Title("Significant EigenPair Filter") @Description("Sorts the eigenpairs in decending order of their eigenvalues and looks for the maxmimum contrast of current Eigenvalue / average of remaining Eigenvalues.") @@ -68,7 +69,7 @@ public class SignificantEigenPairFilter implements EigenPairFilter { /** * Constructor. - * + * * @param walpha */ public SignificantEigenPairFilter(double walpha) { @@ -122,9 +123,9 @@ public class SignificantEigenPairFilter implements EigenPairFilter { /** * Parameterization class. - * + * * @author Erich Schubert - * + * * @apiviz.exclude */ public static class Parameterizer extends AbstractParameterizer { @@ -133,7 +134,7 @@ public class SignificantEigenPairFilter implements EigenPairFilter { @Override protected void makeOptions(Parameterization config) { super.makeOptions(config); - DoubleParameter walphaP = new DoubleParameter(WeakEigenPairFilter.EIGENPAIR_FILTER_WALPHA, DEFAULT_WALPHA); + DoubleParameter walphaP = new DoubleParameter(WeakEigenPairFilter.Parameterizer.EIGENPAIR_FILTER_WALPHA, DEFAULT_WALPHA); walphaP.addConstraint(CommonConstraints.GREATER_EQUAL_ZERO_DOUBLE); if(config.grab(walphaP)) { walpha = walphaP.getValue(); diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/StandardCovarianceMatrixBuilder.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/StandardCovarianceMatrixBuilder.java index 677a88eb..ea1a6787 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/StandardCovarianceMatrixBuilder.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/StandardCovarianceMatrixBuilder.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.math.linearalgebra.Matrix; * Reasonable default choice for a {@link CovarianceMatrixBuilder} * * @author Erich Schubert + * @since 0.2 * * @apiviz.uses CovarianceMatrix */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/WeakEigenPairFilter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/WeakEigenPairFilter.java index 51d89450..8f76531e 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/WeakEigenPairFilter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/WeakEigenPairFilter.java @@ -42,19 +42,12 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * as "strong", the others as "weak". * * @author Erich Schubert + * @since 0.2 */ @Title("Weak Eigenpair Filter") @Description("Sorts the eigenpairs in decending order of their eigenvalues and returns those eigenpairs, whose eigenvalue is above the average ('expected') eigenvalue.") public class WeakEigenPairFilter implements EigenPairFilter { /** - * OptionID for the weak alpha value of {@link WeakEigenPairFilter}, - * {@link de.lmu.ifi.dbs.elki.math.linearalgebra.pca.ProgressiveEigenPairFilter} - * and - * {@link de.lmu.ifi.dbs.elki.math.linearalgebra.pca.SignificantEigenPairFilter} - */ - public static final OptionID EIGENPAIR_FILTER_WALPHA = new OptionID("pca.filter.weakalpha", "The minimum strength of the statistically expected variance (1/n) share an eigenvector " + "needs to have to be considered 'strong'."); - - /** * The default value for walpha. */ public static final double DEFAULT_WALPHA = 0.95; @@ -119,6 +112,13 @@ public class WeakEigenPairFilter implements EigenPairFilter { */ public static class Parameterizer extends AbstractParameterizer { /** + * OptionID for the weak alpha value of {@link WeakEigenPairFilter}, + * {@link de.lmu.ifi.dbs.elki.math.linearalgebra.pca.ProgressiveEigenPairFilter} + * and + * {@link de.lmu.ifi.dbs.elki.math.linearalgebra.pca.SignificantEigenPairFilter} + */ + public static final OptionID EIGENPAIR_FILTER_WALPHA = new OptionID("pca.filter.weakalpha", "The minimum strength of the statistically expected variance (1/n) share an eigenvector " + "needs to have to be considered 'strong'."); + /** * The threshold for strong eigenvectors: the strong eigenvectors explain a * portion of at least alpha of the total variance. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/WeightedCovarianceMatrixBuilder.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/WeightedCovarianceMatrixBuilder.java index a5b7d545..eba61671 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/WeightedCovarianceMatrixBuilder.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/WeightedCovarianceMatrixBuilder.java @@ -60,6 +60,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ObjectParameter; * Computer Science 5069, Springer * * @author Erich Schubert + * @since 0.2 * * @apiviz.has WeightFunction * @apiviz.has PrimitiveDistanceFunction @@ -73,17 +74,6 @@ booktitle = "Proceedings of the 20th International Conference on Scientific and url = "http://dx.doi.org/10.1007/978-3-540-69497-7_27") public class WeightedCovarianceMatrixBuilder extends AbstractCovarianceMatrixBuilder { /** - * Parameter to specify the weight function to use in weighted PCA, must - * implement - * {@link de.lmu.ifi.dbs.elki.math.linearalgebra.pca.weightfunctions.WeightFunction} - * . - * <p> - * Key: {@code -pca.weight} - * </p> - */ - public static final OptionID WEIGHT_ID = new OptionID("pca.weight", "Weight function to use in weighted PCA."); - - /** * Holds the weight function. */ protected WeightFunction weightfunction; @@ -205,6 +195,16 @@ public class WeightedCovarianceMatrixBuilder extends AbstractCovarianceMatrixBui */ public static class Parameterizer extends AbstractParameterizer { /** + * Parameter to specify the weight function to use in weighted PCA, must + * implement + * {@link de.lmu.ifi.dbs.elki.math.linearalgebra.pca.weightfunctions.WeightFunction} + * . + * <p> + * Key: {@code -pca.weight} + * </p> + */ + public static final OptionID WEIGHT_ID = new OptionID("pca.weight", "Weight function to use in weighted PCA."); + /** * Weight function. */ protected WeightFunction weightfunction = null; diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ConstantWeight.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ConstantWeight.java index 693cdb2e..71ae52ed 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ConstantWeight.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ConstantWeight.java @@ -30,6 +30,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra.pca.weightfunctions; * The result is always 1.0 * * @author Erich Schubert + * @since 0.2 */ public final class ConstantWeight implements WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ErfcStddevWeight.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ErfcStddevWeight.java index 03423603..76e24d18 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ErfcStddevWeight.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ErfcStddevWeight.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.math.statistics.distribution.NormalDistribution; * erfc(1 / sqrt(2) * distance / stddev) * * @author Erich Schubert + * @since 0.2 */ public final class ErfcStddevWeight implements WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ErfcWeight.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ErfcWeight.java index b7bc1c67..11acb0af 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ErfcWeight.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ErfcWeight.java @@ -35,6 +35,7 @@ import de.lmu.ifi.dbs.elki.math.statistics.distribution.NormalDistribution; * scaling. * * @author Erich Schubert + * @since 0.2 */ public final class ErfcWeight implements WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ExponentialStddevWeight.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ExponentialStddevWeight.java index 3b265d47..fce17896 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ExponentialStddevWeight.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ExponentialStddevWeight.java @@ -34,6 +34,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra.pca.weightfunctions; * not squared. * * @author Erich Schubert + * @since 0.2 */ public final class ExponentialStddevWeight implements WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ExponentialWeight.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ExponentialWeight.java index c67e35d7..c45d5cac 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ExponentialWeight.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/ExponentialWeight.java @@ -36,6 +36,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra.pca.weightfunctions; * -2.3025850929940455 is log(-.1) to achieve the intended range of 1.0 - 0.1 * * @author Erich Schubert + * @since 0.2 */ public final class ExponentialWeight implements WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/GaussStddevWeight.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/GaussStddevWeight.java index bf78b576..d8f67639 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/GaussStddevWeight.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/GaussStddevWeight.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.math.MathUtil; * with factor being 1 / sqrt(2 * PI) * * @author Erich Schubert + * @since 0.2 */ public final class GaussStddevWeight implements WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/GaussWeight.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/GaussWeight.java index fcad89a3..70826d0e 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/GaussWeight.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/GaussWeight.java @@ -31,6 +31,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra.pca.weightfunctions; * exp(-2.3025850929940455 * (distance/max)^2) * * @author Erich Schubert + * @since 0.2 */ public final class GaussWeight implements WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/InverseLinearWeight.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/InverseLinearWeight.java index 3fb8e9e0..f2c27d5a 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/InverseLinearWeight.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/InverseLinearWeight.java @@ -33,6 +33,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra.pca.weightfunctions; * This function has increasing weight, from 0.1 to 1.0 at distance == max. * * @author Erich Schubert + * @since 0.2 */ public final class InverseLinearWeight implements WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/InverseProportionalStddevWeight.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/InverseProportionalStddevWeight.java index a4d4a28e..952e7a56 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/InverseProportionalStddevWeight.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/InverseProportionalStddevWeight.java @@ -30,6 +30,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra.pca.weightfunctions; * 1 / (1 + distance/stddev) * * @author Erich Schubert + * @since 0.2 */ public final class InverseProportionalStddevWeight implements WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/InverseProportionalWeight.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/InverseProportionalWeight.java index fb1d71ba..810d17a9 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/InverseProportionalWeight.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/InverseProportionalWeight.java @@ -30,6 +30,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra.pca.weightfunctions; * 1 / (1 + distance/max) * * @author Erich Schubert + * @since 0.2 */ public final class InverseProportionalWeight implements WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/LinearWeight.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/LinearWeight.java index a37617b5..bc92660e 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/LinearWeight.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/LinearWeight.java @@ -31,6 +31,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra.pca.weightfunctions; * 1 - 0.9 * (distance/max) * * @author Erich Schubert + * @since 0.2 */ public final class LinearWeight implements WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/QuadraticStddevWeight.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/QuadraticStddevWeight.java index e35e9a67..c02d78f1 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/QuadraticStddevWeight.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/QuadraticStddevWeight.java @@ -33,6 +33,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra.pca.weightfunctions; * max(0.0, 1.0 - (distance/(3*stddev))^2 * * @author Erich Schubert + * @since 0.2 */ public final class QuadraticStddevWeight implements WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/QuadraticWeight.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/QuadraticWeight.java index 87bd552b..d764ef08 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/QuadraticWeight.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/QuadraticWeight.java @@ -31,6 +31,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra.pca.weightfunctions; * 1.0 - 0.9 * (distance/max)^2 * * @author Erich Schubert + * @since 0.2 */ public final class QuadraticWeight implements WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/WeightFunction.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/WeightFunction.java index 49bced02..afc04fb9 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/WeightFunction.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/pca/weightfunctions/WeightFunction.java @@ -30,6 +30,7 @@ package de.lmu.ifi.dbs.elki.math.linearalgebra.pca.weightfunctions; * normalized according to the maximum or standard deviation. * * @author Erich Schubert + * @since 0.2 */ public interface WeightFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/AbstractRandomProjectionFamily.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/AbstractRandomProjectionFamily.java index 00597ac2..7ce235de 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/AbstractRandomProjectionFamily.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/AbstractRandomProjectionFamily.java @@ -40,6 +40,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.RandomParameter; * Abstract base class for random projection families. * * @author Erich Schubert + * @since 0.3 */ public abstract class AbstractRandomProjectionFamily implements RandomProjectionFamily { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/AchlioptasRandomProjectionFamily.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/AchlioptasRandomProjectionFamily.java index e3504419..4c74bbfb 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/AchlioptasRandomProjectionFamily.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/AchlioptasRandomProjectionFamily.java @@ -45,6 +45,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * TODO: faster implementation exploiting sparsity. * * @author Erich Schubert + * @since 0.6.0 */ @Reference(title = "Database-friendly random projections: Johnson-Lindenstrauss with binary coins", // authors = "D. Achlioptas", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/CauchyRandomProjectionFamily.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/CauchyRandomProjectionFamily.java index 699478ac..47fddeab 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/CauchyRandomProjectionFamily.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/CauchyRandomProjectionFamily.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * </p> * * @author Erich Schubert + * @since 0.6.0 */ @Reference(authors = "M. Datar and N. Immorlica and P. Indyk and V. S. Mirrokni", // title = "Locality-sensitive hashing scheme based on p-stable distributions", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/GaussianRandomProjectionFamily.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/GaussianRandomProjectionFamily.java index facfe427..e5277d5e 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/GaussianRandomProjectionFamily.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/GaussianRandomProjectionFamily.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * </p> * * @author Erich Schubert + * @since 0.6.0 */ @Reference(authors = "M. Datar and N. Immorlica and P. Indyk and V. S. Mirrokni", // title = "Locality-sensitive hashing scheme based on p-stable distributions", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/RandomProjectionFamily.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/RandomProjectionFamily.java index 95a59276..e97e32f6 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/RandomProjectionFamily.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/RandomProjectionFamily.java @@ -29,6 +29,7 @@ import de.lmu.ifi.dbs.elki.data.NumberVector; * Interface for random projection families. * * @author Erich Schubert + * @since 0.2 * * @apiviz.has Projection */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/RandomSubsetProjectionFamily.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/RandomSubsetProjectionFamily.java index dae7e0cb..15ecfec4 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/RandomSubsetProjectionFamily.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/RandomSubsetProjectionFamily.java @@ -46,6 +46,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * </p> * * @author Erich Schubert + * @since 0.6.0 */ @Reference(authors = "L. Breiman", // title = "Bagging predictors", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/SimplifiedRandomHyperplaneProjectionFamily.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/SimplifiedRandomHyperplaneProjectionFamily.java index 5a505f66..3916659a 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/SimplifiedRandomHyperplaneProjectionFamily.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/linearalgebra/randomprojections/SimplifiedRandomHyperplaneProjectionFamily.java @@ -48,6 +48,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * * @author Evgeniy Faerman * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "M. Henzinger", // title = "Finding near-duplicate web pages: a large-scale evaluation of algorithms", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/FastNonThreadsafeRandom.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/FastNonThreadsafeRandom.java index 72f6be0b..a3632102 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/FastNonThreadsafeRandom.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/FastNonThreadsafeRandom.java @@ -29,6 +29,7 @@ import java.util.Random; * seeds. This implementation is <em>no longer thread-safe</em> (but faster)! * * @author Erich Schubert + * @since 0.6.0 */ public class FastNonThreadsafeRandom extends Random { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/RandomFactory.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/RandomFactory.java index ca8f5a36..c75ac19b 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/RandomFactory.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/RandomFactory.java @@ -36,6 +36,7 @@ import java.util.Random; * scientific experiments are not likely to be adversarial. * * @author Erich Schubert + * @since 0.5.5 * * @apiviz.has Random * @apiviz.has FastNonThreadsafeRandom @@ -44,7 +45,12 @@ public class RandomFactory { /** * Global default factory */ - public static RandomFactory DEFAULT = new RandomFactory(getGlobalSeed()); + public static RandomFactory DEFAULT = new RandomFactory(getGlobalSeed()) { + @Override + public String toString() { + return "GlobalRandom[" + Long.toString(this.seed) + "]"; + } + }; /** * Initialize the default random. @@ -59,7 +65,7 @@ public class RandomFactory { /** * Seed. */ - private long seed; + protected long seed; /** * Factory method: Get a random factory for the given seed. @@ -101,4 +107,9 @@ public class RandomFactory { public Random getSingleThreadedRandom() { return new FastNonThreadsafeRandom(seed++); } + + @Override + public String toString() { + return "Random[" + Long.toString(seed) + "]"; + } }
\ No newline at end of file diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/XorShift1024NonThreadsafeRandom.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/XorShift1024NonThreadsafeRandom.java index 4cafbfba..e6d28167 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/XorShift1024NonThreadsafeRandom.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/XorShift1024NonThreadsafeRandom.java @@ -44,6 +44,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * </p> * * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "S. Vigna", // title = "An experimental exploration of Marsaglia's xorshift generators, scrambled", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/XorShift64NonThreadsafeRandom.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/XorShift64NonThreadsafeRandom.java index 4063fe03..7716d178 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/XorShift64NonThreadsafeRandom.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/random/XorShift64NonThreadsafeRandom.java @@ -44,6 +44,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * </p> * * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "S. Vigna", // title = "An experimental exploration of Marsaglia's xorshift generators, scrambled", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/scales/LinearScale.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/scales/LinearScale.java index 94aead3b..629ac96a 100755 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/scales/LinearScale.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/scales/LinearScale.java @@ -35,6 +35,7 @@ import java.util.Locale; * values. * * @author Erich Schubert + * @since 0.2 * */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/scales/Scales.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/scales/Scales.java index deb2a85c..7ed49882 100755 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/scales/Scales.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/scales/Scales.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.exceptions.AbortException; * able to automatically choose log scales when appropriate. * * @author Erich Schubert + * @since 0.2 * * @apiviz.has LinearScale oneway - - computes */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/AbstractSpatialSorter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/AbstractSpatialSorter.java index 8c5a580f..7a9e4d31 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/AbstractSpatialSorter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/AbstractSpatialSorter.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.data.spatial.SpatialComparable; * Abstract base class for spatial sorters, offering shared functionality. * * @author Erich Schubert + * @since 0.5.0 */ public abstract class AbstractSpatialSorter implements SpatialSorter { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/BinarySplitSpatialSorter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/BinarySplitSpatialSorter.java index a1b8ea9b..e549c072 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/BinarySplitSpatialSorter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/BinarySplitSpatialSorter.java @@ -47,6 +47,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * </p> * * @author Erich Schubert + * @since 0.5.0 */ @Reference(authors = "J. L. Bentley", title = "Multidimensional binary search trees used for associative searching", booktitle = "Communications of the ACM, Vol. 18 Issue 9, Sept. 1975", url = "http://dx.doi.org/10.1145/361002.361007") public class BinarySplitSpatialSorter extends AbstractSpatialSorter { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/HilbertSpatialSorter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/HilbertSpatialSorter.java index f3207233..b8eebf17 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/HilbertSpatialSorter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/HilbertSpatialSorter.java @@ -44,6 +44,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * </p> * * @author Erich Schubert + * @since 0.5.0 * * @apiviz.composedOf HilbertRef */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/PeanoSpatialSorter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/PeanoSpatialSorter.java index 490c9470..2b9f6982 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/PeanoSpatialSorter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/PeanoSpatialSorter.java @@ -31,9 +31,9 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; /** * Bulk-load an R-tree index by presorting the objects with their position on * the Peano curve. - * + * * The basic shape of this space-filling curve looks like this: - * + * * <pre> * 3---4 9 * | | | @@ -41,14 +41,14 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * | | | * 1 6---7 * </pre> - * + * * Which then expands to the next level as: - * + * * <pre> * +-+ +-+ +-+ +-+ E * | | | | | | | | | * | +-+ +-+ | | +-+ - * | | | + * | | | * | +-+ +-+ | | +-+ * | | | | | | | | | * +-+ | | +-+ +-+ | @@ -57,19 +57,22 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * | | | | | | | | | * S +-+ +-+ +-+ +-+ * </pre> - * + * * and so on. - * + * * Reference: * <p> * G. Peano<br /> * Sur une courbe, qui remplit toute une aire plane<br /> * Mathematische Annalen, 36(1) * </p> - * + * * @author Erich Schubert + * @since 0.5.0 */ -@Reference(authors = "G. Peano", title = "Sur une courbe, qui remplit toute une aire plane", booktitle = "Mathematische Annalen, 36(1)") +@Reference(authors = "G. Peano", // +title = "Sur une courbe, qui remplit toute une aire plane", // +booktitle = "Mathematische Annalen, 36(1)") public class PeanoSpatialSorter extends AbstractSpatialSorter { /** * Constructor. @@ -80,12 +83,12 @@ public class PeanoSpatialSorter extends AbstractSpatialSorter { @Override public <T extends SpatialComparable> void sort(List<T> objs, int start, int end, double[] minmax, int[] dims) { - peanoSort(objs, start, end, minmax, dims, 0, BitsUtil.zero(dims.length), false); + peanoSort(objs, start, end, minmax, dims, 0, BitsUtil.zero(minmax.length >> 1), false); } /** * Sort by Peano curve. - * + * * @param objs Objects * @param start Start index * @param end End diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/SpatialSorter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/SpatialSorter.java index 0745729c..14139f97 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/SpatialSorter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/SpatialSorter.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.data.spatial.SpatialComparable; * Interface for spatial sorting - ZCurves, Peano curves, Hilbert curves, ... * * @author Erich Schubert + * @since 0.5.0 */ public interface SpatialSorter { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/ZCurveSpatialSorter.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/ZCurveSpatialSorter.java index d5fd10cf..08b68c5f 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/ZCurveSpatialSorter.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/ZCurveSpatialSorter.java @@ -32,6 +32,7 @@ import de.lmu.ifi.dbs.elki.data.spatial.SpatialComparable; * materialization of the Z indexes. * * @author Erich Schubert + * @since 0.5.0 */ public class ZCurveSpatialSorter extends AbstractSpatialSorter { private static final double STOPVAL = 1E-10; diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/ZCurveTransformer.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/ZCurveTransformer.java index 29c8ae72..94a6b12c 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/ZCurveTransformer.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/spacefillingcurves/ZCurveTransformer.java @@ -35,6 +35,7 @@ import de.lmu.ifi.dbs.elki.database.relation.RelationUtil; * Class to transform a relation to its Z coordinates. * * @author Erich Schubert + * @since 0.5.0 */ public class ZCurveTransformer { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/KernelDensityEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/KernelDensityEstimator.java index 52087f8e..20f3bee0 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/KernelDensityEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/KernelDensityEstimator.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.math.statistics.kernelfunctions.KernelDensityFunction * Estimates a density using a variable width kernel density estimation. * * @author Erich Schubert + * @since 0.2 * * @apiviz.uses KernelDensityFunction */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/LinearRegression.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/LinearRegression.java index d6818129..faee3050 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/LinearRegression.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/LinearRegression.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.utilities.pairs.DoubleDoublePair; /** * * @author Arthur Zimek + * @since 0.2 */ // TODO: arthur comment // TODO: use covariance matrix, add incremental API? diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/MultipleLinearRegression.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/MultipleLinearRegression.java index 45aad7a2..42bbc712 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/MultipleLinearRegression.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/MultipleLinearRegression.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.FormatUtil; * is defined to be y = b0 + b1*x1 + b2*x2 + ... + bp*xp + e. * * @author Elke Achtert + * @since 0.2 */ public class MultipleLinearRegression { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/PolynomialRegression.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/PolynomialRegression.java index 53f02d19..3ccc5453 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/PolynomialRegression.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/PolynomialRegression.java @@ -43,6 +43,7 @@ import de.lmu.ifi.dbs.elki.math.linearalgebra.Vector; * + b1*x1 + b2*x2 + ... + bp*xp + e * * @author Elke Achtert + * @since 0.2 */ public class PolynomialRegression extends MultipleLinearRegression { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/ProbabilityWeightedMoments.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/ProbabilityWeightedMoments.java index 30357c9c..382600d7 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/ProbabilityWeightedMoments.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/ProbabilityWeightedMoments.java @@ -45,6 +45,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * </p> * * @author Erich Schubert + * @since 0.6.0 */ @Reference(authors = "J.R.M. Hosking, J. R. Wallis, and E. F. Wood", title = "Estimation of the generalized extreme-value distribution by the method of probability-weighted moments.", booktitle = "Technometrics 27.3", url = "http://dx.doi.org/10.1080/00401706.1985.10488049") public class ProbabilityWeightedMoments { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/AbstractDependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/AbstractDependenceMeasure.java index 2b76b7fe..2c177328 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/AbstractDependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/AbstractDependenceMeasure.java @@ -38,6 +38,7 @@ import de.lmu.ifi.dbs.elki.utilities.exceptions.AbortException; * Abstract base class for dependence measures. * * @author Erich Schubert + * @since 0.7.0 */ public abstract class AbstractDependenceMeasure implements DependenceMeasure { // In your subclass, you will need to implement at least this method: diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/CorrelationDependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/CorrelationDependenceMeasure.java index e2d434b5..b67757ee 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/CorrelationDependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/CorrelationDependenceMeasure.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Pearson product-moment correlation coefficient. * * @author Erich Schubert + * @since 0.7.0 */ public class CorrelationDependenceMeasure extends AbstractDependenceMeasure { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/DependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/DependenceMeasure.java index 10bd7565..be2741fe 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/DependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/DependenceMeasure.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.NumberArrayAdapter * Measure the dependence of two variables. * * @author Erich Schubert + * @since 0.5.0 */ public interface DependenceMeasure { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/DistanceCorrelationDependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/DistanceCorrelationDependenceMeasure.java index 289c0045..c1fdac6a 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/DistanceCorrelationDependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/DistanceCorrelationDependenceMeasure.java @@ -48,6 +48,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Marie Kiermeier * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "Székely, G. J., Rizzo, M. L., & Bakirov, N. K.", // title = "Measuring and testing dependence by correlation of distances", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/HSMDependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/HSMDependenceMeasure.java index b90dbc22..6adf498c 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/HSMDependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/HSMDependenceMeasure.java @@ -44,6 +44,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Erich Schubert * @author Robert Rödler + * @since 0.5.5 */ @Reference(authors = "A. Tatu, G. Albuquerque, M. Eisemann, P. Bak, H. Theisel, M. A. Magnor, and D. A. Keim", // title = "Automated Analytical Methods to Support Visual Exploration of High-Dimensional Data", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/HiCSDependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/HiCSDependenceMeasure.java index ea06698f..335c0182 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/HiCSDependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/HiCSDependenceMeasure.java @@ -63,6 +63,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.RandomParameter; * * @author Erich Schubert * @author Robert Rödler + * @since 0.7.0 */ @Reference(authors = "Elke Achtert, Hans-Peter Kriegel, Erich Schubert, Arthur Zimek", // title = "Interactive Data Mining with 3D-Parallel-Coordinate-Trees", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/HoeffdingsDDependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/HoeffdingsDDependenceMeasure.java index 63f618cc..6fc96223 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/HoeffdingsDDependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/HoeffdingsDDependenceMeasure.java @@ -42,6 +42,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Yinchong Yang * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "W. Hoeffding", // title = "A non-parametric test of independence", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/JensenShannonEquiwidthDependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/JensenShannonEquiwidthDependenceMeasure.java index e988100d..3d0d779a 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/JensenShannonEquiwidthDependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/JensenShannonEquiwidthDependenceMeasure.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * TODO: Offer normalized and non-normalized variants? * * @author Erich Schubert + * @since 0.7.0 */ public class JensenShannonEquiwidthDependenceMeasure extends AbstractDependenceMeasure { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/MCEDependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/MCEDependenceMeasure.java index 471c1135..6058adec 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/MCEDependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/MCEDependenceMeasure.java @@ -46,6 +46,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "D. Guo", // title = "Coordinating computational and visual approaches for interactive feature selection and multivariate clustering", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/MutualInformationEquiwidthDependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/MutualInformationEquiwidthDependenceMeasure.java index c1aa786d..e4145704 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/MutualInformationEquiwidthDependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/MutualInformationEquiwidthDependenceMeasure.java @@ -40,6 +40,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * For a median-based discretization, see {@link MCEDependenceMeasure}. * * @author Erich Schubert + * @since 0.7.0 */ public class MutualInformationEquiwidthDependenceMeasure extends AbstractDependenceMeasure { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SURFINGDependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SURFINGDependenceMeasure.java index c37ad125..9019e087 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SURFINGDependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SURFINGDependenceMeasure.java @@ -59,6 +59,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Robert Rödler * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "Elke Achtert, Hans-Peter Kriegel, Erich Schubert, Arthur Zimek", // title = "Interactive Data Mining with 3D-Parallel-Coordinate-Trees", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SlopeDependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SlopeDependenceMeasure.java index a5f7e60e..b3cc9e39 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SlopeDependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SlopeDependenceMeasure.java @@ -42,6 +42,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Erich Schubert * @author Robert Rödler + * @since 0.7.0 */ @Reference(authors = "Elke Achtert, Hans-Peter Kriegel, Erich Schubert, Arthur Zimek", // title = "Interactive Data Mining with 3D-Parallel-Coordinate-Trees", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SlopeInversionDependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SlopeInversionDependenceMeasure.java index f99984c8..0aa62ad7 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SlopeInversionDependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SlopeInversionDependenceMeasure.java @@ -42,6 +42,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Erich Schubert * @author Robert Rödler + * @since 0.7.0 */ @Reference(authors = "Elke Achtert, Hans-Peter Kriegel, Erich Schubert, Arthur Zimek", // title = "Interactive Data Mining with 3D-Parallel-Coordinate-Trees", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SpearmanCorrelationDependenceMeasure.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SpearmanCorrelationDependenceMeasure.java index 3a6a162f..3942e7e1 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SpearmanCorrelationDependenceMeasure.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/dependence/SpearmanCorrelationDependenceMeasure.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Spearman rank-correlation coefficient, also known as Spearmans Rho. * * @author Erich Schubert + * @since 0.7.0 */ public class SpearmanCorrelationDependenceMeasure extends AbstractDependenceMeasure { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/AbstractDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/AbstractDistribution.java index ef3e1dff..e7ed8a6f 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/AbstractDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/AbstractDistribution.java @@ -35,6 +35,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.RandomParameter; * Abstract base class for distributions. * * @author Erich Schubert + * @since 0.6.0 */ public abstract class AbstractDistribution implements Distribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/BetaDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/BetaDistribution.java index 374ca717..d8242c0d 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/BetaDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/BetaDistribution.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * * @author Jan Brusis * @author Erich Schubert + * @since 0.5.0 */ public class BetaDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/CauchyDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/CauchyDistribution.java index 808c3b00..c5edbfb6 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/CauchyDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/CauchyDistribution.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Cauchy distribution. * * @author Erich Schubert + * @since 0.6.0 */ public class CauchyDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ChiDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ChiDistribution.java index 5bbcbe2b..2cc397bf 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ChiDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ChiDistribution.java @@ -35,6 +35,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Chi distribution. * * @author Erich Schubert + * @since 0.5.0 * * @apiviz.composedOf ChiSquaredDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ChiSquaredDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ChiSquaredDistribution.java index 28ccdc4b..ae6ad53b 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ChiSquaredDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ChiSquaredDistribution.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Chi-Squared distribution (a specialization of the Gamma distribution). * * @author Erich Schubert + * @since 0.2 */ public class ChiSquaredDistribution extends GammaDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ConstantDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ConstantDistribution.java index c0bb98e8..10f5f377 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ConstantDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ConstantDistribution.java @@ -32,6 +32,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Pseudo distribution, that has a unique constant value. * * @author Erich Schubert + * @since 0.5.0 */ public class ConstantDistribution implements Distribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/Distribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/Distribution.java index 9edf4b68..84cd64e8 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/Distribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/Distribution.java @@ -28,6 +28,7 @@ package de.lmu.ifi.dbs.elki.math.statistics.distribution; * Statistical distributions, with their common functions. * * @author Erich Schubert + * @since 0.2 */ public interface Distribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ExponentialDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ExponentialDistribution.java index 828416d7..055d4e1f 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ExponentialDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ExponentialDistribution.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Exponential distribution. * * @author Erich Schubert + * @since 0.5.5 */ public class ExponentialDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ExponentiallyModifiedGaussianDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ExponentiallyModifiedGaussianDistribution.java index a764e304..f373d219 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ExponentiallyModifiedGaussianDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/ExponentiallyModifiedGaussianDistribution.java @@ -38,6 +38,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * is a combination of a normal distribution and an exponential distribution. * * @author Erich Schubert + * @since 0.6.0 */ @Alias({ "exgaussian" }) public class ExponentiallyModifiedGaussianDistribution extends AbstractDistribution { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GammaDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GammaDistribution.java index 92af5a88..c6573016 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GammaDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GammaDistribution.java @@ -28,6 +28,7 @@ import java.util.Random; import de.lmu.ifi.dbs.elki.logging.LoggingUtil; import de.lmu.ifi.dbs.elki.math.MathUtil; import de.lmu.ifi.dbs.elki.math.random.RandomFactory; +import de.lmu.ifi.dbs.elki.utilities.Alias; import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; import de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionID; import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.Parameterization; @@ -37,7 +38,9 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Gamma Distribution, with random generation and density functions. * * @author Erich Schubert + * @since 0.4.0 */ +@Alias("de.lmu.ifi.dbs.elki.data.synthetic.bymodel.distribution.GammaDistribution") public class GammaDistribution extends AbstractDistribution { /** * Euler–Mascheroni constant diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedExtremeValueDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedExtremeValueDistribution.java index dea33d54..ff2d8b2d 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedExtremeValueDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedExtremeValueDistribution.java @@ -40,6 +40,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * from the scipy definition by having the negative shape. * * @author Erich Schubert + * @since 0.6.0 */ public class GeneralizedExtremeValueDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedLogisticAlternateDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedLogisticAlternateDistribution.java index 3c4eb761..6000a1b2 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedLogisticAlternateDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedLogisticAlternateDistribution.java @@ -36,6 +36,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Where {@code shape=0} yields the regular logistic distribution. * * @author Erich Schubert + * @since 0.6.0 */ public class GeneralizedLogisticAlternateDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedLogisticDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedLogisticDistribution.java index 6cb53dc9..162b47ea 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedLogisticDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedLogisticDistribution.java @@ -40,6 +40,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Where {@code shape=1} yields the regular logistic distribution. * * @author Erich Schubert + * @since 0.6.0 */ public class GeneralizedLogisticDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedParetoDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedParetoDistribution.java index 1765ffb3..2e4a7505 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedParetoDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GeneralizedParetoDistribution.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * distributions. * * @author Erich Schubert + * @since 0.6.0 */ public class GeneralizedParetoDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GumbelDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GumbelDistribution.java index d5712582..81c0f45f 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GumbelDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/GumbelDistribution.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Gumbel distribution, also known as Log-Weibull distribution. * * @author Erich Schubert + * @since 0.6.0 */ public class GumbelDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/HaltonUniformDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/HaltonUniformDistribution.java index 242815b0..e021a6f1 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/HaltonUniformDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/HaltonUniformDistribution.java @@ -64,6 +64,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * for example by adding scrambling. * * @author Erich Schubert + * @since 0.5.5 */ @Reference(title = "Randomized halton sequences", authors = "Wang, X. and Hickernell, F.J.", booktitle = "Mathematical and Computer Modelling Vol. 32 (7)", url = "http://dx.doi.org/10.1016/S0895-7177(00)00178-3") public class HaltonUniformDistribution implements Distribution { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/KappaDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/KappaDistribution.java index f9d723d8..81cc8191 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/KappaDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/KappaDistribution.java @@ -35,6 +35,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * TODO: add references. * * @author Erich Schubert + * @since 0.6.0 */ public class KappaDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LaplaceDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LaplaceDistribution.java index c3826cb3..92db5dd7 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LaplaceDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LaplaceDistribution.java @@ -35,6 +35,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Laplace distribution also known as double exponential distribution * * @author Erich Schubert + * @since 0.5.5 */ @Alias("DoubleExponentialDistribution") public class LaplaceDistribution extends AbstractDistribution { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogGammaAlternateDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogGammaAlternateDistribution.java index b7c38566..63f67adc 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogGammaAlternateDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogGammaAlternateDistribution.java @@ -39,6 +39,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Note: this matches the loggamma of SciPy. * * @author Erich Schubert + * @since 0.6.0 */ public class LogGammaAlternateDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogGammaDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogGammaDistribution.java index 60fa5292..f8796fe2 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogGammaDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogGammaDistribution.java @@ -38,6 +38,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Note: this is a different loggamma than scipy uses. * * @author Erich Schubert + * @since 0.6.0 */ public class LogGammaDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogLogisticDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogLogisticDistribution.java index c2dfcc64..c7cba5ac 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogLogisticDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogLogisticDistribution.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Log-Logistic distribution also known as Fisk distribution. * * @author Erich Schubert + * @since 0.6.0 */ @Alias({ "fisk", "loglog" }) public class LogLogisticDistribution extends AbstractDistribution { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogNormalDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogNormalDistribution.java index 86f2ea43..d5a2d099 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogNormalDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogNormalDistribution.java @@ -43,6 +43,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * <tt>scipy.stats.lognorm(logstddev, shift, math.exp(logmean))</tt> * * @author Erich Schubert + * @since 0.6.0 */ @Alias({ "lognormal" }) public class LogNormalDistribution extends AbstractDistribution { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogisticDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogisticDistribution.java index 6dcafddb..b8e4f5bc 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogisticDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/LogisticDistribution.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Logistic distribution. * * @author Erich Schubert + * @since 0.6.0 */ @Alias({ "log" }) public class LogisticDistribution extends AbstractDistribution { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/NormalDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/NormalDistribution.java index 56c14eca..126db305 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/NormalDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/NormalDistribution.java @@ -36,6 +36,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Gaussian distribution aka normal distribution * * @author Erich Schubert + * @since 0.5.0 */ @Alias({ "GaussianDistribution", "normal", "gauss" }) public class NormalDistribution extends AbstractDistribution { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/PoissonDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/PoissonDistribution.java index 59bb5ba7..a67fdde1 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/PoissonDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/PoissonDistribution.java @@ -47,6 +47,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.IntParameter; * </p> * * @author Erich Schubert + * @since 0.5.0 */ public class PoissonDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/RayleighDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/RayleighDistribution.java index 0ef431e0..832952e7 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/RayleighDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/RayleighDistribution.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Rayleigh distribution. * * @author Erich Schubert + * @since 0.6.0 */ public class RayleighDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/SkewGeneralizedNormalDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/SkewGeneralizedNormalDistribution.java index 8cfb3e38..0cb5bcd8 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/SkewGeneralizedNormalDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/SkewGeneralizedNormalDistribution.java @@ -40,6 +40,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * multiple that go by the name of a "Generalized Normal Distribution". * * @author Erich Schubert + * @since 0.6.0 */ public class SkewGeneralizedNormalDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/StudentsTDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/StudentsTDistribution.java index ced66f37..0bde3300 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/StudentsTDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/StudentsTDistribution.java @@ -38,6 +38,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.IntParameter; * FIXME: add quantile and random function! * * @author Jan Brusis + * @since 0.5.0 */ public class StudentsTDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/UniformDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/UniformDistribution.java index 875ee737..301dc8dd 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/UniformDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/UniformDistribution.java @@ -26,6 +26,7 @@ package de.lmu.ifi.dbs.elki.math.statistics.distribution; import java.util.Random; import de.lmu.ifi.dbs.elki.math.random.RandomFactory; +import de.lmu.ifi.dbs.elki.utilities.Alias; import de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionID; import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.Parameterization; import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; @@ -34,7 +35,9 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Uniform distribution. * * @author Erich Schubert + * @since 0.2 */ +@Alias("de.lmu.ifi.dbs.elki.data.synthetic.bymodel.distribution.UniformDistribution") public class UniformDistribution extends AbstractDistribution { /** * Minimum diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/WaldDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/WaldDistribution.java index b96f133e..11135fed 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/WaldDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/WaldDistribution.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Inverse Gaussian distribution aka Wald distribution * * @author Erich Schubert + * @since 0.6.0 */ @Alias({ "InverseGaussianDistribution", "invgauss" }) public class WaldDistribution extends AbstractDistribution { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/WeibullDistribution.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/WeibullDistribution.java index 86ac24d9..34791481 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/WeibullDistribution.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/WeibullDistribution.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter; * Weibull distribution. * * @author Erich Schubert + * @since 0.6.0 */ public class WeibullDistribution extends AbstractDistribution { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractExpMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractExpMADEstimator.java index 5ec6aaf3..6c08abd8 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractExpMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractExpMADEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.NumberArrayAdapter * Abstract base class for estimators based on the median and MAD. * * @author Erich Schubert + * @since 0.6.0 * * @param <D> Distribution to generate. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLMMEstimator.java index 03e21b13..86455d52 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLMMEstimator.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.NumberArrayAdapter * Abstract base class for L-Moments based estimators (LMM). * * @author Erich Schubert + * @since 0.5.0 * * @param <D> Distribution class. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLogMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLogMADEstimator.java index 8e6ca26d..170b4fab 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLogMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLogMADEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.NumberArrayAdapter * Abstract base class for estimators based on the median and MAD. * * @author Erich Schubert + * @since 0.6.0 * * @param <D> Distribution to generate. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLogMOMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLogMOMEstimator.java index ad260a6f..9d6e5983 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLogMOMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLogMOMEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.NumberArrayAdapter * Abstract base class for estimators based on the statistical moments. * * @author Erich Schubert + * @since 0.5.0 * * @param <D> Distribution to generate. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLogMeanVarianceEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLogMeanVarianceEstimator.java index b76176e4..464d7072 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLogMeanVarianceEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractLogMeanVarianceEstimator.java @@ -32,6 +32,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.NumberArrayAdapter * only). * * @author Erich Schubert + * @since 0.5.0 * * @param <D> Distribution to estimate. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractMADEstimator.java index 9c630990..746408bb 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractMADEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.NumberArrayAdapter * Abstract base class for estimators based on the median and MAD. * * @author Erich Schubert + * @since 0.6.0 * * @param <D> Distribution to generate. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractMOMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractMOMEstimator.java index 8caf4cda..d9ca2dff 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractMOMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractMOMEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.NumberArrayAdapter * Abstract base class for estimators based on the statistical moments. * * @author Erich Schubert + * @since 0.5.0 * * @param <D> Distribution to generate. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractMeanVarianceEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractMeanVarianceEstimator.java index e9058df4..20abf67d 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractMeanVarianceEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/AbstractMeanVarianceEstimator.java @@ -32,6 +32,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.NumberArrayAdapter * only). * * @author Erich Schubert + * @since 0.5.0 * * @param <D> Distribution to estimate. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/CauchyMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/CauchyMADEstimator.java index 9ced6b54..f4db08ff 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/CauchyMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/CauchyMADEstimator.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has CauchyDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/DistributionEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/DistributionEstimator.java index b31acf66..91d29c0e 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/DistributionEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/DistributionEstimator.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.NumberArrayAdapter * Estimate distribution parameters from a sample. * * @author Erich Schubert + * @since 0.5.0 * * @param <D> Distribution type */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/EMGOlivierNorbergEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/EMGOlivierNorbergEstimator.java index 38aa5380..f1fa5d95 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/EMGOlivierNorbergEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/EMGOlivierNorbergEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Naive distribution estimation using mean and sample variance. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has ExponentiallyModifiedGaussianDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExpMADDistributionEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExpMADDistributionEstimator.java index b2a935c2..51f5e46c 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExpMADDistributionEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExpMADDistributionEstimator.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.math.statistics.distribution.Distribution; * exponentiated data. * * @author Erich Schubert + * @since 0.5.0 * * @param <D> Distribution estimated. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialLMMEstimator.java index c33bbdfd..88ba769a 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialLMMEstimator.java @@ -40,6 +40,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has ExponentialDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialMADEstimator.java index e639dd63..6c2d21e0 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialMADEstimator.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has ExponentialDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialMOMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialMOMEstimator.java index cce8c503..726c85b8 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialMOMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialMOMEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * maximum-likelihood estimate (MLE), but not very robust. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has ExponentialDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialMedianEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialMedianEstimator.java index 0bda6711..17db5724 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialMedianEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/ExponentialMedianEstimator.java @@ -36,6 +36,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has ExponentialDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaChoiWetteEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaChoiWetteEstimator.java index 3714b89c..cc746ece 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaChoiWetteEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaChoiWetteEstimator.java @@ -39,6 +39,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has GammaDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaLMMEstimator.java index 8024a326..29f2af63 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaLMMEstimator.java @@ -39,6 +39,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has GammaDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaMADEstimator.java index 7032ede8..90076359 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaMADEstimator.java @@ -40,6 +40,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has GammaDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaMOMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaMOMEstimator.java index 11aeb527..346a0fd4 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaMOMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GammaMOMEstimator.java @@ -40,6 +40,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has GammaDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GeneralizedExtremeValueLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GeneralizedExtremeValueLMMEstimator.java index 1e60f8be..79020a59 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GeneralizedExtremeValueLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GeneralizedExtremeValueLMMEstimator.java @@ -42,6 +42,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has GeneralizedExtremeValueDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GeneralizedLogisticAlternateLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GeneralizedLogisticAlternateLMMEstimator.java index 1b9c3879..276f538a 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GeneralizedLogisticAlternateLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GeneralizedLogisticAlternateLMMEstimator.java @@ -39,6 +39,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has GeneralizedLogisticAlternateDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GeneralizedParetoLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GeneralizedParetoLMMEstimator.java index c32f1de0..aa999b1f 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GeneralizedParetoLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GeneralizedParetoLMMEstimator.java @@ -40,6 +40,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has GeneralizedParetoDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GumbelLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GumbelLMMEstimator.java index d721d083..2b29b079 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GumbelLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GumbelLMMEstimator.java @@ -41,6 +41,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has GumbelDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GumbelMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GumbelMADEstimator.java index 2e1b4f99..7e7cd8a9 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GumbelMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/GumbelMADEstimator.java @@ -38,6 +38,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has GumbelDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LMMDistributionEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LMMDistributionEstimator.java index 1480d96f..0118b403 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LMMDistributionEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LMMDistributionEstimator.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.math.statistics.distribution.Distribution; * (LMM). * * @author Erich Schubert + * @since 0.5.0 * * @param <D> Distribution class. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LaplaceLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LaplaceLMMEstimator.java index c9c6d0bb..dc63ed27 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LaplaceLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LaplaceLMMEstimator.java @@ -29,6 +29,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Estimate Laplace distribution parameters using the method of L-Moments (LMM). * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LaplaceDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LaplaceMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LaplaceMADEstimator.java index 63355fb5..c09ad3ca 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LaplaceMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LaplaceMADEstimator.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LaplaceDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LaplaceMLEEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LaplaceMLEEstimator.java index 42316b32..42f27d83 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LaplaceMLEEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LaplaceMLEEstimator.java @@ -41,6 +41,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LaplaceDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaAlternateExpMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaAlternateExpMADEstimator.java index 2b742ed2..43a2b83e 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaAlternateExpMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaAlternateExpMADEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * A modified algorithm for LogGamma distributions. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LogGammaAlternateDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaChoiWetteEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaChoiWetteEstimator.java index 80d02555..2f1577df 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaChoiWetteEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaChoiWetteEstimator.java @@ -42,6 +42,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LogGammaDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaLogMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaLogMADEstimator.java index db228b37..7458b485 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaLogMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaLogMADEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * A modified algorithm for LogGamma distributions. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LogGammaDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaLogMOMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaLogMOMEstimator.java index 193cc5ab..1e8c3b87 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaLogMOMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogGammaLogMOMEstimator.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * transformed values. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LogGammaDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogLogisticMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogLogisticMADEstimator.java index 942cb6af..a10ad4e4 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogLogisticMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogLogisticMADEstimator.java @@ -38,6 +38,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LogLogisticDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogMADDistributionEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogMADDistributionEstimator.java index 596315b3..d66d02a5 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogMADDistributionEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogMADDistributionEstimator.java @@ -29,6 +29,7 @@ import de.lmu.ifi.dbs.elki.math.statistics.distribution.Distribution; * Distribuition estimators that use the method of moments (MOM) in logspace. * * @author Erich Schubert + * @since 0.5.0 * * @param <D> Distribution estimated. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogMOMDistributionEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogMOMDistributionEstimator.java index bd9ec4b2..3e6d9896 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogMOMDistributionEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogMOMDistributionEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.math.statistics.distribution.Distribution; * i.e. that only need the statistical moments of a data set after logarithms. * * @author Erich Schubert + * @since 0.5.0 * * @param <D> Distribution estimated. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalBilkovaLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalBilkovaLMMEstimator.java index 4b6d62d5..658655dc 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalBilkovaLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalBilkovaLMMEstimator.java @@ -44,6 +44,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * generalized normal distribution, as used by Hosking. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LogNormalDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLMMEstimator.java index 57c5c745..854053c0 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLMMEstimator.java @@ -41,6 +41,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LogNormalDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLevenbergMarquardtKDEEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLevenbergMarquardtKDEEstimator.java index a8b84c1a..2c571e39 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLevenbergMarquardtKDEEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLevenbergMarquardtKDEEstimator.java @@ -44,6 +44,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * observed. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LogNormalDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLogMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLogMADEstimator.java index 11c3c7ed..2f7e3850 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLogMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLogMADEstimator.java @@ -46,6 +46,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LogNormalDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLogMOMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLogMOMEstimator.java index 6888e4ad..93ebdca3 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLogMOMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogNormalLogMOMEstimator.java @@ -32,6 +32,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * This is a maximum-likelihood-estimator (MLE). * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LogNormalDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogisticLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogisticLMMEstimator.java index 7c4f20be..30c85bb4 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogisticLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogisticLMMEstimator.java @@ -39,6 +39,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LogisticDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogisticMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogisticMADEstimator.java index 1524e698..7d56fc5d 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogisticMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/LogisticMADEstimator.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has LogisticDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/MADDistributionEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/MADDistributionEstimator.java index 80112d22..9ffb26fc 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/MADDistributionEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/MADDistributionEstimator.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.math.statistics.distribution.Distribution; * need the statistical moments of a data set. * * @author Erich Schubert + * @since 0.5.0 * * @param <D> Distribution estimated. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/MOMDistributionEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/MOMDistributionEstimator.java index a85dfbd2..1968ee63 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/MOMDistributionEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/MOMDistributionEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.math.statistics.distribution.Distribution; * need the statistical moments of a data set. * * @author Erich Schubert + * @since 0.5.0 * * @param <D> Distribution estimated. */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/MeanVarianceDistributionEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/MeanVarianceDistributionEstimator.java index 128f2ece..10c638d7 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/MeanVarianceDistributionEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/MeanVarianceDistributionEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.math.MeanVariance; * These can implicitely (obviously) also handle full statistical moments. * * @author Erich Schubert + * @since 0.5.0 * * @param <D> Distribution type */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalLMMEstimator.java index 0a569de5..96dcf336 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalLMMEstimator.java @@ -39,6 +39,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has NormalDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalLevenbergMarquardtKDEEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalLevenbergMarquardtKDEEstimator.java index 5f6e5672..54a83355 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalLevenbergMarquardtKDEEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalLevenbergMarquardtKDEEstimator.java @@ -44,6 +44,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * observed. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has NormalDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalMADEstimator.java index 6bb5a9ea..cdbebc5b 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalMADEstimator.java @@ -45,6 +45,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has NormalDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalMOMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalMOMEstimator.java index 7f5f179b..12aeaecf 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalMOMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/NormalMOMEstimator.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * extreme values. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has NormalDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/RayleighLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/RayleighLMMEstimator.java index a7afad4c..cd96506f 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/RayleighLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/RayleighLMMEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * the method of L-Moments (LMM). * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has RayleighDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/RayleighMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/RayleighMADEstimator.java index 39babfe4..bcd67e0d 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/RayleighMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/RayleighMADEstimator.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has RayleighDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/RayleighMLEEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/RayleighMLEEstimator.java index 4891f9bd..c0f54916 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/RayleighMLEEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/RayleighMLEEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * maximum likelihood estimate. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has RayleighDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/SkewGNormalLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/SkewGNormalLMMEstimator.java index 15e51d40..2000e841 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/SkewGNormalLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/SkewGNormalLMMEstimator.java @@ -41,6 +41,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has SkewGeneralizedNormalDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformEnhancedMinMaxEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformEnhancedMinMaxEstimator.java index 8b12ace1..b33b70da 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformEnhancedMinMaxEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformEnhancedMinMaxEstimator.java @@ -32,6 +32,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * enhances the interval appropriately. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has UniformDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformLMMEstimator.java index 5008eb85..c7134ee1 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformLMMEstimator.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * L-Moments (LMM). * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has UniformDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformMADEstimator.java index 781f72ec..29004489 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformMADEstimator.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has UniformDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformMinMaxEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformMinMaxEstimator.java index a40c4686..e140ec2c 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformMinMaxEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/UniformMinMaxEstimator.java @@ -32,6 +32,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Estimate the uniform distribution by computing min and max. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has UniformDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WaldMLEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WaldMLEstimator.java index d8147006..1088dd37 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WaldMLEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WaldMLEstimator.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Estimate parameter of the Wald distribution. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has WaldDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WaldMOMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WaldMOMEstimator.java index 1ccfdf08..da56827f 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WaldMOMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WaldMOMEstimator.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Estimate parameter of the Wald distribution. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has WaldDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WeibullLMMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WeibullLMMEstimator.java index 4ea8faa7..0756c113 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WeibullLMMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WeibullLMMEstimator.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * (LMM). * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has WeibullDistribution */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WeibullLogMADEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WeibullLogMADEstimator.java index 8dd068e0..22f6effc 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WeibullLogMADEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WeibullLogMADEstimator.java @@ -39,6 +39,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has WeibullDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WeibullLogMOMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WeibullLogMOMEstimator.java index dd02dea4..3a96dcfd 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WeibullLogMOMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/WeibullLogMOMEstimator.java @@ -36,6 +36,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * doesn't use "the" statistical moments. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.has WeibullDistribution - - estimates */ diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/meta/BestFitEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/meta/BestFitEstimator.java index 81e2abfd..c3409d9b 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/meta/BestFitEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/meta/BestFitEstimator.java @@ -87,6 +87,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * choose whichever works best. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.uses MOMDistributionEstimator * @apiviz.uses MADDistributionEstimator diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/meta/TrimmedEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/meta/TrimmedEstimator.java index ed1ffab8..54fda81c 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/meta/TrimmedEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/meta/TrimmedEstimator.java @@ -41,6 +41,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ObjectParameter; * analyzes it using another estimator. * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.uses DistributionEstimator * diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/meta/WinsorisingEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/meta/WinsorisingEstimator.java index ad8e532d..56a7ee94 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/meta/WinsorisingEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/distribution/estimator/meta/WinsorisingEstimator.java @@ -51,6 +51,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ObjectParameter; * </p> * * @author Erich Schubert + * @since 0.6.0 * * @apiviz.uses DistributionEstimator * diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/AbstractIntrinsicDimensionalityEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/AbstractIntrinsicDimensionalityEstimator.java index 4bea246b..c3dde05f 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/AbstractIntrinsicDimensionalityEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/AbstractIntrinsicDimensionalityEstimator.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.NumberArrayAdapter * Abstract base class for ID estimators. * * @author Erich Schubert + * @since 0.7.0 */ public abstract class AbstractIntrinsicDimensionalityEstimator implements IntrinsicDimensionalityEstimator { @Override diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/AggregatedHillEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/AggregatedHillEstimator.java index 732d74ab..2cd35e60 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/AggregatedHillEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/AggregatedHillEstimator.java @@ -40,6 +40,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Jonathan von Brünken * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "R. Huisman and K. G. Koedijk and C. J. M. Kool and F. Palm", // title = "Tail-Index Estimates in Small Samples", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/EnsembleEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/EnsembleEstimator.java index 019580fa..83dbb8bc 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/EnsembleEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/EnsembleEstimator.java @@ -34,6 +34,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.NumberArrayAdapter * This is an experimental estimator. Please cite ELKI when using. * * @author Erich Schubert + * @since 0.7.0 */ public class EnsembleEstimator extends AbstractIntrinsicDimensionalityEstimator { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/GEDEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/GEDEstimator.java index 2514006c..82e5486b 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/GEDEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/GEDEstimator.java @@ -39,6 +39,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Jonathan von Brünken * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "M. E. Houle, H. Kashima, M. Nett", // title = "Generalized expansion dimension", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/HillEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/HillEstimator.java index 228aa5c0..0d761b8e 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/HillEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/HillEstimator.java @@ -39,6 +39,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Jonathan von Brünken * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "B. M. Hill", // title = "A simple general approach to inference about the tail of a distribution", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/IntrinsicDimensionalityEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/IntrinsicDimensionalityEstimator.java index 978869b0..159b5c98 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/IntrinsicDimensionalityEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/IntrinsicDimensionalityEstimator.java @@ -28,6 +28,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.NumberArrayAdapter * Estimate the intrinsic dimensionality from a distance list. * * @author Erich Schubert + * @since 0.7.0 */ public interface IntrinsicDimensionalityEstimator { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/LMomentsEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/LMomentsEstimator.java index 671b3e36..1435945d 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/LMomentsEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/LMomentsEstimator.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Jonathan von Brünken * @author Erich Schubert + * @since 0.7.0 */ public class LMomentsEstimator extends AbstractIntrinsicDimensionalityEstimator { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/MOMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/MOMEstimator.java index 174d4bf7..8379f56b 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/MOMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/MOMEstimator.java @@ -42,6 +42,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "L. Amsaleg and O. Chelly and T. Furon and S. Girard and M. E. Houle and K. Kawarabayashi and M. Nett", // title = "Estimating Local Intrinsic Dimensionality", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/PWM2Estimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/PWM2Estimator.java index 5d16fa48..f8176ec8 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/PWM2Estimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/PWM2Estimator.java @@ -45,6 +45,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * this. This hack causes this estimator to have a bias to underestimate the ID. * * @author Erich Schubert + * @since 0.7.0 */ public class PWM2Estimator extends AbstractIntrinsicDimensionalityEstimator { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/PWMEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/PWMEstimator.java index 9c9db16b..bcc6a21e 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/PWMEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/PWMEstimator.java @@ -42,6 +42,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Jonathan von Brünken * @author Erich Schubert + * @since 0.7.0 */ public class PWMEstimator extends AbstractIntrinsicDimensionalityEstimator { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/RVEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/RVEstimator.java index 52976bf4..dcff6031 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/RVEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/RVEstimator.java @@ -39,6 +39,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * </p> * * @author Oussama Chelly + * @since 0.7.0 */ @Reference(authors = "L. Amsaleg and O. Chelly and T. Furon and S. Girard and M. E. Houle and K. Kawarabayashi and M. Nett", // title = "Estimating Local Intrinsic Dimensionality", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/ZipfEstimator.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/ZipfEstimator.java index c5bd60a2..21cdb93f 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/ZipfEstimator.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/intrinsicdimensionality/ZipfEstimator.java @@ -55,6 +55,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * TODO: possible to improve numerical precision via log1p? * * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "M. Kratz and S. I. Resnick", // title = "On Least Squares Estimates of an Exponential Tail Coefficient", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/BiweightKernelDensityFunction.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/BiweightKernelDensityFunction.java index d9252e86..7dd76cc0 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/BiweightKernelDensityFunction.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/BiweightKernelDensityFunction.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Biweight (Quartic) kernel density estimator. * * @author Erich Schubert + * @since 0.6.0 */ @Alias({ "biweight", "quartic" }) public final class BiweightKernelDensityFunction implements KernelDensityFunction { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/CosineKernelDensityFunction.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/CosineKernelDensityFunction.java index b51b308e..eaabde55 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/CosineKernelDensityFunction.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/CosineKernelDensityFunction.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Cosine kernel density estimator. * * @author Erich Schubert + * @since 0.6.0 */ public final class CosineKernelDensityFunction implements KernelDensityFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/EpanechnikovKernelDensityFunction.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/EpanechnikovKernelDensityFunction.java index b83ce76c..cde35380 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/EpanechnikovKernelDensityFunction.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/EpanechnikovKernelDensityFunction.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Epanechnikov kernel density estimator. * * @author Erich Schubert + * @since 0.6.0 */ @Alias({ "epanechnikov" }) public final class EpanechnikovKernelDensityFunction implements KernelDensityFunction { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/GaussianKernelDensityFunction.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/GaussianKernelDensityFunction.java index adf9189e..5ec0fe94 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/GaussianKernelDensityFunction.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/GaussianKernelDensityFunction.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Gaussian kernel density estimator. * * @author Erich Schubert + * @since 0.6.0 */ public final class GaussianKernelDensityFunction implements KernelDensityFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/KernelDensityFunction.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/KernelDensityFunction.java index c53d5da1..ecc8567d 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/KernelDensityFunction.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/KernelDensityFunction.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * Note: as of now, this API does not support asymmetric kernels. * * @author Erich Schubert + * @since 0.6.0 */ public interface KernelDensityFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/TriangularKernelDensityFunction.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/TriangularKernelDensityFunction.java index 0175f163..923f45e1 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/TriangularKernelDensityFunction.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/TriangularKernelDensityFunction.java @@ -29,6 +29,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Triangular kernel density estimator. * * @author Erich Schubert + * @since 0.6.0 */ public final class TriangularKernelDensityFunction implements KernelDensityFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/TricubeKernelDensityFunction.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/TricubeKernelDensityFunction.java index c2cf5152..472646a0 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/TricubeKernelDensityFunction.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/TricubeKernelDensityFunction.java @@ -29,6 +29,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Tricube kernel density estimator. * * @author Erich Schubert + * @since 0.6.0 */ public final class TricubeKernelDensityFunction implements KernelDensityFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/TriweightKernelDensityFunction.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/TriweightKernelDensityFunction.java index fd3b38e3..2573723f 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/TriweightKernelDensityFunction.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/TriweightKernelDensityFunction.java @@ -31,6 +31,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Triweight kernel density estimator. * * @author Erich Schubert + * @since 0.6.0 */ @Alias({ "triweight" }) public final class TriweightKernelDensityFunction implements KernelDensityFunction { diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/UniformKernelDensityFunction.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/UniformKernelDensityFunction.java index a27d0ba4..bf07911d 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/UniformKernelDensityFunction.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/kernelfunctions/UniformKernelDensityFunction.java @@ -30,6 +30,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * Uniform / Rectangular kernel density estimator. * * @author Erich Schubert + * @since 0.6.0 */ public final class UniformKernelDensityFunction implements KernelDensityFunction { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/AndersonDarlingTest.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/AndersonDarlingTest.java index de418391..174563b7 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/AndersonDarlingTest.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/AndersonDarlingTest.java @@ -62,6 +62,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * </p> * * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "T. W. Anderson, and D. A. Darling", // title = "Asymptotic theory of certain 'goodness of fit' criteria based on stochastic processes", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/GoodnessOfFitTest.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/GoodnessOfFitTest.java index 2882390a..a1c9aa7a 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/GoodnessOfFitTest.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/GoodnessOfFitTest.java @@ -33,6 +33,7 @@ package de.lmu.ifi.dbs.elki.math.statistics.tests; * * @author Jan Brusis * @author Erich Schubert + * @since 0.5.0 */ public interface GoodnessOfFitTest { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/KolmogorovSmirnovTest.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/KolmogorovSmirnovTest.java index 3e2d98e4..f0b2ea95 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/KolmogorovSmirnovTest.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/KolmogorovSmirnovTest.java @@ -37,6 +37,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * difference of the empirical CDFs. * * @author Erich Schubert + * @since 0.5.0 */ public class KolmogorovSmirnovTest implements GoodnessOfFitTest { /** diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/StandardizedTwoSampleAndersonDarlingTest.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/StandardizedTwoSampleAndersonDarlingTest.java index d2f9777c..a2b83496 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/StandardizedTwoSampleAndersonDarlingTest.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/StandardizedTwoSampleAndersonDarlingTest.java @@ -57,6 +57,7 @@ import de.lmu.ifi.dbs.elki.utilities.documentation.Reference; * </p> * * @author Erich Schubert + * @since 0.7.0 */ @Reference(authors = "F. W. Scholz, and M. A. Stephens", // title = "K-sample Anderson–Darling tests", // diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/WelchTTest.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/WelchTTest.java index 91049bad..50e55f58 100644 --- a/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/WelchTTest.java +++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/math/statistics/tests/WelchTTest.java @@ -35,6 +35,7 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer; * * @author Jan Brusis * @author Erich Schubert + * @since 0.5.0 * * @apiviz.uses StudentsTDistribution */ |