8ebc617 · rowtype-yoga/purescript-native

git.iko.soy/rowtype-yoga/purescript-native

on golang help sign in

Remove 'forall's in laws, document 'cons'.

8ebc617Phil Freeman12 years ago

prelude/README.md+14−9

compare with golang

unifiedsplit

@@ -163,11 +163,9 @@ length (groupBy productCategory (filter isInStock (products)))

163(:) :: forall a. a -> [a] -> [a]

164```

165

166−Attaches an element to the front of an array, creating a new array.

166+An infix alias for `cons`.

167

168−```purescript

168+Note, the running time of this function is `O(n)`.

169−1 : [2, 3, 4] = [1, 2, 3, 4]

170−```

171

169

172#### `cons`

170#### `cons`

173

171

@@ -175,6 +173,13 @@ Attaches an element to the front of an array, creating a new array.

175cons :: forall a. a -> [a] -> [a]

173cons :: forall a. a -> [a] -> [a]

176```

174```

177

175

176+Attaches an element to the front of an array, creating a new array.

177+

178+```purescript

179+cons 1 [2, 3, 4] = [1, 2, 3, 4]

180+```

181+

182+Note, the running time of this function is `O(n)`.

178

183

179#### `Show`

184#### `Show`

180

185

@@ -355,7 +360,7 @@ where the function argument of `f` is given the name `y`.

355

360

356`Bind` instances should satisfy the following law:

361`Bind` instances should satisfy the following law:

357

362

358−- Associativity: `forall f g x. (x >>= f) >>= g = x >>= (\k => f k >>= g)`

363+- Associativity: `(x >>= f) >>= g = x >>= (\k => f k >>= g)`

359

364

360Or, expressed using `do` notation:

365Or, expressed using `do` notation:

361

366

@@ -602,10 +607,10 @@ The `Eq` type class represents types which support decidable equality.

602

607

603`Eq` instances should satisfy the following laws:

608`Eq` instances should satisfy the following laws:

604

609

605−- Reflexivity: `forall x. x == x = true`

610+- Reflexivity: `x == x = true`

606−- Symmetry: `forall x y. x == y = y == x`

611+- Symmetry: `x == y = y == x`

607- Transitivity: if `x == y` and `y == z` then `x == z`

612- Transitivity: if `x == y` and `y == z` then `x == z`

608−- Negation: `forall x y. x /= y = not (x == y)`

613+- Negation: `x /= y = not (x == y)`

609

614

610`(/=)` may be implemented in terms of `(==)`, but it might give a performance improvement to implement it separately.

615`(/=)` may be implemented in terms of `(==)`, but it might give a performance improvement to implement it separately.

611

616

@@ -831,7 +836,7 @@ The `Semigroup` type class identifies an associative operation on a type.

831

836

832`Semigroup` instances are required to satisfy the following law:

837`Semigroup` instances are required to satisfy the following law:

833

838

834−- Associativity: `forall x y z. (x <> y) <> z = x <> (y <> z)`

839+- Associativity: `(x <> y) <> z = x <> (y <> z)`

835

840

836For example, the `String` type is an instance of `Semigroup`, where `(<>)` is defined to be string concatenation.

841For example, the `String` type is an instance of `Semigroup`, where `(<>)` is defined to be string concatenation.

837

842

prelude/prelude.purs+14−9

@@ -146,14 +146,19 @@ module Prelude

146

147 infixr 6 :

148

149− -- | Attaches an element to the front of an array, creating a new array.

149+ -- | An infix alias for `cons`.

150 -- |

151− -- | ```purescript

151+ -- | Note, the running time of this function is `O(n)`.

152− -- | 1 : [2, 3, 4] = [1, 2, 3, 4]

153− -- | ```

154 (:) :: forall a. a -> [a] -> [a]

152 (:) :: forall a. a -> [a] -> [a]

155 (:) = cons

153 (:) = cons

156

154

155+ -- | Attaches an element to the front of an array, creating a new array.

156+ -- |

157+ -- | ```purescript

158+ -- | cons 1 [2, 3, 4] = [1, 2, 3, 4]

159+ -- | ```

160+ -- |

161+ -- | Note, the running time of this function is `O(n)`.

157 foreign import cons

162 foreign import cons

158 """

163 """

159 function cons(e) {

164 function cons(e) {

@@ -318,7 +323,7 @@ module Prelude

318 -- |

323 -- |

319 -- | `Bind` instances should satisfy the following law:

324 -- | `Bind` instances should satisfy the following law:

320 -- |

325 -- |

321− -- | - Associativity: `forall f g x. (x >>= f) >>= g = x >>= (\k => f k >>= g)`

326+ -- | - Associativity: `(x >>= f) >>= g = x >>= (\k => f k >>= g)`

322 -- |

327 -- |

323 -- | Or, expressed using `do` notation:

328 -- | Or, expressed using `do` notation:

324 -- |

329 -- |

@@ -526,10 +531,10 @@ module Prelude

526 -- |

531 -- |

527 -- | `Eq` instances should satisfy the following laws:

532 -- | `Eq` instances should satisfy the following laws:

528 -- |

533 -- |

529− -- | - Reflexivity: `forall x. x == x = true`

534+ -- | - Reflexivity: `x == x = true`

530− -- | - Symmetry: `forall x y. x == y = y == x`

535+ -- | - Symmetry: `x == y = y == x`

531 -- | - Transitivity: if `x == y` and `y == z` then `x == z`

536 -- | - Transitivity: if `x == y` and `y == z` then `x == z`

532− -- | - Negation: `forall x y. x /= y = not (x == y)`

537+ -- | - Negation: `x /= y = not (x == y)`

533 -- |

538 -- |

534 -- | `(/=)` may be implemented in terms of `(==)`, but it might give a performance improvement to implement it separately.

539 -- | `(/=)` may be implemented in terms of `(==)`, but it might give a performance improvement to implement it separately.

535 class Eq a where

540 class Eq a where

@@ -829,7 +834,7 @@ module Prelude

829 -- |

834 -- |

830 -- | `Semigroup` instances are required to satisfy the following law:

835 -- | `Semigroup` instances are required to satisfy the following law:

831 -- |

836 -- |

832− -- | - Associativity: `forall x y z. (x <> y) <> z = x <> (y <> z)`

837+ -- | - Associativity: `(x <> y) <> z = x <> (y <> z)`

833 -- |

838 -- |

834 -- | For example, the `String` type is an instance of `Semigroup`, where `(<>)` is defined to be string concatenation.

839 -- | For example, the `String` type is an instance of `Semigroup`, where `(<>)` is defined to be string concatenation.

835 class Semigroup a where

840 class Semigroup a where