Skip to content

Commit d574b65

Browse files
authored
Move changelog to RELEASES.rst and add 0.6 changes (#451)
* Move the changelog to RELEASES.rst Following rust's repo format * Add 0.6.0 changes
1 parent 44142c7 commit d574b65

2 files changed

Lines changed: 526 additions & 373 deletions

File tree

‎README.rst‎

Lines changed: 3 additions & 373 deletions
Original file line numberDiff line numberDiff line change
@@ -30,380 +30,10 @@ Crate feature flags:
3030
Recent Changes
3131
--------------
3232

33-
- 0.5.1
33+
See RELEASES_ for a list of changes.
34+
The minimum supported rust version will only change on major releases.
3435

35-
- Implement ``Default`` for traversals.
36-
- Export ``EdgesConnecting`` publicly.
37-
- Implement ``is_bipartite_graph``.
38-
- Add ``FilterNode`` implementation for ``FixedBitSet`` and ``HashSet``.
39-
- Implement ``node_weights_mut`` and ``edge_weights_mut`` for ``StableGraph``.
40-
- Add configurable functions for adding attributes to dotfile features.
41-
42-
- 0.5.0
43-
44-
- Breaking changes:
45-
46-
- The iterative DFS implementation, ``Dfs``, now marks nodes visited when
47-
they are pushed onto the stack, not when they're popped off. This may
48-
require changes to callers that use ``Dfs::from_parts`` or manipulate
49-
its internals.
50-
- The ``IntoEdgesDirected`` trait now has a stricter contract for
51-
undirected graphs. Custom implementations of this trait may have to be
52-
updated. See the `trait documentation`__ for more.
53-
54-
- Other changes:
55-
56-
- Upgrade to Rust 2018 edition
57-
- Fix clippy warnings and unify code formatting
58-
- Improved and enhanced documentation
59-
- Update dependencies including modern quickcheck
60-
- Numerous bugfixes and refactorings
61-
- Added ``MatrixGraph`` implementation
62-
63-
__ https://docs.rs/petgraph/0.5/petgraph/visit/trait.IntoEdgesDirected.html
64-
65-
- 0.4.13
66-
67-
- Fix clippy warnings by @jonasbb
68-
- Add docs for ``Csr`` by @ksadorf
69-
- Fix conflict with new stable method ``find_map`` in new Rust
70-
71-
- 0.4.12
72-
73-
- Newtype ``Time`` now also implements ``Hash``
74-
- Documentation updates for ``Frozen``.
75-
76-
- 0.4.11
77-
78-
- Fix ``petgraph::graph::NodeReferences`` to be publicly visible
79-
- Small doc typo and code style files by @shepmaster and @waywardmonkeys
80-
- Fix a future compat warning with pointer casts
81-
82-
- 0.4.10
83-
84-
- Add graph trait ``IntoEdgesDirected``
85-
- Update dependencies
86-
87-
- 0.4.9
88-
89-
- Fix ``bellman_ford`` to work correctly with undirected graphs (#152) by
90-
@carrutstick
91-
- Performance improvements for ``Graph, Stablegraph``'s ``.map()``.
92-
93-
- 0.4.8
94-
95-
- ``StableGraph`` learned new methods nearing parity with ``Graph``. Note
96-
that the ``StableGraph`` methods preserve index stability even in the batch
97-
removal methods like ``filter_map`` and ``retain_edges``.
98-
99-
+ Added ``.filter_map()``, which maps associated node and edge data
100-
+ Added ``.retain_edges()``, ``.edge_indices()`` and ``.clear_edges()``
101-
102-
- Existing ``Graph`` iterators gained some trait impls:
103-
104-
+ ``.node_indices(), .edge_indices()`` are ``ExactSizeIterator``
105-
+ ``.node_references()`` is now
106-
``DoubleEndedIterator + ExactSizeIterator``.
107-
+ ``.edge_references()`` is now ``ExactSizeIterator``.
108-
109-
- Implemented ``From<StableGraph>`` for ``Graph``.
110-
111-
- 0.4.7
112-
113-
- New algorithm by @jmcomets: A* search algorithm in ``petgraph::algo::astar``
114-
- One ``StableGraph`` bug fix whose patch was supposed to be in the previous
115-
version:
116-
117-
+ ``add_edge(m, n, _)`` now properly always panics if nodes m or n don't
118-
exist in the graph.
119-
120-
- 0.4.6
121-
122-
- New optional crate feature: ``"serde-1"``, which enables serialization
123-
for ``Graph`` and ``StableGraph`` using serde.
124-
- Add methods ``new``, ``add_node`` to ``Csr`` by @jmcomets
125-
- Add indexing with ``[]`` by node index, ``NodeCompactIndexable`` for
126-
``Csr`` by @jmcomets
127-
- Amend doc for ``GraphMap::into_graph`` (it has a case where it can panic)
128-
- Add implementation of ``From<Graph>`` for ``StableGraph``.
129-
- Add implementation of ``IntoNodeReferences`` for ``&StableGraph``.
130-
- Add method ``StableGraph::map`` that maps associated data
131-
- Add method ``StableGraph::find_edge_undirected``
132-
- Many ``StableGraph`` bug fixes involving node vacancies (holes left by
133-
deletions):
134-
135-
+ ``neighbors(n)`` and similar neighbor and edge iterator methods now
136-
handle n being a vacancy properly. (This produces an empty iterator.)
137-
+ ``find_edge(m, n)`` now handles m being a vacancy correctly too
138-
+ ``StableGraph::node_bound`` was fixed for empty graphs and returns 0
139-
140-
- Add implementation of ``DoubleEndedIterator`` to ``Graph, StableGraph``'s
141-
edge references iterators.
142-
- Debug output for ``Graph`` now shows node and edge count. ``Graph, StableGraph``
143-
show nothing for the edges list if it's empty (no label).
144-
- ``Arbitrary`` implementation for ``StableGraph`` now can produce graphs with
145-
vacancies (used by quickcheck)
146-
147-
- 0.4.5
148-
149-
- Fix ``max`` ambiguity error with current rust nightly by @daboross (#153)
150-
151-
- 0.4.4
152-
153-
- Add ``GraphMap::all_edges_mut()`` iterator by @Binero
154-
- Add ``StableGraph::retain_nodes`` by @Rupsbant
155-
- Add ``StableGraph::index_twice_mut`` by @christolliday
156-
157-
- 0.4.3
158-
159-
- Add crate categories
160-
161-
- 0.4.2
162-
163-
- Move the ``visit.rs`` file due to changed rules for a module’s directory
164-
ownership in Rust, resolving a future compat warning.
165-
- The error types ``Cycle, NegativeCycle`` now implement ``PartialEq``.
166-
167-
- 0.4.1
168-
169-
- Add new algorithm ``simple_fast`` for computing dominators in a control-flow
170-
graph.
171-
172-
- 0.4.0
173-
174-
- Breaking changes in ``Graph``:
175-
176-
- ``Graph::edges`` and the other edges methods now return an iterator of
177-
edge references
178-
179-
- Other breaking changes:
180-
181-
- ``toposort`` now returns an error if the graph had a cycle.
182-
- ``is_cyclic_directed`` no longer takes a dfs space argument. It is
183-
now recursive.
184-
- ``scc`` was renamed to ``kosaraju_scc``.
185-
- ``min_spanning_tree`` now returns an iterator that needs to be
186-
made into a specific graph type deliberately.
187-
- ``dijkstra`` now uses the ``IntoEdges`` trait.
188-
- ``NodeIndexable`` changed its method signatures.
189-
- ``IntoExternals`` was removed, and many other smaller adjustments
190-
in graph traits. ``NodeId`` must now implement ``PartialEq``, for example.
191-
- ``DfsIter, BfsIter`` were removed in favour of a more general approach
192-
with the ``Walker`` trait and its iterator conversion.
193-
194-
- New features:
195-
196-
- New graph traits, for example ``IntoEdges`` which returns
197-
an iterator of edge references. Everything implements the graph traits
198-
much more consistently.
199-
- Traits for associated data access and building graphs: ``DataMap``,
200-
``Build, Create, FromElements``.
201-
- Graph adaptors: ``EdgeFiltered``. ``Filtered`` was renamed to ``NodeFiltered``.
202-
- New algorithms: bellman-ford
203-
- New graph: compressed sparse row (``Csr``).
204-
- ``GraphMap`` implements ``NodeIndexable``.
205-
- ``Dot`` was generalized
206-
207-
- 0.3.2
208-
209-
- Add ``depth_first_search``, a recursive dfs visitor that emits discovery,
210-
finishing and edge classification events.
211-
- Add graph adaptor ``Filtered``.
212-
- impl ``Debug, NodeIndexable`` for ``Reversed``.
213-
214-
- 0.3.1
215-
216-
- Add ``.edges(), .edges_directed()`` to ``StableGraph``. Note that these
217-
differ from ``Graph``, because this is the signature they will all use
218-
in the future.
219-
- Add ``.update_edge()`` to ``StableGraph``.
220-
- Add reexports of common items in ``stable_graph`` module (for example
221-
``NodeIndex``).
222-
- Minor performance improvements to graph iteration
223-
- Improved docs for ``visit`` module.
224-
225-
- 0.3.0
226-
227-
- Overhaul all graph visitor traits so that they use the ``IntoIterator``
228-
style. This makes them composable.
229-
230-
- Multiple graph algorithms use new visitor traits.
231-
- **Help is welcome to port more algorithms (and create new graph traits in
232-
the process)!**
233-
234-
- ``GraphMap`` can now have directed edges. ``GraphMap::new`` is now generic
235-
in the edge type. ``DiGraphMap`` and ``UnGraphMap`` are new type aliases.
236-
- Add type aliases ``DiGraph, UnGraph, StableDiGraph, StableUnGraph``
237-
- ``GraphMap`` is based on the indexmap crate. Deterministic iteration
238-
order, faster iteration, no side tables needed to convert to ``Graph``.
239-
- Improved docs for a lot of types and functions.
240-
- Add graph visitor ``DfsPostOrder``
241-
- ``Dfs`` gained new methods ``from_parts`` and ``reset``.
242-
- New algo ``has_path_connecting``.
243-
- New algo ``tarjan_scc``, a second scc implementation.
244-
- Document traversal order in ``Dfs, DfsPostOrder, scc, tarjan_scc``.
245-
- Optional graph visitor workspace reuse in ``has_path_connecting``,
246-
``is_cyclic_directed, toposort``.
247-
- Improved ``Debug`` formatting for ``Graph, StableGraph``.
248-
- Add a prelude module
249-
- ``GraphMap`` now has a method ``.into_graph()`` that makes a ``Graph``.
250-
- ``Graph::retain_nodes, retain_edges`` now expose the self graph only
251-
as wrapped in ``Frozen``, so that weights can be mutated but the
252-
graph structure not.
253-
- Enable ``StableGraph`` by default
254-
- Add method ``Graph::contains_edge``.
255-
- Renamed ``EdgeDirection`` → ``Direction``.
256-
- Remove ``SubTopo``.
257-
- Require Rust 1.12 or later
258-
259-
- 0.2.10
260-
261-
- Fix compilation with rust nightly
262-
263-
- 0.2.9
264-
265-
- Fix a bug in SubTopo (#81)
266-
267-
- 0.2.8
268-
269-
- Add Graph methods reserve_nodes, reserve_edges, reserve_exact_nodes,
270-
reserve_exact_edges, shrink_to_fit_edges, shrink_to_fit_nodes, shrink_to_fit
271-
272-
- 0.2.7
273-
274-
- Update URLs
275-
276-
- 0.2.6
277-
278-
- Fix warning about type parameter defaults (no functional change)
279-
280-
- 0.2.5
281-
282-
- Add SubTopo, a topo walker for the subgraph reachable from a starting point.
283-
- Add condensation, which forms the graph of a graph’s strongly connected
284-
components.
285-
286-
- 0.2.4
287-
288-
- Fix an algorithm error in scc (#61). This time we have a test that
289-
crosschecks the result of the algorithm vs another implementation, for
290-
greater confidence in its correctness.
291-
292-
- 0.2.3
293-
294-
- Require Rust 1.6: Due to changes in how rust uses type parameter defaults.
295-
- Implement Graph::clone_from.
296-
297-
- 0.2.2
298-
299-
- Require Rust 1.5
300-
- ``Dot`` passes on the alternate flag to node and edge label formatting
301-
- Add ``Clone`` impl for some iterators
302-
- Document edge iteration order for ``Graph::neighbors``
303-
- Add *experimental feature* ``StableGraph``, using feature flag ``stable_graph``
304-
305-
- 0.2.1
306-
307-
- Add algorithm ``is_isomorphic_matching``
308-
309-
- 0.2.0
310-
311-
- New Features
312-
313-
- Add Graph::neighbors().detach() to step edges without borrowing.
314-
This is more general than, and replaces now deprecated
315-
walk_edges_directed. (#39)
316-
- Implement Default for Graph, GraphMap
317-
- Add method EdgeDirection::opposite()
318-
319-
- Breaking changes
320-
321-
- Graph::neighbors() for undirected graphs and Graph::neighbors_undirected
322-
for any graph now visit self loop edges once, not twice. (#31)
323-
- Renamed Graph::without_edges to Graph::externals
324-
- Removed Graph::edges_both
325-
- GraphMap::add_edge now returns ``Option<E>``
326-
- Element type of ``GraphMap<N, E>::all_edges()`` changed to ``(N, N, &E)``
327-
328-
- Minor breaking changes
329-
330-
- IntoWeightedEdge changed a type parameter to associated type
331-
- IndexType is now an unsafe trait
332-
- Removed IndexType::{one, zero}, use method new instead.
333-
- Removed MinScored
334-
- Ptr moved to the graphmap module.
335-
- Directed, Undirected are now void enums.
336-
- Fields of graphmap::Edges are now private (#19)
337-
338-
- 0.1.18
339-
340-
- Fix bug on calling GraphMap::add_edge with existing edge (#35)
341-
342-
- 0.1.17
343-
344-
- Add Graph::capacity(), GraphMap::capacity()
345-
- Fix bug in Graph::reverse()
346-
- Graph and GraphMap have `quickcheck::Arbitrary` implementations,
347-
if optional feature `check` is enabled.
348-
349-
- 0.1.16
350-
351-
- Add Graph::node_indices(), Graph::edge_indices()
352-
- Add Graph::retain_nodes(), Graph::retain_edges()
353-
- Add Graph::extend_with_edges(), Graph::from_edges()
354-
- Add functions petgraph::graph::{edge_index, node_index};
355-
- Add GraphMap::extend(), GraphMap::from_edges()
356-
- Add petgraph::dot::Dot for simple graphviz dot output
357-
358-
- 0.1.15
359-
360-
- Add Graph::clear_edges()
361-
- Add Graph::edge_endpoints()
362-
- Add Graph::map() and Graph::filter_map()
363-
364-
- 0.1.14
365-
366-
- Add new topological order visitor Topo
367-
- New graph traits NeighborsDirected, Externals, Revisitable
368-
369-
- 0.1.13
370-
371-
- Add iterator GraphMap::all_edges
372-
373-
- 0.1.12
374-
375-
- Fix an algorithm error in scc (#14)
376-
377-
- 0.1.11
378-
379-
- Update for well-formedness warnings (Rust RFC 1214), adding
380-
new lifetime bounds on NeighborIter and Dfs, impact should be minimal.
381-
382-
- 0.1.10
383-
384-
- Fix bug in WalkEdges::next_neighbor()
385-
386-
- 0.1.9
387-
388-
- Fix Dfs/Bfs for a rustc bugfix that disallowed them
389-
- Add method next_neighbor() to WalkEdges
390-
391-
- 0.1.8
392-
393-
- Add Graph::walk_edges_directed()
394-
- Add Graph::index_twice_mut()
395-
396-
- 0.1.7
397-
398-
- Add Graph::edges_directed()
399-
400-
- 0.1.6
401-
402-
- Add Graph::node_weights_mut and Graph::edge_weights_mut
403-
404-
- 0.1.4
405-
406-
- Add back DfsIter, BfsIter
36+
.. _RELEASES: RELEASES.rst
40737

40838
License
40939
-------

0 commit comments

Comments
 (0)