The Other Prelude
From HaskellWiki
m (x => y (yikes!)) |
m (→See also) |
||
| (22 intermediate revisions not shown.) | |||
| Line 1: | Line 1: | ||
| - | |||
| - | |||
== Call For Contribution == | == Call For Contribution == | ||
| + | |||
This fun project, called ''The Other Prelude'', is a creative reconstruction of the standard Prelude. By disregarding history and compatibility, we get a clean sheet. | This fun project, called ''The Other Prelude'', is a creative reconstruction of the standard Prelude. By disregarding history and compatibility, we get a clean sheet. | ||
== Committee == | == Committee == | ||
| - | This project has no committee whatsoever. | + | |
| + | This project has no committee whatsoever. Issues are discussed on [[Talk:The Other Prelude|the talk page]]. | ||
== Naming Conventions == | == Naming Conventions == | ||
| + | |||
* Function names should be easy for beginners to consume. | * Function names should be easy for beginners to consume. | ||
* Specifically, ''The Other Prelude'' naming convention is to use | * Specifically, ''The Other Prelude'' naming convention is to use | ||
| Line 13: | Line 14: | ||
** whole English words and camelCase for functions (''e.g.'', <hask>orElse</hask> but not <hask>fmap</hask>) | ** whole English words and camelCase for functions (''e.g.'', <hask>orElse</hask> but not <hask>fmap</hask>) | ||
| - | == The Hierarchy == | + | == Design Philosophy == |
| - | Although, not | + | |
| + | === Taking Typeclasses Seriously === | ||
| + | Following [[Not just Maybe]], functions should be generalized whenever possible. Of course, efficiency might be a concern but this is a fun project anyway. | ||
| + | * <hask>concat</hask> means the same thing as <hask>join</hask>. We propose we don't use <hask>concat</hask> at all. | ||
| + | * <hask>concatMap</hask> is just <hask>(>>=)</hask>. That is, monadic functions are preferred over the same functions with different name. | ||
| + | |||
| + | === The Hierarchy === | ||
| + | |||
| + | Although, not Haskell98, hierarchical modules are already in Haskell2010. We take it for granted. | ||
* <hask>TheOtherPrelude</hask> - Minimalistic module. | * <hask>TheOtherPrelude</hask> - Minimalistic module. | ||
* <hask>TheOtherPrelude.Utilities</hask> - Convenient definitions. The reasoning behind its existence is that we want the Prelude to be very concise. It should not steal good names. | * <hask>TheOtherPrelude.Utilities</hask> - Convenient definitions. The reasoning behind its existence is that we want the Prelude to be very concise. It should not steal good names. | ||
| + | * <hask>TheOtherPrelude.Legacy</hask> - providing as much backwards compatibility as possible | ||
== Open Issues == | == Open Issues == | ||
| - | * Should Prelude functions use <hask>Integer</hask> instead of <hask>Int</hask>? | + | |
| + | * When the same function has an infix and a prefix implementation, should one of them be outside the class to enforce consistency? | ||
| + | * Should Prelude functions use <hask>Integer</hask> instead of <hask>Int</hask>? Maybe <hask>Integral n => n</hask> or <hask>Ix i => i</hask> in some cases? | ||
* Should <hask>String</hask> be a class rather than a type synonym? | * Should <hask>String</hask> be a class rather than a type synonym? | ||
| + | * The current proposal lacks a well thought <hask>fail</hask> mechanism. Should it be integrated into <hask>MonadZero</hask>, or have a class of his own, or remain in the <hask>Monad</hask> class? | ||
| + | |||
| + | == Reality == | ||
| + | |||
| + | What we have here right now is not ready to be adopted by existing projects. The [[class system extension proposal]] might make a difference. | ||
== The Code == | == The Code == | ||
| + | |||
Currently, the code is in Wiki form. If people do agree that the collaborative decisions begot something pretty, we'll have a group of files in darcs.haskell.org some time. | Currently, the code is in Wiki form. If people do agree that the collaborative decisions begot something pretty, we'll have a group of files in darcs.haskell.org some time. | ||
| - | The | + | The imaginary Prelude as it stands: |
| - | === <hask>TheOtherPrelude</hask> === | + | |
| + | === <hask>TheOtherPrelude.hs</hask> === | ||
| + | |||
<haskell> | <haskell> | ||
| - | -- module | + | {-# LANGUAGE NoImplicitPrelude #-} |
| - | import Prelude () | + | |
| + | module TheOtherPrelude where | ||
| + | |||
| + | import Prelude (id, const, flip, (.)) | ||
| + | -- hide almost everything | ||
| + | -- in fact, we could do better, by just defining them here | ||
| - | -- | + | -- The idea is to rename 'fmap'. |
| - | -- | + | -- Both map :: (a -> b) -> [a] -> [b] (in []) |
| - | -- and (.) :: (a -> b) -> (e -> a) -> (e -> b) ( | + | -- and (.) :: (a -> b) -> (e -> a) -> (e -> b) (in (->) e) |
-- are good names, and are intuitively prefix and infix respectively. | -- are good names, and are intuitively prefix and infix respectively. | ||
| + | -- 'map' is aliased as (.) below. | ||
| + | |||
class Functor f where | class Functor f where | ||
| - | + | map :: (a -> b) -> f a -> f b | |
| - | map | + | |
| - | + | -- definitely a bad idea, sorry Cale! | |
| - | + | -- (.) :: (Functor f) => (a -> b) -> f a -> f b | |
| - | + | -- (.) = map | |
| - | + | class (Functor p) => Applicative p where | |
| - | + | -- Minimal complete definition: return and (<@>). | |
| - | class Functor | + | pure :: a -> p a -- value lifting |
| - | -- | + | -- actually I think we should |
| - | + | -- stick to return | |
| + | -- to make do notation work | ||
| + | (<@>) :: p (a -> b) -> p a -> p b -- lifted application | ||
| + | (>>) :: p a -> p b -> p b -- when the second is independent of the first | ||
| - | + | pa >> pb = (const id) . pa <@> pb | |
| - | + | --map f pa = return f <@> pa -- see Class system extension proposal, below | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | -- | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | apply :: (Applicative p) => p (a -> b) -> p a -> p b | |
| - | + | apply = (<@>) | |
| - | -- | + | class (Applicative m) => Monad m where |
| - | + | -- Minimal complete definition: one of join or (>>=). | |
| - | (>>) :: m a -> m b -> m b | + | (>>=) :: m a -> (a -> m b) -> m b -- bind |
| + | join :: m (m a) -> m a -- combining levels of structure | ||
| - | + | ma >>= k = join (map k ma) | |
| - | + | join mma = mma >>= id | |
| - | + | --mf <@> ma = mf >>= flip map ma -- see Class system extension proposal, below | |
| - | + | --ma >> mb = ma >>= const mb | |
| + | --map f ma = ma >>= return . f -- this depends on (.), which is map! Be careful. | ||
| - | -- | + | -- We copy from the MonadPlus reform proposal (link below) now. |
| - | + | -- 'zero' will be used when pattern matching against refutable patterns in | |
| - | -- zero will be used when pattern matching against refutable patterns in | + | |
-- do-notation as well as to provide support for monad comprehensions. | -- do-notation as well as to provide support for monad comprehensions. | ||
| - | -- | + | class (Monad mz) => MonadZero mz where |
| - | class ( | + | -- Should satisfy 'left zero': zero >>= f = zero |
| - | zero :: | + | zero :: mz a |
| + | |||
| + | class (MonadZero mp) => MonadPlus mp where | ||
| + | -- Should satisfy 'monoid': | ||
| + | -- zero ++ b = b; b ++ zero = b | ||
| + | -- (a ++ b) ++ c = a ++ (b ++ c) | ||
| + | -- and 'left distribution': | ||
| + | -- (a ++ b) >>= f = (a >>= f) ++ (b >>= f) | ||
| + | (++) :: mp a -> mp a -> mp a | ||
| - | -- | + | class (MonadZero mo) => MonadOr mo where |
| - | -- zero | + | -- Should satisfy 'monoid': |
| - | -- and 'left | + | -- zero `orElse` b = b; b `orElse` zero = b |
| - | -- (a | + | -- (a `orElse` b) `orElse` c = a `orElse` (b `orElse` c) |
| - | + | -- and 'left catch': | |
| - | + | -- (return a) `orElse` b = a | |
| + | orElse :: mo a -> mo a -> mo a | ||
| - | + | class (Monad m) => MonadFail m where | |
| - | + | fail :: String -> m a | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | class ( | + | |
| - | + | ||
</haskell> | </haskell> | ||
| - | === <hask>TheOtherPrelude | + | === <hask>TheOtherPrelude/Utilities.hs</hask> === |
| + | |||
<haskell> | <haskell> | ||
| - | + | module TheOtherPrelude.Utilities where | |
| - | + | ||
import Prelude () -- hide everything | import Prelude () -- hide everything | ||
-- this is the if-then-else proposal | -- this is the if-then-else proposal | ||
-- the name has been chosen to reflect the magic of Church booleans! | -- the name has been chosen to reflect the magic of Church booleans! | ||
| - | boolean | + | -- the order of arguments matches that of maybe and either. |
| - | boolean | + | boolean x _ True = x |
| - | + | boolean _ y False = y | |
</haskell> | </haskell> | ||
| + | |||
== How To Use == | == How To Use == | ||
| + | |||
<haskell> | <haskell> | ||
-- ''The Other Prelude'' is an alternative, not a replacement. | -- ''The Other Prelude'' is an alternative, not a replacement. | ||
-- So we need to hide everything from the Prelude | -- So we need to hide everything from the Prelude | ||
| - | import Prelude () | + | --import Prelude () |
| - | + | -- Now that we have it, | |
| + | {-# LANGUAGE NoImplicitPrelude #-} | ||
-- This is just an example assuming there is nothing to hide | -- This is just an example assuming there is nothing to hide | ||
| - | import TheOtherPrelude | + | import TheOtherPrelude |
-- Hopefully, this module will contain lift,... | -- Hopefully, this module will contain lift,... | ||
-- Standard convention is to use M.lift (instead of liftM) | -- Standard convention is to use M.lift (instead of liftM) | ||
| - | import qualified TheOtherPrelude.Monad.Kleisli as M | + | -- import qualified TheOtherPrelude.Monad.Kleisli as M |
</haskell> | </haskell> | ||
== See also == | == See also == | ||
| - | * [[ | + | |
| - | * [[ | + | * [[Class system extension proposal]] - Makes this proposal worth reading at last |
| + | * [[Quantified contexts]] - Another important issue | ||
* [[Functor hierarchy proposal]] - Making <hask>Monad m</hask> imply <hask>Functor m</hask> (adopted by ''The Other Prelude''). | * [[Functor hierarchy proposal]] - Making <hask>Monad m</hask> imply <hask>Functor m</hask> (adopted by ''The Other Prelude''). | ||
| + | * [[Functor-Applicative-Monad Proposal]] - in essence the same proposal, perhaps showing this sentiment is more common than assumed | ||
* [[If-then-else]] - Making <hask>if</hask> a function (partially adopted by ''The Other Prelude'', we are silent on the bigger issue of sugar). | * [[If-then-else]] - Making <hask>if</hask> a function (partially adopted by ''The Other Prelude'', we are silent on the bigger issue of sugar). | ||
* [http://software.complete.org/missingh/static/doc/ MissingH] - Functions "missing" from the Haskell Prelude/libraries. | * [http://software.complete.org/missingh/static/doc/ MissingH] - Functions "missing" from the Haskell Prelude/libraries. | ||
* [[MonadPlus reform proposal]] - Clarifies ambiguities around MonadPlus laws (adopted by ''The Other Prelude'') | * [[MonadPlus reform proposal]] - Clarifies ambiguities around MonadPlus laws (adopted by ''The Other Prelude'') | ||
| + | * [[Mathematical prelude discussion]] - A [[Numeric Prelude]] in good shape already. Will a merger be ever possible? | ||
| + | * [[Prelude extensions]] and [[List function suggestions]] - Unlike ''The Other Prelude'' they ''enhance'' the Prelude. | ||
| + | * [[Not just Maybe]] - Instead of writing inside a specific monad (i.e. Maybe) write functions generalized on (Monad m)=> where possible. | ||
| + | |||
| + | [[Category:Proposals]] | ||
[[Category:Mathematics]] | [[Category:Mathematics]] | ||
[[Category:Code]] | [[Category:Code]] | ||
Current revision
Contents |
1 Call For Contribution
This fun project, called The Other Prelude, is a creative reconstruction of the standard Prelude. By disregarding history and compatibility, we get a clean sheet.
2 Committee
This project has no committee whatsoever. Issues are discussed on the talk page.
3 Naming Conventions
- Function names should be easy for beginners to consume.
- Specifically, The Other Prelude naming convention is to use
- descriptive symbols for functions that are naturally infix (e.g., is replaced bymplus)(++)
- whole English words and camelCase for functions (e.g., but notorElse)fmap
- descriptive symbols for functions that are naturally infix (e.g.,
4 Design Philosophy
4.1 Taking Typeclasses Seriously
Following Not just Maybe, functions should be generalized whenever possible. Of course, efficiency might be a concern but this is a fun project anyway.
- means the same thing asconcat. We propose we don't usejoinat all.concat
- is justconcatMap. That is, monadic functions are preferred over the same functions with different name.(>>=)
4.2 The Hierarchy
Although, not Haskell98, hierarchical modules are already in Haskell2010. We take it for granted.
- - Minimalistic module.TheOtherPrelude
- - Convenient definitions. The reasoning behind its existence is that we want the Prelude to be very concise. It should not steal good names.TheOtherPrelude.Utilities
- - providing as much backwards compatibility as possibleTheOtherPrelude.Legacy
5 Open Issues
- When the same function has an infix and a prefix implementation, should one of them be outside the class to enforce consistency?
- Should Prelude functions use instead ofInteger? MaybeIntorIntegral n => nin some cases?Ix i => i
- Should be a class rather than a type synonym?String
- The current proposal lacks a well thought mechanism. Should it be integrated intofail, or have a class of his own, or remain in theMonadZeroclass?Monad
6 Reality
What we have here right now is not ready to be adopted by existing projects. The class system extension proposal might make a difference.
7 The Code
Currently, the code is in Wiki form. If people do agree that the collaborative decisions begot something pretty, we'll have a group of files in darcs.haskell.org some time.
The imaginary Prelude as it stands:
7.1 TheOtherPrelude.hs
{-# LANGUAGE NoImplicitPrelude #-} module TheOtherPrelude where import Prelude (id, const, flip, (.)) -- hide almost everything -- in fact, we could do better, by just defining them here -- The idea is to rename 'fmap'. -- Both map :: (a -> b) -> [a] -> [b] (in []) -- and (.) :: (a -> b) -> (e -> a) -> (e -> b) (in (->) e) -- are good names, and are intuitively prefix and infix respectively. -- 'map' is aliased as (.) below. class Functor f where map :: (a -> b) -> f a -> f b -- definitely a bad idea, sorry Cale! -- (.) :: (Functor f) => (a -> b) -> f a -> f b -- (.) = map class (Functor p) => Applicative p where -- Minimal complete definition: return and (<@>). pure :: a -> p a -- value lifting -- actually I think we should -- stick to return -- to make do notation work (<@>) :: p (a -> b) -> p a -> p b -- lifted application (>>) :: p a -> p b -> p b -- when the second is independent of the first pa >> pb = (const id) . pa <@> pb --map f pa = return f <@> pa -- see Class system extension proposal, below apply :: (Applicative p) => p (a -> b) -> p a -> p b apply = (<@>) class (Applicative m) => Monad m where -- Minimal complete definition: one of join or (>>=). (>>=) :: m a -> (a -> m b) -> m b -- bind join :: m (m a) -> m a -- combining levels of structure ma >>= k = join (map k ma) join mma = mma >>= id --mf <@> ma = mf >>= flip map ma -- see Class system extension proposal, below --ma >> mb = ma >>= const mb --map f ma = ma >>= return . f -- this depends on (.), which is map! Be careful. -- We copy from the MonadPlus reform proposal (link below) now. -- 'zero' will be used when pattern matching against refutable patterns in -- do-notation as well as to provide support for monad comprehensions. class (Monad mz) => MonadZero mz where -- Should satisfy 'left zero': zero >>= f = zero zero :: mz a class (MonadZero mp) => MonadPlus mp where -- Should satisfy 'monoid': -- zero ++ b = b; b ++ zero = b -- (a ++ b) ++ c = a ++ (b ++ c) -- and 'left distribution': -- (a ++ b) >>= f = (a >>= f) ++ (b >>= f) (++) :: mp a -> mp a -> mp a class (MonadZero mo) => MonadOr mo where -- Should satisfy 'monoid': -- zero `orElse` b = b; b `orElse` zero = b -- (a `orElse` b) `orElse` c = a `orElse` (b `orElse` c) -- and 'left catch': -- (return a) `orElse` b = a orElse :: mo a -> mo a -> mo a class (Monad m) => MonadFail m where fail :: String -> m a
7.2 TheOtherPrelude/Utilities.hs
module TheOtherPrelude.Utilities where import Prelude () -- hide everything -- this is the if-then-else proposal -- the name has been chosen to reflect the magic of Church booleans! -- the order of arguments matches that of maybe and either. boolean x _ True = x boolean _ y False = y
8 How To Use
-- ''The Other Prelude'' is an alternative, not a replacement. -- So we need to hide everything from the Prelude --import Prelude () -- Now that we have it, {-# LANGUAGE NoImplicitPrelude #-} -- This is just an example assuming there is nothing to hide import TheOtherPrelude -- Hopefully, this module will contain lift,... -- Standard convention is to use M.lift (instead of liftM) -- import qualified TheOtherPrelude.Monad.Kleisli as M
9 See also
- Class system extension proposal - Makes this proposal worth reading at last
- Quantified contexts - Another important issue
- Functor hierarchy proposal - Making implyMonad m(adopted by The Other Prelude).Functor m
- Functor-Applicative-Monad Proposal - in essence the same proposal, perhaps showing this sentiment is more common than assumed
- If-then-else - Making a function (partially adopted by The Other Prelude, we are silent on the bigger issue of sugar).if
- MissingH - Functions "missing" from the Haskell Prelude/libraries.
- MonadPlus reform proposal - Clarifies ambiguities around MonadPlus laws (adopted by The Other Prelude)
- Mathematical prelude discussion - A Numeric Prelude in good shape already. Will a merger be ever possible?
- Prelude extensions and List function suggestions - Unlike The Other Prelude they enhance the Prelude.
- Not just Maybe - Instead of writing inside a specific monad (i.e. Maybe) write functions generalized on (Monad m)=> where possible.
