jsat.linear.vectorcollection

Interface IndexNode<N extends IndexNode>

Type Parameters:

N -

All Known Implementing Classes:

DualTree.SelfAsChildNode

public interface IndexNode<N extends IndexNode>

Method Summary

Modifier and Type	Method and Description
default boolean	allPointsInLeaves()
default java.util.Iterator<java.lang.Integer>	DescendantIterator()
double	furthestDescendantDistance() Returns an upper bound on the farthest distance from this node to any of the points it owns or its children own.
double	furthestPointDistance() Returns an upper bound on the farthest distance from this node to any of the points it owns.
IndexNode	getChild(int indx)
default double	getParentDistance() Gets the distance from this node (or its centroid) to it's parent node (or centroid).
N	getParrent()
int	getPoint(int indx)
Vec	getVec(int indx)
default boolean	hasChildren()
double	maxNodeDistance(N other)
default double[]	minMaxDistance(N other)
double	minNodeDistance(int other) This method returns a lower bound on the minimum distance from a point in or owned by this node to the other point.
double	minNodeDistance(N other) This method returns a lower bound on the minimum distance from a point in or owned by this node to any point in or owner by the other node.
int	numChildren()
int	numPoints()

Method Detail

getParrent

N getParrent()

Returns:

returns the parent node to this one, or null if this node is the root.

minNodeDistance

double minNodeDistance(N other)

This method returns a lower bound on the minimum distance from a point in or owned by this node to any point in or owner by the other node. Because the value return is a lower bound, 0 would always be a valid return value.

Parameters:

other - the other node of points to get the minimum distance to

Returns:

a lower bound on the minimum distance.

maxNodeDistance

double maxNodeDistance(N other)

minMaxDistance

default double[] minMaxDistance(N other)

Parameters:

other -

Returns:

an array where the first value is the minimum distance between nodes, and second value is the maximum

minNodeDistance

double minNodeDistance(int other)

This method returns a lower bound on the minimum distance from a point in or owned by this node to the other point. Because the value return is a lower bound, 0 would always be a valid return value.

Parameters:

other -

Returns:

getParentDistance

default double getParentDistance()

Gets the distance from this node (or its centroid) to it's parent node (or centroid).

Returns:

furthestPointDistance

double furthestPointDistance()

Returns an upper bound on the farthest distance from this node to any of the points it owns.

In the Dual Tree papers, this is often given as ρ(N_i)

Returns:

an upper bound on the distance

furthestDescendantDistance

double furthestDescendantDistance()

Returns an upper bound on the farthest distance from this node to any of the points it owns or its children own.

In the Dual Tree papers, this is often given as λ(Ni)

Returns:

an upper bound on the distance

numChildren

int numChildren()

Returns:

getChild

IndexNode getChild(int indx)

getVec

Vec getVec(int indx)

numPoints

int numPoints()

getPoint

int getPoint(int indx)

hasChildren

default boolean hasChildren()

allPointsInLeaves

default boolean allPointsInLeaves()

DescendantIterator

default java.util.Iterator<java.lang.Integer> DescendantIterator()