info.debatty.java.graphs

Class NeighborList

java.lang.Object

info.debatty.java.util.SynchronizedBoundedPriorityQueue<Neighbor>

info.debatty.java.graphs.NeighborList

All Implemented Interfaces:

Serializable, Iterable<Neighbor>, Collection<Neighbor>, Queue<Neighbor>

public class NeighborList
extends SynchronizedBoundedPriorityQueue<Neighbor>
implements Serializable

Bounded list of neighbors.

Author:

Thibault Debatty

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NeighborList(int size) Create a new neighborlist of given size.
NeighborList(NeighborList origin) Copy constructor.

Method Summary

Modifier and Type	Method and Description
<T> boolean	containsNode(T node) Returns true if this neighborlist contains a neighbor corresponding to this node.
int	countCommonNodes(NeighborList other_nl) Count the nodes (based on node.id) that are present in both neighborlists.
int	countCommons(NeighborList other) Count the number of equivalent neighbors (using similarities).
void	prune(double threshold) Remove all neighbors with similarity inferior to threshold.
<T> boolean	removeNode(T node) Remove from the neighborlist the neighbor corresponding to this node.

Methods inherited from class info.debatty.java.util.SynchronizedBoundedPriorityQueue

add, addAll, clear, contains, containsAll, element, equals, hashCode, isEmpty, iterator, offer, peek, poll, remove, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

NeighborList

public NeighborList(NeighborList origin)

Copy constructor.

Parameters:

origin -

NeighborList

public NeighborList(int size)

Create a new neighborlist of given size.

Parameters:

size - size of the neighborlist

Method Detail

countCommonNodes

public final int countCommonNodes(NeighborList other_nl)

Count the nodes (based on node.id) that are present in both neighborlists.

Parameters:

other_nl -

Returns:

countCommons

public final int countCommons(NeighborList other)

Count the number of equivalent neighbors (using similarities).

Parameters:

other -

Returns:

containsNode

public final <T> boolean containsNode(T node)

Returns true if this neighborlist contains a neighbor corresponding to this node.

Parameters:

node -

Returns:

removeNode

public final <T> boolean removeNode(T node)

Remove from the neighborlist the neighbor corresponding to this node.

Parameters:

node -

Returns:

true if a neighbor was effectively removed from the list.

prune

public final void prune(double threshold)

Remove all neighbors with similarity inferior to threshold.

Parameters:

threshold -