Discussion: promote any structures from Experimental to Collections?

[jackfoxy]

Description

We are close to releasing FSharpx.Collectons 2.0.

Which (if any) Experimental collections are worthy of promotion to the main Collections library?

Flatlist?

Any one of the 4 RoseTrees? (BinaryRoseTree, EagerRoseTree, IndexedRoseTree, RoseTree)

IntMap? (If so, we need to resolve its test problems #117 )

Others?

[varon]

Would be nice to see FlatList promoted.

[jackfoxy]

@varon I'd be happy to merge a PR that promotes FlatList and its tests.
Adding documentation would be another nice to have #2

[github-actions]

🤖 This is an automated response from Repo Assist.

Revisiting this discussion in light of the current codebase state. Here's a brief survey of the Experimental collections and their promotion potential:

Good candidates for promotion

Collection	Status	Notes
FlatList	Community interest (see above). Clean, well-tested, no external deps. Equivalent to a growable contiguous array with O(1) random access.	Worth promoting; needs a PR
DList	⚠️ Already in core! src/FSharpx.Collections/DList.fs exists	The Experimental DList appears to be a duplicate — the core one should be the canonical version

Might be worth promoting with some work

• BankersQueue / HoodMelvilleQueue / RealTimeQueue / ImplicitQueue — alternative Queue implementations with different amortization or worst-case guarantees. If there's appetite for a richer Queue story, these could be added as separate types.
• LeftistHeap / BinomialHeap — these have stricter O(log n) worst-case guarantees vs the core Heap (pairing heap, amortized). Worth promoting if performance predictability matters.
• RingBuffer — mutable circular buffer (similar to CircularBuffer in core). Issue CircularBuffer has no tests #16 asked about the distinction; a PR documenting the differences and potentially consolidating them could be valuable.

Likely to stay Experimental (complex or niche)

• IntMap (has known test problems, Experimental IntMap tests failing #117), ChampHashMap (advanced), BKTree (specialized metric-space search), TimeSeries, various Rose trees.

Next steps

If someone wants to promote FlatList, a PR would be very welcome — @jackfoxy has previously indicated readiness to merge one. The main tasks would be:

1. Move FlatList.fs (and .fsi if not present) to src/FSharpx.Collections/
2. Add FlatList to the .fsproj
3. Ensure tests exist and pass
4. Check for any API alignment with FSharp.Collections conventions (Align Collection Module functions with FSharp.Collections #152)

Generated by Repo Assist · ◷

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@346204513ecfa08b81566450d7d599556807389f