info.debatty.java.graphs

Class NeighborList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

java.util.PriorityQueue<E>

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

info.debatty.java.graphs.NeighborList

All Implemented Interfaces:

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

public class NeighborList
extends BoundedPriorityQueue<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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsNode(Node node) Returns true if this neighborlist contains a neighbor corresponding to this node.
static ArrayList<Edge>	Convert2Edges(HashMap<Node,NeighborList> graph)
int	countCommonIds(NeighborList other_nl) Count the nodes (based on node.id) that are present in both neighborlists.
int	countCommons(NeighborList other)
int	countCommonValues(NeighborList other_nl) Count the values (using node.value) that are present in both neighborlists.
boolean	removeNode(Node node) Remove from the neighborlist the neighbor corresponding to this node.

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

add

Methods inherited from class java.util.PriorityQueue

clear, comparator, contains, iterator, offer, peek, poll, remove, size, toArray, toArray

Methods inherited from class java.util.AbstractQueue

addAll, element, remove

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, 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

containsAll, equals, hashCode, isEmpty, removeAll, retainAll

Constructor Detail

NeighborList

public NeighborList(int size)

Create a new neighborlist of given size.

Parameters:

size - size of the neighborlist

Method Detail

Convert2Edges

public static ArrayList<Edge> Convert2Edges(HashMap<Node,NeighborList> graph)

countCommonValues

public final int countCommonValues(NeighborList other_nl)

Count the values (using node.value) that are present in both neighborlists. Uses node.value.equals(other_node.value). Neighborlists are not modified.

Parameters:

other_nl -

Returns:

the number of values that are present in both neighborlists

countCommonIds

public final int countCommonIds(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)

Parameters:

other -

Returns:

containsNode

public final boolean containsNode(Node node)

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

Parameters:

node -

Returns:

removeNode

public final boolean removeNode(Node node)

Remove from the neighborlist the neighbor corresponding to this node.

Parameters:

node -

Returns:

true if a neighbor was effectively removed from the list.