portgraph 0.8.0

Data structure library for directed graphs with first-level ports.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

# Release notes

## v0.8.0 (2023-08-08)

### Added

- `view::FilteredGraph` for filtering both nodes and links of a graph ([#100][])
- `view::SubGraph` for views into non-hierarchical subgraphs ([#100][])

### Changed

- `view::NodeFiltered` is now a specialized version of `view::FilteredGraph`.
  Its constructor has been renamed to `NodeFiltered::new_node_filtered`. ([#100][])

  [#100]: https://github.com/CQCL/portgraph/issues/100

## v0.7.2 (2023-07-31)

### Added

- `algorithms::ConvexChecker` to check convexity property of subgraphs of `LinkView`s ([#97][])

### Changed

- References to `PortView`s and `LinkView`s also implement the traits ([#94][])
- `Toposort` now works with any `LinkView` object ([#96][])

  [#94]: https://github.com/CQCL/portgraph/issues/94
  [#96]: https://github.com/CQCL/portgraph/issues/96
  [#97]: https://github.com/CQCL/portgraph/issues/97

## v0.7.1 (2023-07-13)

### Fixed

- Only yield output neighbours in petgraph's IntoNeighbors trait implementation ([#88][])
- Fix incorrect dot rendering of the hierarchy for flat filtered regions ([#91][])

  [#88]: https://github.com/CQCL/portgraph/issues/88
  [#91]: https://github.com/CQCL/portgraph/issues/91

## v0.7.0 (2023-06-28)

### Added

- `LinkMut::insert_graph` to insert a full graph into an existing graph ([#80][])
- `PortMut::swap_nodes` to swap node indices ([#83][])
- `Hierarchy::swap_nodes` to swap node indices ([#87][])
- `Debug` and `Default` implementation for multiple iterators ([#81][])

### Removed

- Removed the `substitute` module ([#82][])

  [#80]: https://github.com/CQCL/portgraph/issues/80
  [#81]: https://github.com/CQCL/portgraph/issues/81
  [#82]: https://github.com/CQCL/portgraph/issues/82
  [#83]: https://github.com/CQCL/portgraph/issues/83
  [#87]: https://github.com/CQCL/portgraph/issues/87

## v0.6.0 (2023-06-21)

### Added

- `NodeFiltered`, `Region`, and `FlatRegion` graph wrappers ([#77][])
- Implemented the petgraph visit traits for the graph wrappers ([#78][])
- Benchmarks for the `toposort` algorithm ([#75][])

### Changed

- Split the `PortView`, `LinkView`, and `MultiView` traits into separate `*View` and `*Mut` traits ([#76][])
- Replaced `NonZeroU16` in `PortOffset::Incoming` with `u16` ([#73][])

### Fixed

- Fix dot formatter not hiding "Hidden" ports ([#74][])

  [#73]: https://github.com/CQCL/portgraph/issues/73
  [#74]: https://github.com/CQCL/portgraph/issues/74
  [#75]: https://github.com/CQCL/portgraph/issues/75
  [#76]: https://github.com/CQCL/portgraph/issues/76
  [#77]: https://github.com/CQCL/portgraph/issues/77
  [#78]: https://github.com/CQCL/portgraph/issues/78

## v0.5.0 (2023-06-14)

### Added

- Added a MultiPortGraph structure that supports multiple connections to the same port ([#67][])
- Added new traits `PortView`, `LinkView`, and `MultiView` to unify the
  `PortGraph` and `MultiPortGraph` interfaces ([#68][])
- Added a `petgraph` feature that implements petgraph's `visit` traits for interoperability ([#70][])
- Added missing `Debug` implementations for iterators ([#65][])

### Changed

- Reworked the dot formatter API ([#69][])
- The serialized format for NodeIndex and PortIndex now uses the user-facing
  indices instead of the off-by-one values used internally ([#64][])
- Simplified PortGraph debug information by showing the ports of a node as a range ([#66][])

  [#64]: https://github.com/CQCL/portgraph/issues/64
  [#65]: https://github.com/CQCL/portgraph/issues/65
  [#66]: https://github.com/CQCL/portgraph/issues/66
  [#67]: https://github.com/CQCL/portgraph/issues/67
  [#68]: https://github.com/CQCL/portgraph/issues/68
  [#69]: https://github.com/CQCL/portgraph/issues/69
  [#70]: https://github.com/CQCL/portgraph/issues/70

## v0.4.0 (2023-06-06)

### Added

- `SecondaryMap::remove` method to drop stored ([#59][])
- `PortGraph::link_offsets`  ([#58][])
- Implemented `SecondaryMap` for `HashSet`s to efficiently store sparse flags for nodes and ports ([#62][])
- Generalized the `Iterator` impl of `TopoSort` to any `SecondaryMap` ([#63][])

### Changed

- Changed the `PortGraph::set_num_ports` callback to give more information using a new `PortOperation` ([#57][])
- Allows `PortGraph::link_ports` to connect ports in any order, as long as the directions are compatible ([#58][])

  [#57]: https://github.com/CQCL/portgraph/issues/57
  [#58]: https://github.com/CQCL/portgraph/issues/58
  [#59]: https://github.com/CQCL/portgraph/issues/59
  [#62]: https://github.com/CQCL/portgraph/issues/62
  [#63]: https://github.com/CQCL/portgraph/issues/63

## v0.3.0 (2023-05-31)

### Breaking changes

- Renamed `SecondaryMap` to `UnmanagedDenseMap` ([#51][])

### New features

- Added a `SecondaryMap` generic trait, implemented by `UnmanagedDenseMap` and `BitVec` ([#51][])
- Added a generic `Map : SecondaryMap` type parameter to the dominators and toposort algorithms,
  allowing more efficient executions on partially explored graphs ([#51][])

### Fixes

- Fix incorrect port count update when resizing ports in-place ([#53][])

  [#51]: https://github.com/CQCL/portgraph/issues/51
  [#53]: https://github.com/CQCL/portgraph/issues/53

## v0.2.4 (2023-05-25)

- Add `as_range` methods to `NodePorts` and `NodePortOffsets` ([#49][], [#50][])
- Fix equality comparison between secondary maps with different capacity ([#48][])

  [#48]: https://github.com/CQCL/portgraph/issues/48
  [#49]: https://github.com/CQCL/portgraph/issues/49
  [#50]: https://github.com/CQCL/portgraph/issues/50

## v0.2.3 (2023-05-17)

- Add a `rekey` method to `SecondaryMap` ([#44][])
- Fix `set_num_ports` deleting links ([#43][])

  [#43]: https://github.com/CQCL/portgraph/issues/43
  [#44]: https://github.com/CQCL/portgraph/issues/44

## v0.2.2 (2023-05-11)

This is a bugfix release that fixes a panic when growing the number of ports in an empty node.

- Fix a panic on `set_num_ports` ([#40][])

  [#40]: https://github.com/CQCL/portgraph/issues/40

## v0.2.1 (2023-05-10)

- Implemented serialization on Weights and PortOffset ([#36][])
- Added port capacity to the nodes, and an overallocation factor when increasing
  the number of ports. ([#37][])

  [#36]: https://github.com/CQCL/portgraph/issues/36
  [#37]: https://github.com/CQCL/portgraph/issues/37

## v0.2.0 (2023-05-03)

- Initial release with support for directed graphs with first-level ports.