si.JDEXi

Class Distribution

java.lang.Object

si.JDEXi.Distribution

public class Distribution
extends java.lang.Object

Distribution class.

Distribution consists of:

• double[] distribution
• double cumulative: holds some cumulative value, interpretation-dependent

Version:

3.0

Author:

Marko Bohanec

Constructor Summary

Constructors

Constructor and Description
Distribution(Distribution aDistr) Constructs Distribution from another Distribution.
Distribution(double aCum, double[] aDistr) Constructs Distribution from aCum/aDistr.
Distribution(int aSize) Constructs Distribution of given size.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Distribution aDistr)
void	add(int index) Increment value at index by 1.0.
void	add(int index, double val) Increment value at index by val.
void	add(int index, double val, double cum) Increment value at index by val and cumulative by cum.
double	average() Calculate the average of distribution values.
double	avgIndex() Calculate the average index of distribution values.
void	clear() Clear distribution.
void	divBy(double by) Divide all elements and cumulative by by.
void	full() Fully populate distribution.
int	getCount() Count the number of non-zero elements.
double	getCumulative() Get cumulative value
int[]	getSet() Represent distribution with a set of values.
int	getSingle() Get a single value represented by distribution.
double	getValue(int index) Get distribution value at index.
void	increment() Increment distribution size by one.
double	max() Calculate the maximum of distribution values.
void	mulBy(double by) Multiply all elements and cumulative by by.
void	normalize() Normalize distribution by dividing all elements by cumulative.
void	normalize(double n) Normalize distribution by dividing all elements by n and setting cumulative to 1.0.
void	normalizeMax() Normalize distribution so that max()==1.0.
void	normalizeSet() Convert distribution to a set by setting all non-zero elements and cumulative to 1.0.
void	normalizeSum() Normalize distribution so that sum()==1.0.
void	setCumulative(double aCumul) Set cumulative.
void	setSet(int[] set) Convert a set into distribution.
void	setSingle(int val) Set the distribution to single value.
void	setValue(int index, double val) Set distribution value at index to val.
int	size() Get distribution size.
double	sum() Calculate the sum of distribution values.
double	sumDiv() Calculate sum() divided by cumulative.
double	sumMul() Calculate weighted sum.
java.lang.String	toString() Represent distribution with a short string.
void	uniform() Create a uniform distribution with respect to the number of values.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Distribution

public Distribution(int aSize)

Constructs Distribution of given size.

Parameters:

aSize - Initial length of distribution.

Distribution

public Distribution(double aCum,
            double[] aDistr)

Constructs Distribution from aCum/aDistr.

Parameters:

aCum - Initial cumulative value.

aDistr - Initial distribution.

Distribution

public Distribution(Distribution aDistr)

Constructs Distribution from another Distribution.

Parameters:

aDistr - Other Distribution.

Method Detail

size

public int size()

Get distribution size. Cumulative is not counted.

Returns:

Length of distribution.

getCumulative

public double getCumulative()

Get cumulative value

Returns:

double

setCumulative

public void setCumulative(double aCumul)

Set cumulative.

Parameters:

aCumul - New cumulative vaue.

getValue

public double getValue(int index)

Get distribution value at index.

Parameters:

index -

Returns:

value

setValue

public void setValue(int index,
            double val)

Set distribution value at index to val.

Parameters:

index -

val -

clear

public void clear()

Clear distribution. All distribution values and cumulative are set to 0.0.

full

public void full()

Fully populate distribution. All distribution values and cumulative are set to 1.0.

uniform

public void uniform()

Create a uniform distribution with respect to the number of values. Cumulative is set to 1.0.

getSingle

public int getSingle()

Get a single value represented by distribution.

Returns:

If distribution holds a single element with value not equal to 0.0, returns the index of that element, otherwise returns -1.

setSingle

public void setSingle(int val)

Set the distribution to single value. The element at index val and cumulative are set to 1.0, other elements are cleared.

Parameters:

val -

getCount

public int getCount()

Count the number of non-zero elements.

Returns:

Count

getSet

public int[] getSet()

Represent distribution with a set of values.

Returns:

int[] containing indices of non-zero elements.

setSet

public void setSet(int[] set)

Convert a set into distribution.

Parameters:

set - int[] containing indices of distribution elements whose values are set to 1.o. Cumulative is also set to 1.0.

sum

public double sum()

Calculate the sum of distribution values.

Returns:

double Sum.

max

public double max()

Calculate the maximum of distribution values.

Returns:

double Maximum.

average

public double average()

Calculate the average of distribution values.

Returns:

double Average.

avgIndex

public double avgIndex()

Calculate the average index of distribution values. Warning: This is not equal to average().

Returns:

double Average index.

sumMul

public double sumMul()

Calculate weighted sum.

Returns:

cumulative * sum().

sumDiv

public double sumDiv()

Calculate sum() divided by cumulative. Returns 0.0 if cumulative==0.0.

Returns:

sum() / cumulative.

add

public void add(Distribution aDistr)

add

public void add(int index,
       double val,
       double cum)

Increment value at index by val and cumulative by cum.

Parameters:

index - Element index.

val - Value increment.

cum - Cumulative increment.

add

public void add(int index,
       double val)

Increment value at index by val. Cumulative is increased by 1.0.

Parameters:

index - Element index.

val - Value increment.

add

public void add(int index)

Increment value at index by 1.0. Cumulative is increased by 1.0.

Parameters:

index - Element index.

divBy

public void divBy(double by)

Divide all elements and cumulative by by.

Parameters:

by -

mulBy

public void mulBy(double by)

Multiply all elements and cumulative by by.

Parameters:

by -

normalize

public void normalize(double n)

Normalize distribution by dividing all elements by n and setting cumulative to 1.0. Warning: n==0.0 throws an exception.

Parameters:

n - Divisor.

normalize

public void normalize()

Normalize distribution by dividing all elements by cumulative.

normalizeSum

public void normalizeSum()

Normalize distribution so that sum()==1.0.

normalizeMax

public void normalizeMax()

Normalize distribution so that max()==1.0.

normalizeSet

public void normalizeSet()

Convert distribution to a set by setting all non-zero elements and cumulative to 1.0.

increment

public void increment()

Increment distribution size by one. Insert new 0.0 element at distribution[0].

toString

public java.lang.String toString()

Represent distribution with a short string.

Overrides:

toString in class java.lang.Object