sample

Class HapNodes

java.lang.Object

sample.HapNodes

public class HapNodes
extends java.lang.Object

Class HapNodes stores nodes and associated values.

Instances of class HapNodes are not thread safe.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clear() Sets the value of each node to 0.
int	enumNode(int index) Returns the specified node in a list of nodes with non-zero value.
float	enumValue(int index) Returns the value of the specified node in a list of nodes with non-zero value.
int	size() Returns the number of nodes with non-zero value.
void	sumUpdate(int node, float value) Adds the specified value to the stored value of the specified node.
java.lang.String	toString() Returns a string representation of this.
float	value(int node) Returns the specified node value.

Methods inherited from class java.lang.Object

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

Constructor Detail

HapNodes

public HapNodes()

Creates a new instance of HapNodes that has an initial value of 0 for each node.

Method Detail

sumUpdate

public void sumUpdate(int node,
                      float value)

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

Parameters:

node - the node

value - the value

Throws:

java.lang.IllegalArgumentException - if node < 0

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

size

public int size()

Returns the number of nodes with non-zero value.

Returns:

the number of nodes with non-zero value

enumNode

public int enumNode(int index)

Returns the specified node in a list of nodes 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.enumNode(index)) == this.enumValue(index)).

Parameters:

index - an index in a list of nodes with non-zero value

Returns:

the specified node in the list of nodes 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 in a list of nodes 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.enumNode(index)) == this.enumValue(index)).

Parameters:

index - an index in a list of nodes with non-zero value

Returns:

the value of the specified node in a list of nodes with non-zero value

Throws:

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

value

public float value(int node)

Returns the specified node value.

Parameters:

node - the first node

Returns:

the specified node value

Throws:

java.lang.IllegalArgumentException - if node < 0

clear

public void clear()

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