de.lmu.ifi.dbs.elki.math.statistics.dependence

Class AbstractDependenceMeasure

java.lang.Object

de.lmu.ifi.dbs.elki.math.statistics.dependence.AbstractDependenceMeasure

All Implemented Interfaces:

DependenceMeasure

Direct Known Subclasses:

CorrelationDependenceMeasure, DistanceCorrelationDependenceMeasure, HiCSDependenceMeasure, HoeffdingsDDependenceMeasure, HSMDependenceMeasure, JensenShannonEquiwidthDependenceMeasure, MCEDependenceMeasure, MutualInformationEquiwidthDependenceMeasure, SlopeDependenceMeasure, SpearmanCorrelationDependenceMeasure, SURFINGDependenceMeasure

public abstract class AbstractDependenceMeasure
extends java.lang.Object
implements DependenceMeasure

Abstract base class for dependence measures.

Since:

0.7.0

Author:

Erich Schubert

Constructor Summary

Constructors

Constructor and Description
AbstractDependenceMeasure()

Method Summary

Modifier and Type	Method and Description
protected static double	clamp(double value, double min, double max) Clamp values to a given minimum and maximum.
protected static <A> double[]	computeNormalizedRanks(NumberArrayAdapter<?,A> adapter, A data, int len) Compute ranks of all objects, normalized to [0;1] (where 0 is the smallest value, 1 is the largest).
protected static <A> int[]	discretize(NumberArrayAdapter<?,A> adapter, A data, int len, int bins) Discretize a data set into equi-width bin numbers.
protected static int	index(int x, int y) Index into the serialized array.
protected static <A> double[]	ranks(NumberArrayAdapter<?,A> adapter, A data, int len) Compute ranks of all objects, ranging from 1 to len.
protected static <A> double[]	ranks(NumberArrayAdapter<?,A> adapter, A data, int[] idx) Compute ranks of all objects, ranging from 1 to len.
protected static <A,B> int	size(NumberArrayAdapter<?,A> adapter1, A data1, NumberArrayAdapter<?,B> adapter2, B data2) Validate the length of the two data sets (must be the same, and non-zero)
protected static <A> int	size(NumberArrayAdapter<?,A> adapter, java.util.Collection<? extends A> data) Validate the length of the two data sets (must be the same, and non-zero)
protected static <A> int[]	sortedIndex(NumberArrayAdapter<?,A> adapter, A data, int len) Build a sorted index of objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.lmu.ifi.dbs.elki.math.statistics.dependence.DependenceMeasure

dependence, dependence, dependence, dependence

Constructor Detail

AbstractDependenceMeasure

public AbstractDependenceMeasure()

Method Detail

clamp

protected static double clamp(double value,
                              double min,
                              double max)

Clamp values to a given minimum and maximum.

Parameters:

value - True value

min - Minimum

max - Maximum

Returns:

value, unless smaller than min or larger than max.

computeNormalizedRanks

protected static <A> double[] computeNormalizedRanks(NumberArrayAdapter<?,A> adapter,
                                                     A data,
                                                     int len)

Compute ranks of all objects, normalized to [0;1] (where 0 is the smallest value, 1 is the largest).

Parameters:

adapter - Data adapter

data - Data array

len - Length of data

Returns:

Array of scores

ranks

protected static <A> double[] ranks(NumberArrayAdapter<?,A> adapter,
                                    A data,
                                    int len)

Compute ranks of all objects, ranging from 1 to len. Ties are given the average rank.

Parameters:

adapter - Data adapter

data - Data array

len - Length of data

Returns:

Array of scores

ranks

protected static <A> double[] ranks(NumberArrayAdapter<?,A> adapter,
                                    A data,
                                    int[] idx)

Compute ranks of all objects, ranging from 1 to len. Ties are given the average rank.

Parameters:

adapter - Data adapter

data - Data array

idx - Data index

Returns:

Array of scores

sortedIndex

protected static <A> int[] sortedIndex(NumberArrayAdapter<?,A> adapter,
                                       A data,
                                       int len)

Build a sorted index of objects.

Parameters:

adapter - Data adapter

data - Data array

len - Length of data

Returns:

Sorted index

discretize

protected static <A> int[] discretize(NumberArrayAdapter<?,A> adapter,
                                      A data,
                                      int len,
                                      int bins)

Discretize a data set into equi-width bin numbers.

Parameters:

adapter - Data adapter

data - Data array

len - Length of data

bins - Number of bins

Returns:

Array of bin numbers [0;bin[

index

protected static int index(int x,
                           int y)

Index into the serialized array.

Parameters:

x - Column

y - Row

Returns:

Index in serialized array

size

protected static <A,B> int size(NumberArrayAdapter<?,A> adapter1,
                                A data1,
                                NumberArrayAdapter<?,B> adapter2,
                                B data2)

Validate the length of the two data sets (must be the same, and non-zero)

Type Parameters:

A - First array type

B - Second array type

Parameters:

adapter1 - First data adapter

data1 - First data set

adapter2 - Second data adapter

data2 - Second data set

size

protected static <A> int size(NumberArrayAdapter<?,A> adapter,
                              java.util.Collection<? extends A> data)

Validate the length of the two data sets (must be the same, and non-zero)

Type Parameters:

A - First array type

Parameters:

adapter - Data adapter

data - Data sets