# Uses of Class org.deidentifier.arx.metric.InformationLoss (ARX Developer Documentation)

## Uses of Class
org.deidentifier.arx.metric.InformationLoss

- Packages that use InformationLoss
  Package | Description
  --- | ---
  org.deidentifier.arx | This package provides the public API for the ARX anonymization framework.
  org.deidentifier.arx.framework.check | This package implements the core functionality of the ARX framework, i.e., a highly efficient check for k-anonymity
  org.deidentifier.arx.framework.lattice | This package provides the internal generalization lattice
  org.deidentifier.arx.metric | This package implements several metrics for information loss.
  org.deidentifier.arx.metric.v2 |

- - ### Uses of InformationLoss in org.deidentifier.arx

    Methods in org.deidentifier.arx that return InformationLoss
    Modifier and Type | Method and Description
    --- | ---
    `InformationLoss<?>` | ARXLattice.`getHighestScore()` Returns the highest score.
    `InformationLoss<?>` | ARXLattice.ARXNode.`getHighestScore()` Returns the highest score.
    `protected InformationLoss<?>` | ARXLattice.ARXNode.`getLowerBound()` Returns a node's lower bound, if any.
    `InformationLoss<?>` | ARXLattice.`getLowestScore()` Returns the lowest score.
    `InformationLoss<?>` | ARXLattice.ARXNode.`getLowestScore()` Returns the highest score.
    `InformationLoss<?>` | ARXLattice.`getMaximumInformationLoss()` Deprecated.
    `InformationLoss<?>` | ARXLattice.ARXNode.`getMaximumInformationLoss()` Deprecated.
    `InformationLoss<?>` | ARXLattice.`getMinimumInformationLoss()` Deprecated.
    `InformationLoss<?>` | ARXLattice.ARXNode.`getMinimumInformationLoss()` Deprecated.

    Methods in org.deidentifier.arx with parameters of type InformationLoss
    Modifier and Type | Method and Description
    --- | ---
    `void` | ARXLattice.ARXNode.Access.`setHighestScore(InformationLoss<?> a)` Sets the maximal information loss.
    `void` | ARXLattice.ARXNode.Access.`setLowerBound(InformationLoss<?> a)` Sets the lower bound.
    `void` | ARXLattice.ARXNode.Access.`setLowestScore(InformationLoss<?> a)` Sets the minimal information loss.

  - ### Uses of InformationLoss in org.deidentifier.arx.framework.check

    Fields in org.deidentifier.arx.framework.check declared as InformationLoss
    Modifier and Type | Field and Description
    --- | ---
    `InformationLoss<?>` | NodeChecker.Result.`informationLoss` Information loss.
    `InformationLoss<?>` | NodeChecker.Result.`lowerBound` Lower bound.

  - ### Uses of InformationLoss in org.deidentifier.arx.framework.lattice

    Methods in org.deidentifier.arx.framework.lattice that return InformationLoss
    Modifier and Type | Method and Description
    --- | ---
    `InformationLoss<?>` | Transformation.`getInformationLoss()` Returns the information loss
    `protected InformationLoss<?>` | SolutionSpace.`getInformationLoss(long identifier)` Returns the information loss
    `InformationLoss<?>` | Transformation.`getLowerBound()` Returns the lower bound on information loss
    `protected InformationLoss<?>` | SolutionSpace.`getLowerBound(long identifier)` Returns the lower bound
    `InformationLoss<?>` | SolutionSpace.`getUtility(long identifier)` Returns the utility of the transformation with the given identifier

    Methods in org.deidentifier.arx.framework.lattice with parameters of type InformationLoss
    Modifier and Type | Method and Description
    --- | ---
    `void` | Transformation.`setInformationLoss(InformationLoss<?> informationLoss)` Sets the information loss
    `protected void` | SolutionSpace.`setInformationLoss(long identifier, InformationLoss<?> loss)` Sets the information loss
    `void` | Transformation.`setLowerBound(InformationLoss<?> lowerBound)` Sets the lower bound
    `protected void` | SolutionSpace.`setLowerBound(long identifier, InformationLoss<?> loss)` Sets the lower bound

  - ### Uses of InformationLoss in org.deidentifier.arx.metric

    Classes in org.deidentifier.arx.metric with type parameters of type InformationLoss
    Modifier and Type | Class and Description
    --- | ---
    `class` | `InformationLossWithBound<T extends InformationLoss<?>>` Information loss with a potential lower bound.
    `class` | `Metric<T extends InformationLoss<?>>` Abstract base class for metrics.
    `class` | `MetricWeighted<T extends InformationLoss<?>>` This class provides an abstract skeleton for the implementation of weighted metrics.

    Methods in org.deidentifier.arx.metric that return InformationLoss
    Modifier and Type | Method and Description
    --- | ---
    `abstract InformationLoss<T>` | InformationLoss.`clone()` Returns a clone of this object.
    `static InformationLoss<?>` | InformationLoss.`createInformationLoss(InformationLoss<?> loss, Metric<?> metric, int minLevel, int maxLevel)` Converter method, converting information loss from version 1 to information loss from version 2, if necessary.
    `InformationLoss<?>` | Metric.`createInstanceOfHighestScore()` Returns an instance of the highest possible score.
    `InformationLoss<?>` | Metric.`createInstanceOfLowestScore()` Returns an instance of the lowest possible score.
    `InformationLoss<?>` | MetricAECS.`createMaxInformationLoss()`
    `InformationLoss<?>` | MetricDM.`createMaxInformationLoss()`
    `InformationLoss<?>` | MetricHeight.`createMaxInformationLoss()`
    `InformationLoss<?>` | MetricStatic.`createMaxInformationLoss()`
    `InformationLoss<?>` | MetricDefault.`createMaxInformationLoss()`
    `abstract InformationLoss<?>` | Metric.`createMaxInformationLoss()` Deprecated.
    `InformationLoss<?>` | MetricNMPrecision.`createMaxInformationLoss()`
    `InformationLoss<?>` | MetricPrecision.`createMaxInformationLoss()`
    `InformationLoss<?>` | MetricDMStar.`createMaxInformationLoss()`
    `InformationLoss<?>` | MetricAECS.`createMinInformationLoss()`
    `InformationLoss<?>` | MetricDM.`createMinInformationLoss()`
    `InformationLoss<?>` | MetricHeight.`createMinInformationLoss()`
    `InformationLoss<?>` | MetricStatic.`createMinInformationLoss()`
    `InformationLoss<?>` | MetricDefault.`createMinInformationLoss()`
    `abstract InformationLoss<?>` | Metric.`createMinInformationLoss()` Deprecated.
    `InformationLoss<?>` | MetricNMPrecision.`createMinInformationLoss()`
    `InformationLoss<?>` | MetricPrecision.`createMinInformationLoss()`
    `InformationLoss<?>` | MetricDMStar.`createMinInformationLoss()`

    Methods in org.deidentifier.arx.metric with parameters of type InformationLoss
    Modifier and Type | Method and Description
    --- | ---
    `abstract int` | InformationLoss.`compareTo(InformationLoss<?> other)` Compares the loss to the other.
    `static InformationLoss<?>` | InformationLoss.`createInformationLoss(InformationLoss<?> loss, Metric<?> metric, int minLevel, int maxLevel)` Converter method, converting information loss from version 1 to information loss from version 2, if necessary.
    `abstract void` | InformationLoss.`max(InformationLoss<?> other)` Retains the maximum of this and other.
    `abstract void` | InformationLoss.`min(InformationLoss<?> other)` Retains the minimum of this and other.
    `abstract double` | InformationLoss.`relativeTo(InformationLoss<?> min, InformationLoss<?> max)` Returns the value relative to the other instance.
    `abstract double` | InformationLoss.`relativeTo(InformationLoss<?> min, InformationLoss<?> max)` Returns the value relative to the other instance.

  - ### Uses of InformationLoss in org.deidentifier.arx.metric.v2

    Subclasses of InformationLoss in org.deidentifier.arx.metric.v2
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractILMultiDimensional` This class implements an information loss which can be represented as a decimal number per quasi-identifier.
    `class` | `AbstractILMultiDimensionalReduced` This class implements an information loss which can be represented as a decimal number per quasi-identifier.
    `class` | `ILMultiDimensionalArithmeticMean` This class implements an information loss which can be represented as a decimal number per quasi-identifier.
    `class` | `ILMultiDimensionalGeometricMean` This class implements an information loss which can be represented as a decimal number per quasi-identifier.
    `class` | `ILMultiDimensionalMax` This class implements an information loss which can be represented as a decimal number per quasi-identifier.
    `class` | `ILMultiDimensionalRank` This class implements an information loss which can be represented as a decimal number per quasi-identifier.
    `class` | `ILMultiDimensionalSum` This class implements an information loss which can be represented as a decimal number per quasi-identifier.
    `class` | `ILSingleDimensional` This class implements an information loss which can be represented as a single decimal number.

    Methods in org.deidentifier.arx.metric.v2 that return InformationLoss
    Modifier and Type | Method and Description
    --- | ---
    `InformationLoss<double[]>` | ILMultiDimensionalRank.`clone()`
    `InformationLoss<double[]>` | ILMultiDimensionalGeometricMean.`clone()`
    `abstract InformationLoss<double[]>` | AbstractILMultiDimensional.`clone()`
    `InformationLoss<double[]>` | ILMultiDimensionalArithmeticMean.`clone()`
    `abstract InformationLoss<double[]>` | AbstractILMultiDimensionalReduced.`clone()` Override this to implement a variant.
    `InformationLoss<java.lang.Double>` | ILSingleDimensional.`clone()`
    `InformationLoss<double[]>` | ILMultiDimensionalMax.`clone()`
    `InformationLoss<double[]>` | ILMultiDimensionalSum.`clone()`
    `static InformationLoss<?>` | __MetricV2.`createILMultiDimensionalArithmeticMean(double value)` Helper method.
    `static InformationLoss<?>` | __MetricV2.`createILMultiDimensionalSum(double value)` Helper method.
    `static InformationLoss<?>` | __MetricV2.`createILSingleDimensional(double value)` Helper method.
    `InformationLoss<?>` | AbstractMetricSingleDimensional.`createMaxInformationLoss()`
    `InformationLoss<?>` | AbstractMetricMultiDimensional.`createMaxInformationLoss()`
    `InformationLoss<?>` | AbstractMetricMultiDimensionalPotentiallyPrecomputed.`createMaxInformationLoss()`
    `InformationLoss<?>` | AbstractMetricSingleDimensional.`createMinInformationLoss()`
    `InformationLoss<?>` | AbstractMetricMultiDimensional.`createMinInformationLoss()`
    `InformationLoss<?>` | AbstractMetricMultiDimensionalPotentiallyPrecomputed.`createMinInformationLoss()`

    Methods in org.deidentifier.arx.metric.v2 with parameters of type InformationLoss
    Modifier and Type | Method and Description
    --- | ---
    `int` | ILMultiDimensionalRank.`compareTo(InformationLoss<?> other)`
    `abstract int` | AbstractILMultiDimensional.`compareTo(InformationLoss<?> other)`
    `int` | AbstractILMultiDimensionalReduced.`compareTo(InformationLoss<?> other)`
    `int` | ILSingleDimensional.`compareTo(InformationLoss<?> other)`
    `protected ILMultiDimensionalRank` | ILMultiDimensionalRank.`convert(InformationLoss<?> other)`
    `protected abstract AbstractILMultiDimensional` | AbstractILMultiDimensional.`convert(InformationLoss<?> other)` Converter method.
    `protected AbstractILMultiDimensionalReduced` | AbstractILMultiDimensionalReduced.`convert(InformationLoss<?> other)` Converter method.
    `void` | AbstractILMultiDimensional.`max(InformationLoss<?> other)`
    `void` | ILSingleDimensional.`max(InformationLoss<?> other)`
    `void` | AbstractILMultiDimensional.`min(InformationLoss<?> other)`
    `void` | ILSingleDimensional.`min(InformationLoss<?> other)`
    `double` | ILMultiDimensionalRank.`relativeTo(InformationLoss<?> min, InformationLoss<?> max)`
    `double` | ILMultiDimensionalRank.`relativeTo(InformationLoss<?> min, InformationLoss<?> max)`
    `abstract double` | AbstractILMultiDimensional.`relativeTo(InformationLoss<?> min, InformationLoss<?> max)`
    `abstract double` | AbstractILMultiDimensional.`relativeTo(InformationLoss<?> min, InformationLoss<?> max)`
    `double` | AbstractILMultiDimensionalReduced.`relativeTo(InformationLoss<?> min, InformationLoss<?> max)`
    `double` | AbstractILMultiDimensionalReduced.`relativeTo(InformationLoss<?> min, InformationLoss<?> max)`
    `double` | ILSingleDimensional.`relativeTo(InformationLoss<?> min, InformationLoss<?> max)`
    `double` | ILSingleDimensional.`relativeTo(InformationLoss<?> min, InformationLoss<?> max)`