sample

Class SingleNodes

java.lang.Object

sample.SingleNodes

public class SingleNodes
extends java.lang.Object

Class SingleNodes stores ordered node pairs and associated values.

Instances of class SingleNodes are not thread safe.

Constructor Summary

Constructors

Constructor and Description
SingleNodes() Creates a new instance of SingleNodes that has an initial value of 0 for each ordered node pair.

Method Summary

Modifier and Type	Method and Description
void	clear() Sets the value of each ordered node pair to 0.
int	enumNode1(int index) Returns the first node of the specified node pair in the list of node pairs with non-zero value.
int	enumNode2(int index) Returns the second node of the specified node pair in a list of node pairs with non-zero value.
float	enumValue(int index) Returns the value of the specified node pair in a list of node pairs with non-zero value.
int	size() Returns the number of node pairs with non-zero value.
void	sumUpdate(int node1, int node2, float value) Adds the specified positive value to the stored value of the specified node pair.
java.lang.String	toString() Returns a string representation of this.
float	value(int node1, int node2) Returns the value of the specified node pair.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleNodes

public SingleNodes()

Creates a new instance of SingleNodes that has an initial value of 0 for each ordered node pair. The first node has index 0.

Method Detail

sumUpdate

public void sumUpdate(int node1,
                      int node2,
                      float value)

Adds the specified positive value to the stored value of the specified node pair.

Parameters:

node1 - the first node

node2 - the second node

value - the value

Throws:

java.lang.IllegalArgumentException - if node1 < 0 || node2 < 0

java.lang.IllegalArgumentException - if value <= 0 || (Double.isFinite(value) == false)

size

public int size()

Returns the number of node pairs with non-zero value.

Returns:

the number of node pairs with non-zero value

enumNode1

public int enumNode1(int index)

Returns the first node of the specified node pair in the list of node pairs with non-zero value. Repeated invocations of this method with the same parameter will return the same value if node values are not modified between invocations. If (index >= 0 && index < this.size()), then the following expression will always evaluate to true:
(this.value(this.enumNode1(index), this.enumNode2(index)) == this.enumValue(index)).

Parameters:

index - an index in a list of node pairs with non-zero value

Returns:

the first node of the specified node pair in a list of node pairs with non-zero value

Throws:

java.lang.IndexOutOfBoundsException - if index < 0 || index >= this.size()

enumNode2

public int enumNode2(int index)

Returns the second node of the specified node pair in a list of node pairs with non-zero value. Repeated invocations of this method with the same parameter will return the same value if node values are not modified between invocations. If (index >= 0 && index < this.size()), then the following expression will always evaluate to true:
(this.value(this.enumNode1(index), this.enumNode2(index)) == this.enumValue(index)).

Parameters:

index - an index in a list of node pairs with non-zero value

Returns:

the second node of the specified node pair in a list of node pairs with non-zero value

Throws:

java.lang.IndexOutOfBoundsException - if index < 0 || index >= this.size()

enumValue

public float enumValue(int index)

Returns the value of the specified node pair in a list of node pairs with non-zero value. Repeated invocations of this method with the same parameter will return the same value if node values are not modified between invocations. If (index >= 0 && index < this.size()), then the following expression will always evaluate to true:
(this.value(this.enumNode1(index), this.enumNode2(index)) == this.enumValue(index)).

Parameters:

index - an index in a list of node pairs with non-zero value

Returns:

the value of the specified ordered node pair in a list of node pairs with non-zero value

Throws:

java.lang.IndexOutOfBoundsException - if index < 0 || index >= this.size()

value

public float value(int node1,
                   int node2)

Returns the value of the specified node pair.

Parameters:

node1 - the first node

node2 - the second node

Returns:

the value of the specified node pair

Throws:

java.lang.IllegalArgumentException - if node1 < 0 || node2 < 0

clear

public void clear()

Sets the value of each ordered node pair to 0.

toString

public java.lang.String toString()

Returns a string representation of this. The exact details of the representation are unspecified and subject to change.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this