Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve UnboxViaPrim docs #450

Merged
merged 3 commits into from
Oct 19, 2022
Merged

Improve UnboxViaPrim docs #450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
add8269
Make doctests of Unbox deriving via DerivingVia compile when copy-pasted
sergv Oct 11, 2022
00a2d35
Make qualified import names in doctests more consistent
sergv Oct 11, 2022
f47a568
Export V_UnboxViaPrim to be able to use DerivingVia
sergv Oct 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions vector/src/Data/Vector/Unboxed.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,21 +46,21 @@
--
-- >>> :set -XTypeFamilies -XStandaloneDeriving -XMultiParamTypeClasses -XGeneralizedNewtypeDeriving
-- >>>
-- >>> import qualified Data.Vector.Unboxed as U
-- >>> import qualified Data.Vector.Generic as G
-- >>> import qualified Data.Vector.Generic.Mutable as M
-- >>> import qualified Data.Vector.Generic as VG
-- >>> import qualified Data.Vector.Generic.Mutable as VGM
-- >>> import qualified Data.Vector.Unboxed as VU
-- >>>
-- >>> newtype Foo = Foo Int
-- >>>
-- >>> newtype instance U.MVector s Foo = MV_Int (U.MVector s Int)
-- >>> newtype instance U.Vector Foo = V_Int (U.Vector Int)
-- >>> deriving instance M.MVector MVector Foo
-- >>> deriving instance G.Vector Vector Foo
-- >>> instance Unbox Foo
-- >>> newtype instance VU.MVector s Foo = MV_Int (VU.MVector s Int)
-- >>> newtype instance VU.Vector Foo = V_Int (VU.Vector Int)
-- >>> deriving instance VGM.MVector VU.MVector Foo
-- >>> deriving instance VG.Vector VU.Vector Foo
-- >>> instance VU.Unbox Foo

module Data.Vector.Unboxed (
-- * Unboxed vectors
Vector(V_UnboxAs), MVector(..), Unbox,
Vector(V_UnboxAs, V_UnboxViaPrim), MVector(..), Unbox,

-- * Accessors

Expand Down
38 changes: 19 additions & 19 deletions vector/src/Data/Vector/Unboxed/Base.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,36 +184,36 @@ instance G.Vector Vector () where
-- >>> -- Needed to derive Prim
-- >>> :set -XGeneralizedNewtypeDeriving -XDataKinds -XUnboxedTuples -XPolyKinds
-- >>>
-- >>> import qualified Data.Vector.Unboxed as U
-- >>> import qualified Data.Vector.Primitive as P
-- >>> import qualified Data.Vector.Generic as G
-- >>> import qualified Data.Vector.Generic.Mutable as M
-- >>> import qualified Data.Vector.Generic as VG
-- >>> import qualified Data.Vector.Generic.Mutable as VGM
-- >>> import qualified Data.Vector.Primitive as VP
-- >>> import qualified Data.Vector.Unboxed as VU
-- >>>
-- >>> newtype Foo = Foo Int deriving P.Prim
-- >>> newtype Foo = Foo Int deriving VP.Prim
-- >>>
-- >>> newtype instance U.MVector s Foo = MV_Int (P.MVector s Foo)
-- >>> newtype instance U.Vector Foo = V_Int (P.Vector Foo)
-- >>> deriving via (U.UnboxViaPrim Foo) instance M.MVector MVector Foo
-- >>> deriving via (U.UnboxViaPrim Foo) instance G.Vector Vector Foo
-- >>> instance Unbox Foo
-- >>> newtype instance VU.MVector s Foo = MV_Int (VP.MVector s Foo)
-- >>> newtype instance VU.Vector Foo = V_Int (VP.Vector Foo)
-- >>> deriving via (VU.UnboxViaPrim Foo) instance VGM.MVector VU.MVector Foo
-- >>> deriving via (VU.UnboxViaPrim Foo) instance VG.Vector VU.Vector Foo
-- >>> instance VU.Unbox Foo
--
-- Second example is essentially same but with a twist. Instead of
-- using @Prim@ instance of data type, we use underlying instance of @Int@:
--
-- >>> :set -XTypeFamilies -XStandaloneDeriving -XDerivingVia -XMultiParamTypeClasses
-- >>>
-- >>> import qualified Data.Vector.Unboxed as U
-- >>> import qualified Data.Vector.Primitive as P
-- >>> import qualified Data.Vector.Generic as G
-- >>> import qualified Data.Vector.Generic.Mutable as M
-- >>> import qualified Data.Vector.Generic as VG
-- >>> import qualified Data.Vector.Generic.Mutable as VGM
-- >>> import qualified Data.Vector.Primitive as VP
-- >>> import qualified Data.Vector.Unboxed as VU
-- >>>
-- >>> newtype Foo = Foo Int
-- >>>
-- >>> newtype instance U.MVector s Foo = MV_Int (P.MVector s Int)
-- >>> newtype instance U.Vector Foo = V_Int (P.Vector Int)
-- >>> deriving via (U.UnboxViaPrim Int) instance M.MVector MVector Foo
-- >>> deriving via (U.UnboxViaPrim Int) instance G.Vector Vector Foo
-- >>> instance Unbox Foo
-- >>> newtype instance VU.MVector s Foo = MV_Int (VP.MVector s Int)
-- >>> newtype instance VU.Vector Foo = V_Int (VP.Vector Int)
-- >>> deriving via (VU.UnboxViaPrim Int) instance VGM.MVector VU.MVector Foo
-- >>> deriving via (VU.UnboxViaPrim Int) instance VG.Vector VU.Vector Foo
-- >>> instance VU.Unbox Foo
--
-- @since 0.13.0.0
newtype UnboxViaPrim a = UnboxViaPrim a
Expand Down