RecombSingleNodes

java.lang.Object
- sample.RecombSingleNodes

```
public class RecombSingleNodes
extends java.lang.Object
```
Class RecombSingleNodes stores ordered node pairs and associated values.

Instances of class RecombSingleNodes are not thread safe.

Constructor Summary

Constructors
Constructor and Description

RecombSingleNodes(int nNodes)
Creates a new instance of RecombSingleNodes that has an initial value of 0 for each ordered node pair.

Constructors
Constructor and Description
`RecombSingleNodes(int nNodes)` Creates a new instance of `RecombSingleNodes` that has an initial value of 0 for each ordered node pair.

Method Summary

All Methods Instance Methods Concrete Methods
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`	`nNodes()` Returns the number of nodes.
`int`	`size()` Returns the number of node pairs with non-zero value.
`float`	`sumNode1Value(int node1)` Returns the sum of the values of the node pairs that have the specified first node
`float`	`sumNode2Value(int node2)` Returns the sum of the values of the node pairs that have the specified second node.
`void`	`sumUpdate(int node1, int node2, float value)` Adds the specified positive value to the stored value of the specified node pair.
`float`	`sumValue()` Returns the sum of the values of all node pairs.
`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
  - RecombSingleNodes
```
public RecombSingleNodes(int nNodes)
```
    Creates a new instance of RecombSingleNodes that has an initial value of 0 for each ordered node pair. The first node has index 0.
    
    Parameters:
    
    nNodes - the maximum number of distinct nodes which will be paired to form ordered node pairs
    
    Throws:
    
    java.lang.IllegalArgumentException - if nNodes < 1
- 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.IndexOutOfBoundsException - if node1 < 0 || node1 >= this.nNodes()
    
    java.lang.IndexOutOfBoundsException - if node2 < 0 || node2 >= this.nNodes()
    
    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
  - nNodes
```
public int nNodes()
```
    Returns the number of nodes.
    
    Returns:
    
    the number of nodes
  - 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
  - sumNode1Value
```
public float sumNode1Value(int node1)
```
    Returns the sum of the values of the node pairs that have the specified first node
    
    Parameters:
    
    node1 - a node
    
    Returns:
    
    the sum of the values of the node pairs that have the specified first node
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if node1 < 0 || node1 >= this.nNodes()
  - sumNode2Value
```
public float sumNode2Value(int node2)
```
    Returns the sum of the values of the node pairs that have the specified second node.
    
    Parameters:
    
    node2 - a node
    
    Returns:
    
    the sum of the values of the node pairs that have the specified second node
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if node2 < 0 || node2 >= this.nNodes()
  - sumValue
```
public float sumValue()
```
    Returns the sum of the values of all node pairs.
    
    Returns:
    
    the sum of the values of all node pairs
  - 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

Class RecombSingleNodes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecombSingleNodes

Method Detail

sumUpdate

size

nNodes

enumNode1

enumNode2

enumValue

value

sumNode1Value

sumNode2Value

sumValue

clear

toString