Skip to content

Commit

Permalink
Document removing Graph::isEmpty()
Browse files Browse the repository at this point in the history
  • Loading branch information
clue committed Aug 4, 2013
1 parent 6074414 commit 58686ad
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ As such, its static factory methods had to be renamed. Update your references if
| `Cycle::factoryFromVertices()` | `Walk::factoryCycleFromVertices()` |
| `Cycle::factoryFromEdges()` | `Walk::factoryCycleFromEdges()` |

* BC break: Remove `Graph::isEmpty()` because it's not well-defined and might
be confusing. Most literature suggests it should check for existing edges,
whereas the old behavior was to check for existing vertices instead. Use either
of the more transparent methods
`Algorithm\Property\GraphProperty::isNull()` (old behavior) or (where applicable)
`Algorithm\Property\GraphProperty::isEmpty()` ([#59](https://github.com/clue/graph/issues/59)).
* BC break: Each of the above methods (`Walk::factoryCycleFromPredecessorMap()`,
`Walk::factoryCycleFromVertices()`, `Walk::factoryCycleFromEdges()`) now
actually makes sure the returned `Walk` instance is actually a valid Cycle,
Expand Down

0 comments on commit 58686ad

Please sign in to comment.