Add note about sorting to documentation (and possibly a transform function)
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- haskell
调研方向
从顶层 Data.Vector 模块开始,检查其文档如何链接到 vector-algorithms 及相关 API。添加一条说明,解释 mutable 排序函数位于何处,以及 freeze/thaw 如何支持 immutable 向量。将提议的 immutable transform helper 单独处理,并将其与 Data.Vector.Generic.transform 和 Data.Vector.Generic.Mutable.transform 进行比较,然后再决定是否将其纳入范围。
由索引模型根据 Issue 内容生成。
描述
Continuing from #157 - sorting algorithms are available in vector-algorithm, but it isn't easy to find that information out, depending on how you search. For example, the Stackage Hoogle query for sort :: Ord a => Vector a -> Vector a doesn't come up with the result (because that package doesn't provide a wrapper for immutable vectors).
It would be nice if a note about this could be added to the top-level module Data.Vector, which serves as the "information hub" right now. Something along the lines of:
Note: Sorting algorithms for mutable vectors are available in the vector-algorithms package. If you want to sort an immutable vector, you can use the
freezeandthawfunctions to wrap calls to sorting functions of your choice.
Personally, I think it would be nice to have a helper function alongside
Data.Vector.Generic.transform
:: (PrimMonad m, Vector v a)
=> (Mutable v (PrimState m) a -> m (Mutable v (PrimState m) a))
-> v a
-> m (v a)
transform f = unsafeFreeze <=< f <=< thaw
as an counterpart to Data.Vector.Generic.Mutable.transform (the signatures aren't exactly analogous though because of the extra m 🙁), but of course, it isn't strictly necessary, just a nice to have thing.
- 主要语言
- Haskell
- 星标
- 403
- 派生
- 146
- 平均合并
- 1 天 22 小时
- 30 天内合并 PR
- 3
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
haskell/vector 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 68/100
-
难度 2/5 1-3 小时 新手友好度 50/100
-
难度 2/5 1-3 小时 新手友好度 45/100
-
难度 5/5 一周以上 新手友好度 35/100
-
难度 3/5 1-2 天 新手友好度 55/100
相似的 Issue
-
enhancement
难度 2/5 1-3 小时 新手友好度 62/100
alunduil/siren-json.hs#246 ·
维护者通常 1 天内回复
-
frontend Hackathon
难度 2/5 1-3 小时 新手友好度 72/100
flora-pm/flora-server#1334 · 1 条评论 ·
维护者通常 1 天内回复
-
enhancement good first issue hacktoberfest runner
难度 2/5 1-3 小时 新手友好度 82/100
-
难度 2/5 1-3 小时 新手友好度 62/100
halogenandtoast/ArkhamHorror#5825 · 1 条评论 ·
-
docs: install-manifest download links use main instead of master (404)可能重新可做 关联的 PR 已关闭且未合并。 未关闭
难度 2/5 1 小时以内 新手友好度 78/100
hasura/graphql-engine#10884 ·