Import Upstream version 0.7.0

1 files changed, 129 insertions, 0 deletions

diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/utilities/scaling/ClipScaling.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/utilities/scaling/ClipScaling.java
new file mode 100644
index 00000000..3917c550
--- /dev/null
+++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/utilities/scaling/ClipScaling.java
@@ -0,0 +1,129 @@
+package de.lmu.ifi.dbs.elki.utilities.scaling;
+
+/*
+ This file is part of ELKI:
+ Environment for Developing KDD-Applications Supported by Index-Structures
+
+ Copyright (C) 2015
+ Ludwig-Maximilians-Universität München
+ Lehr- und Forschungseinheit für Datenbanksysteme
+ ELKI Development Team
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer;
+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;
+
+/**
+ * Scale implementing a simple clipping. Values less than the specified minimum
+ * will be set to the minimum, values larger than the maximum will be set to the
+ * maximum.
+ * 
+ * @author Erich Schubert
+ */
+public class ClipScaling implements StaticScalingFunction {
+  /**
+   * Parameter to specify a fixed minimum to use.
+   * <p>
+   * Key: {@code -clipscale.min}
+   * </p>
+   */
+  public static final OptionID MIN_ID = new OptionID("clipscale.min", "Minimum value to allow.");
+
+  /**
+   * Parameter to specify the maximum value
+   * <p>
+   * Key: {@code -clipscale.max}
+   * </p>
+   */
+  public static final OptionID MAX_ID = new OptionID("clipscale.max", "Maximum value to allow.");
+
+  /**
+   * Field storing the minimum to use
+   */
+  private Double min = null;
+
+  /**
+   * Field storing the maximum to use
+   */
+  private Double max = null;
+
+  /**
+   * Constructor.
+   *
+   * @param min Minimum, may be null
+   * @param max Maximum, may be null
+   */
+  public ClipScaling(Double min, Double max) {
+    super();
+    this.min = min;
+    this.max = max;
+  }
+
+  @Override
+  public double getScaled(double value) {
+    if(min != null && value < min) {
+      return min;
+    }
+    if(max != null && value > max) {
+      return max;
+    }
+    return value;
+  }
+
+  @Override
+  public double getMin() {
+    return (min != null) ? min : Double.NEGATIVE_INFINITY;
+  }
+
+  @Override
+  public double getMax() {
+    return (max != null) ? max : Double.POSITIVE_INFINITY;
+  }
+  
+  /**
+   * Parameterization class.
+   * 
+   * @author Erich Schubert
+   * 
+   * @apiviz.exclude
+   */
+  public static class Parameterizer extends AbstractParameterizer {
+    protected Double min = null;
+    protected Double max = null;
+    
+    @Override
+    protected void makeOptions(Parameterization config) {
+      super.makeOptions(config);
+      DoubleParameter minP = new DoubleParameter(MIN_ID);
+      minP.setOptional(true);
+      if(config.grab(minP)) {
+        min = minP.getValue();
+      }
+      DoubleParameter maxP = new DoubleParameter(MAX_ID);
+      maxP.setOptional(true);
+      if (config.grab(maxP)) {
+        max = maxP.getValue();
+      }
+    }
+
+    @Override
+    protected ClipScaling makeInstance() {
+      return new ClipScaling(min, max);
+    }
+  }
+}
\ No newline at end of file