Constructor
new LengthPermutation(reverse)
Constructs a LengthPermutation
Parameters:
| Name | Type | Description |
|---|---|---|
reverse |
Boolean | If true, the ordering of hosts is reversed |
- Source:
Extends
Methods
addGraph(graph)
Adds a graph to the HostPermutation. HostPermutation determines an ordering
of hosts based on the hosts of graphs added using this method
Parameters:
| Name | Type | Description |
|---|---|---|
graph |
ModelGraph | The graph to add |
- Inherited From:
- Source:
getHostColor(host) → {String}
Gets the designated color of the specified host
Parameters:
| Name | Type | Description |
|---|---|---|
host |
String | The host whose color you want to retrieve |
- Inherited From:
- Source:
Returns:
A valid color string.
- Type
- String
getHostColors() → {Object.<String, String>}
Returns all designated host colors
- Inherited From:
- Source:
Returns:
A mapping of host name to host color
- Type
- Object.<String, String>
getHosts() → {Array.<String>}
Gets a list of hosts in the order determined by the HostPermutation. Note
that you must call update to compute the ordering of hosts before
retrieving it with this method
- Inherited From:
- Source:
Returns:
Array of hosts
- Type
- Array.<String>
getHostsAndFilter(filter) → {Array.<String>}
Gets a list of hosts in the order determined by the HostPermutation. Only
hosts contained in both this HostPermutation and the filter array will be
returned. Note that you must call update to compute the ordering of
hosts before retrieving it with this method.
Parameters:
| Name | Type | Description |
|---|---|---|
filter |
Array.<String> | The filter array. |
- Inherited From:
- Source:
Returns:
Array of hosts
- Type
- Array.<String>
update()
Overrides HostPermutation#update
- Overrides:
- Source: