sample

Class DuoNodes

java.lang.Object

sample.DuoNodes

public class DuoNodes
extends java.lang.Object

Class DuoNodes stores ordered node trios and associated values.

Instances of class DuoNodes are not thread safe.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clear() Sets the value of each node trio to 0.
int	enumNodeA2(int index) Returns the second node of the specified node trio in a list of node trios with non-zero value.
int	enumNodeAB1(int index) Returns the first node of the specified node trio in a list of node trios with non-zero value.
int	enumNodeB2(int index) Returns the third node of the specified node trio in a list of node trios with non-zero value.
float	enumValue(int index) Returns the value of the specified ordered node trio in a list of node trios with non-zero value.
int	size() Returns the number of node trios with non-zero value.
void	sumUpdate(int nodeAB1, int nodeA2, int nodeB2, float value) Adds the specified value to the stored value of the specified node trio.
java.lang.String	toString() Returns a string representation of this.
float	value(int nodeAB1, int nodeA2, int nodeB2) Returns the specified node trio value.

Methods inherited from class java.lang.Object

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

Constructor Detail

DuoNodes

public DuoNodes()

Creates a new instance of DuoNodes that has an initial value of 0 for each ordered node trio.

Method Detail

sumUpdate

public void sumUpdate(int nodeAB1,
                      int nodeA2,
                      int nodeB2,
                      float value)

Adds the specified value to the stored value of the specified node trio.

Parameters:

nodeAB1 - the first node

nodeA2 - the second node

nodeB2 - the third node

value - the value

Throws:

java.lang.IllegalArgumentException - if (nodeAB1 < 0 || nodeA2 < 0 || nodeB2 < 0)

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

size

public int size()

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

Returns:

the number of node trios with non-zero value

enumNodeAB1

public int enumNodeAB1(int index)

Returns the first node of the specified node trio in a list of node trios 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.enumNodeAB1(index), this.enumNodeA2(index), this.enumNodeB2(index)) == this.enumValue(index)).

Parameters:

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

Returns:

the first node of the specified node trio in a list of node trios with non-zero value

Throws:

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

enumNodeA2

public int enumNodeA2(int index)

Returns the second node of the specified node trio in a list of node trios 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.enumNodeAB1(index), this.enumNodeA2(index), this.enumNodeB2(index)) == this.enumValue(index)).

Parameters:

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

Returns:

the second node of the specified node trio in a list of node trios with non-zero value

Throws:

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

enumNodeB2

public int enumNodeB2(int index)

Returns the third node of the specified node trio in a list of node trios 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.enumNodeAB1(index), this.enumNodeA2(index), this.enumNodeB2(index)) == this.enumValue(index)).

Parameters:

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

Returns:

the third node of the specified node trio in a list of node trios 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 ordered node trio in a list of node trios 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.enumNodeAB1(index), this.enumNodeA2(index), this.enumNodeB2(index)) == this.enumValue(index)).

Parameters:

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

Returns:

the value of the specified ordered node trio in a list of node trios with non-zero value

Throws:

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

value

public float value(int nodeAB1,
                   int nodeA2,
                   int nodeB2)

Returns the specified node trio value.

Parameters:

nodeAB1 - the first node

nodeA2 - the second node

nodeB2 - the third node

Returns:

the specified node trio value

Throws:

java.lang.IllegalArgumentException - if (nodeAB1 < 0 || nodeA2 < 0 || nodeB2 < 0)

clear

public void clear()

Sets the value of each node trio 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.