com.tdunning.math.stats

Class GroupTree

java.lang.Object

java.util.AbstractCollection<Centroid>

com.tdunning.math.stats.GroupTree

All Implemented Interfaces:

Iterable<Centroid>, Collection<Centroid>

public class GroupTree
extends AbstractCollection<Centroid>

A tree containing TDigest.Centroid. This adds to the normal NavigableSet the ability to sum up the size of elements to the left of a particular group.

Constructor Summary

Constructors

Constructor and Description
GroupTree()
GroupTree(Centroid leaf)
GroupTree(GroupTree left, GroupTree right)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(Centroid centroid)
Centroid	ceiling(Centroid base)
void	checkBalance()
Centroid	first()
Centroid	floor(Centroid base)
int	headCount(Centroid base)
long	headSum(Centroid base)
Iterator<Centroid>	iterator() Iteratres through all groups in the tree.
Centroid	last()
void	move(double x, int count, Centroid v, Iterable<? extends Double> data) Modify an existing value in the tree subject to the constraint that the change will not alter the ordering of the tree.
void	print(int depth)
void	remove(Centroid base)
int	size()
long	sum()
Iterable<Centroid>	tailSet(Centroid start)

Methods inherited from class java.util.AbstractCollection

addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode

Constructor Detail

GroupTree

public GroupTree()

GroupTree

public GroupTree(Centroid leaf)

GroupTree

public GroupTree(GroupTree left,
         GroupTree right)

Method Detail

add

public boolean add(Centroid centroid)

Specified by:

add in interface Collection<Centroid>

Overrides:

add in class AbstractCollection<Centroid>

move

public void move(double x,
        int count,
        Centroid v,
        Iterable<? extends Double> data)

Modify an existing value in the tree subject to the constraint that the change will not alter the ordering of the tree.

Parameters:

x - New value to add to Centroid

count - Weight of new value

v - The value to modify

data - The recorded data

size

public int size()

Specified by:

size in interface Collection<Centroid>

Specified by:

size in class AbstractCollection<Centroid>

headCount

public int headCount(Centroid base)

Returns:

the number of items strictly before the current element

headSum

public long headSum(Centroid base)

Returns:

the sum of the size() function for all elements strictly before the current element.

first

public Centroid first()

Returns:

the first Centroid in this set

iterator

public Iterator<Centroid> iterator()

Iteratres through all groups in the tree.

Specified by:

iterator in interface Iterable<Centroid>

Specified by:

iterator in interface Collection<Centroid>

Specified by:

iterator in class AbstractCollection<Centroid>

remove

public void remove(Centroid base)

floor

public Centroid floor(Centroid base)

Returns:

the largest element less than or equal to base

last

public Centroid last()

ceiling

public Centroid ceiling(Centroid base)

Returns:

the smallest element greater than or equal to base.

tailSet

public Iterable<Centroid> tailSet(Centroid start)

Returns:

the subset of elements equal to or greater than base.

sum

public long sum()

checkBalance

public void checkBalance()

print

public void print(int depth)