diff options
author | Krzysztof Gogolewski <krzysztof.gogolewski@tweag.io> | 2020-10-12 18:33:21 +0200 |
---|---|---|
committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2020-10-20 00:48:29 -0400 |
commit | 6c7a5c0ca07085f31a3e2f8286bb57a0f35961cb (patch) | |
tree | 49130cc56d3e7b8e419a209ba5869a6d8c75217f /docs | |
parent | ee5dcdf95a7c408e9c339aacebf89a007a735f8f (diff) | |
download | haskell-6c7a5c0ca07085f31a3e2f8286bb57a0f35961cb.tar.gz |
Minor comments, update linear types docs
- Update comments: placeHolderTypeTc no longer exists
"another level check problem" was a temporary comment from linear types
- Use Mult type synonym (reported in #18676)
- Mention multiplicity-polymorphic fields in linear types docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/users_guide/exts/linear_types.rst | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/docs/users_guide/exts/linear_types.rst b/docs/users_guide/exts/linear_types.rst index d868adf3f0..a989d3b610 100644 --- a/docs/users_guide/exts/linear_types.rst +++ b/docs/users_guide/exts/linear_types.rst @@ -101,13 +101,23 @@ Whether a data constructor field is linear or not can be customized using the GA :: data T2 a b c where - MkT2 :: a -> b %1 -> c %1 -> T2 a b -- Note unrestricted arrow in the first argument + MkT2 :: a -> b %1 -> c %1 -> T2 a b c -- Note unrestricted arrow in the first argument the value ``MkT2 x y z`` can be constructed only if ``x`` is unrestricted. On the other hand, a linear function which is matching on ``MkT2 x y z`` must consume ``y`` and ``z`` exactly once, but there is no restriction on ``x``. +It is also possible to define a multiplicity-polymorphic field: + +:: + data T3 a m where + MkT3 :: a %m -> T3 a m + +While linear fields are generalized (``MkT1 :: forall {m} a. a %m -> T1 a`` +in the previous example), multiplicity-polymorphic fields are not; +it is not possible to directly use ``MkT3`` as a function ``a -> T3 a 'One``. + If :extension:`LinearTypes` is disabled, all fields are considered to be linear fields, including GADT fields defined with the ``->`` arrow. @@ -143,9 +153,9 @@ missing pieces. have success using it, or you may not. Expect it to be really unreliable. - There is currently no support for multiplicity annotations such as ``x :: a %p``, ``\(x :: a %p) -> ...``. -- All ``case``, ``let`` and ``where`` statements consume their - right-hand side, or scrutiny, ``Many`` times. That is, the following - will not type check: +- All ``case`` expressions consume their scrutinee ``Many`` times. + All ``let`` and ``where`` statements consume their right hand side + ``Many`` times. That is, the following will not type check: :: |