de.lmu.ifi.dbs.elki.math

Class IntegerMinMax

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.pairs.IntIntPair

de.lmu.ifi.dbs.elki.math.IntegerMinMax

All Implemented Interfaces:

PairInterface<Integer,Integer>, Comparable<IntIntPair>

public class IntegerMinMax
extends IntIntPair

Class to find the minimum and maximum int values in data.

Field Summary

Fields inherited from class de.lmu.ifi.dbs.elki.utilities.pairs.IntIntPair

BYFIRST_COMPARATOR, BYSECOND_COMPARATOR, first, second, SWAPPED_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
IntegerMinMax() Constructor without starting values.
IntegerMinMax(int min, int max) Constructor with predefined minimum and maximum values.

Method Summary

Methods

Modifier and Type	Method and Description
int[]	asIntArray() Return minimum and maximum as array.
int	getDiff() Return the difference between minimum and maximum.
int	getMax() Get the current maximum.
int	getMin() Get the current minimum.
boolean	isValid() Test whether the result is defined.
static IntegerMinMax[]	newArray(int size) Generate a new array of initialized IntegerMinMax objects (with default constructor)
void	put(Collection<Integer> data) Process a whole collection of Integer values.
void	put(int data) Process a single int value.
void	put(int[] data) Process a whole array of int values.
void	reset() Reset statistics.

Methods inherited from class de.lmu.ifi.dbs.elki.utilities.pairs.IntIntPair

compareSwappedTo, compareTo, equals, getFirst, getSecond, hashCode, setFirst, setSecond, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IntegerMinMax

public IntegerMinMax()

Constructor without starting values. The minimum will be initialized to Integer.MAX_VALUE. The maximum will be initialized to Integer.MIN_VALUE. So that the first data added will replace both.

IntegerMinMax

public IntegerMinMax(int min,
             int max)

Constructor with predefined minimum and maximum values.

Parameters:

min - Minimum value

max - Maximum value

Method Detail

put

public void put(int data)

Process a single int value. If the new value is smaller than the current minimum, it will become the new minimum. If the new value is larger than the current maximum, it will become the new maximum.

Parameters:

data - New value

put

public void put(int[] data)

Process a whole array of int values. If any of the values is smaller than the current minimum, it will become the new minimum. If any of the values is larger than the current maximum, it will become the new maximum.

Parameters:

data - Data to process

put

public void put(Collection<Integer> data)

Process a whole collection of Integer values. If any of the values is smaller than the current minimum, it will become the new minimum. If any of the values is larger than the current maximum, it will become the new maximum.

Parameters:

data - Data to process

getMin

public int getMin()

Get the current minimum.

Returns:

current minimum.

getMax

public int getMax()

Get the current maximum.

Returns:

current maximum.

getDiff

public int getDiff()

Return the difference between minimum and maximum.

Returns:

Difference of current Minimum and Maximum.

isValid

public boolean isValid()

Test whether the result is defined.

Returns:

true when at least one value has been added

asIntArray

public int[] asIntArray()

Return minimum and maximum as array.

Returns:

Minimum, Maximum

newArray

public static IntegerMinMax[] newArray(int size)

Generate a new array of initialized IntegerMinMax objects (with default constructor)

Parameters:

size - Array size

Returns:

initialized array

reset

public void reset()

Reset statistics.