org.apache.flink.api.common.distributions

Class UniformIntegerDistribution

java.lang.Object

org.apache.flink.api.common.distributions.UniformIntegerDistribution

All Implemented Interfaces:

Serializable, DataDistribution, IOReadableWritable

@PublicEvolving
public class UniformIntegerDistribution
extends Object
implements DataDistribution

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UniformIntegerDistribution()
UniformIntegerDistribution(int min, int max)

Method Summary

Modifier and Type	Method and Description
IntValue[]	getBucketBoundary(int bucketNum, int totalNumBuckets) Returns the i'th bucket's upper bound, given that the distribution is to be split into totalBuckets buckets.
int	getNumberOfFields() The number of fields in the (composite) key.
void	read(DataInputView in) Reads the object's internal data from the given data input view.
void	write(DataOutputView out) Writes the object's internal data to the given data output view.

Methods inherited from class java.lang.Object

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

Constructor Detail

UniformIntegerDistribution

public UniformIntegerDistribution()

UniformIntegerDistribution

public UniformIntegerDistribution(int min,
                                  int max)

Method Detail

getBucketBoundary

public IntValue[] getBucketBoundary(int bucketNum,
                                    int totalNumBuckets)

Description copied from interface: DataDistribution

Returns the i'th bucket's upper bound, given that the distribution is to be split into totalBuckets buckets.

Assuming n buckets, let B_i be the result from calling getBucketBoundary(i, n), then the distribution will partition the data domain in the following fashion:

 (-inf, B_1] (B_1, B_2] ... (B_n-2, B_n-1] (B_n-1, inf)
 

Note: The last bucket's upper bound is actually discarded by many algorithms. The last bucket is assumed to hold all values v such that v > getBucketBoundary(n-1, n), where n is the number of buckets.

Specified by:

getBucketBoundary in interface DataDistribution

Parameters:

bucketNum - The number of the bucket for which to get the upper bound.

totalNumBuckets - The number of buckets to split the data into.

Returns:

A record whose values act as bucket boundaries for the specified bucket.

getNumberOfFields

public int getNumberOfFields()

Description copied from interface: DataDistribution

The number of fields in the (composite) key. This determines how many fields in the records define the bucket. The number of fields must be the size of the array returned by the function DataDistribution.getBucketBoundary(int, int).

Specified by:

getNumberOfFields in interface DataDistribution

Returns:

The number of fields in the (composite) key.

write

public void write(DataOutputView out)
           throws IOException

Description copied from interface: IOReadableWritable

Writes the object's internal data to the given data output view.

Specified by:

write in interface IOReadableWritable

Parameters:

out - the output view to receive the data.

Throws:

IOException - thrown if any error occurs while writing to the output stream

read

public void read(DataInputView in)
          throws IOException

Description copied from interface: IOReadableWritable

Reads the object's internal data from the given data input view.

Specified by:

read in interface IOReadableWritable

Parameters:

in - the input view to read the data from

Throws:

IOException - thrown if any error occurs while reading from the input stream