/*
* ARX: Powerful Data Anonymization
* Copyright 2012 - 2017 Fabian Prasser, Florian Kohlmayer and contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.deidentifier.arx.metric.v2;
import org.deidentifier.arx.ARXConfiguration;
import org.deidentifier.arx.certificate.elements.ElementData;
import org.deidentifier.arx.framework.lattice.Transformation;
import org.deidentifier.arx.metric.MetricConfiguration;
/**
* This class provides an implementation of the non-uniform entropy
* metric. TODO: Add reference
*
* @author Fabian Prasser
* @author Florian Kohlmayer
*/
public class MetricMDNUEntropy extends MetricMDNUEntropyPrecomputed {
/** SVUID. */
private static final long serialVersionUID = -8114158144622853288L;
/**
* Creates a new instance.
*/
protected MetricMDNUEntropy() {
super();
}
/**
* Creates a new instance.
*
* @param gsFactor
* @param function
*/
protected MetricMDNUEntropy(double gsFactor, AggregateFunction function){
super(gsFactor, function);
}
/**
* Returns the configuration of this metric.
*
* @return
*/
public MetricConfiguration getConfiguration() {
return new MetricConfiguration(true, // monotonic
super.getGeneralizationSuppressionFactor(), // gs-factor
false, // precomputed
0.0d, // precomputation threshold
this.getAggregateFunction() // aggregate function
);
}
@Override
public boolean isGSFactorSupported() {
return true;
}
@Override
public boolean isIndependent() {
// TODO: Remove
return false;
}
@Override
public ElementData render(ARXConfiguration config) {
ElementData result = new ElementData("Non-uniform entropy");
result.addProperty("Aggregate function", super.getAggregateFunction().toString());
result.addProperty("Monotonic", this.isMonotonic(config.getMaxOutliers()));
result.addProperty("Generalization factor", this.getGeneralizationFactor());
result.addProperty("Suppression factor", this.getSuppressionFactor());
return result;
}
@Override
public String toString() {
return "Non-uniform entropy";
}
@Override
protected AbstractILMultiDimensional getLowerBoundInternal(Transformation node) {
return null;
}
}