Skip to content

Commit f70074f

Browse files
committed
Adjust case of Coarbitrary
1 parent bf2a948 commit f70074f

6 files changed

Lines changed: 37 additions & 37 deletions

File tree

docs/Test.QuickCheck.Arbitrary.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,21 @@ _randomly-generated_.
1616
the type `t`. Combinators in the `Test.QuickCheck.Gen`
1717
module can be used to construct random generators.
1818

19-
#### `CoArbitrary`
19+
#### `Coarbitrary`
2020

2121
``` purescript
22-
class CoArbitrary t where
22+
class Coarbitrary t where
2323
coarbitrary :: forall r. t -> Gen r -> Gen r
2424
```
2525

26-
The `CoArbitrary` class represents types which appear on the left of
26+
The `Coarbitrary` class represents types which appear on the left of
2727
an `Arbitrary` function arrow.
2828

2929
To construct an `Arbitrary` instance for the type `a -> b`, we need to
3030
use the input of type `a` to _perturb_ a random generator for `b`. This
3131
is the role of the `coarbitrary` function.
3232

33-
`CoArbitrary` instances can be written using the `perturbGen` function.
33+
`Coarbitrary` instances can be written using the `perturbGen` function.
3434

3535
#### `arbBoolean`
3636

@@ -42,7 +42,7 @@ instance arbBoolean :: Arbitrary Boolean
4242
#### `coarbBoolean`
4343

4444
``` purescript
45-
instance coarbBoolean :: CoArbitrary Boolean
45+
instance coarbBoolean :: Coarbitrary Boolean
4646
```
4747

4848

@@ -56,7 +56,7 @@ instance arbNumber :: Arbitrary Number
5656
#### `coarbNumber`
5757

5858
``` purescript
59-
instance coarbNumber :: CoArbitrary Number
59+
instance coarbNumber :: Coarbitrary Number
6060
```
6161

6262

@@ -70,7 +70,7 @@ instance arbInt :: Arbitrary Int
7070
#### `coarbInt`
7171

7272
``` purescript
73-
instance coarbInt :: CoArbitrary Int
73+
instance coarbInt :: Coarbitrary Int
7474
```
7575

7676

@@ -84,7 +84,7 @@ instance arbString :: Arbitrary String
8484
#### `coarbString`
8585

8686
``` purescript
87-
instance coarbString :: CoArbitrary String
87+
instance coarbString :: Coarbitrary String
8888
```
8989

9090

@@ -98,7 +98,7 @@ instance arbChar :: Arbitrary Char
9898
#### `coarbChar`
9999

100100
``` purescript
101-
instance coarbChar :: CoArbitrary Char
101+
instance coarbChar :: Coarbitrary Char
102102
```
103103

104104

@@ -112,7 +112,7 @@ instance arbUnit :: Arbitrary Unit
112112
#### `coarbUnit`
113113

114114
``` purescript
115-
instance coarbUnit :: CoArbitrary Unit
115+
instance coarbUnit :: Coarbitrary Unit
116116
```
117117

118118

@@ -126,7 +126,7 @@ instance arbOrdering :: Arbitrary Ordering
126126
#### `coarbOrdering`
127127

128128
``` purescript
129-
instance coarbOrdering :: CoArbitrary Ordering
129+
instance coarbOrdering :: Coarbitrary Ordering
130130
```
131131

132132

@@ -140,21 +140,21 @@ instance arbArray :: (Arbitrary a) => Arbitrary [a]
140140
#### `coarbArray`
141141

142142
``` purescript
143-
instance coarbArray :: (CoArbitrary a) => CoArbitrary [a]
143+
instance coarbArray :: (Coarbitrary a) => Coarbitrary [a]
144144
```
145145

146146

147147
#### `arbFunction`
148148

149149
``` purescript
150-
instance arbFunction :: (CoArbitrary a, Arbitrary b) => Arbitrary (a -> b)
150+
instance arbFunction :: (Coarbitrary a, Arbitrary b) => Arbitrary (a -> b)
151151
```
152152

153153

154154
#### `coarbFunction`
155155

156156
``` purescript
157-
instance coarbFunction :: (Arbitrary a, CoArbitrary b) => CoArbitrary (a -> b)
157+
instance coarbFunction :: (Arbitrary a, Coarbitrary b) => Coarbitrary (a -> b)
158158
```
159159

160160

@@ -168,7 +168,7 @@ instance arbTuple :: (Arbitrary a, Arbitrary b) => Arbitrary (Tuple a b)
168168
#### `coarbTuple`
169169

170170
``` purescript
171-
instance coarbTuple :: (CoArbitrary a, CoArbitrary b) => CoArbitrary (Tuple a b)
171+
instance coarbTuple :: (Coarbitrary a, Coarbitrary b) => Coarbitrary (Tuple a b)
172172
```
173173

174174

@@ -182,7 +182,7 @@ instance arbMaybe :: (Arbitrary a) => Arbitrary (Maybe a)
182182
#### `coarbMaybe`
183183

184184
``` purescript
185-
instance coarbMaybe :: (CoArbitrary a) => CoArbitrary (Maybe a)
185+
instance coarbMaybe :: (Coarbitrary a) => Coarbitrary (Maybe a)
186186
```
187187

188188

@@ -196,7 +196,7 @@ instance arbEither :: (Arbitrary a, Arbitrary b) => Arbitrary (Either a b)
196196
#### `coarbEither`
197197

198198
``` purescript
199-
instance coarbEither :: (CoArbitrary a, CoArbitrary b) => CoArbitrary (Either a b)
199+
instance coarbEither :: (Coarbitrary a, Coarbitrary b) => Coarbitrary (Either a b)
200200
```
201201

202202

docs/Test.QuickCheck.Data.AlphaNumString.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ instance arbAlphaNumString :: Arbitrary AlphaNumString
2222
#### `coarbAlphaNumString`
2323

2424
``` purescript
25-
instance coarbAlphaNumString :: CoArbitrary AlphaNumString
25+
instance coarbAlphaNumString :: Coarbitrary AlphaNumString
2626
```
2727

2828

docs/Test.QuickCheck.Data.ApproxNumber.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ instance arbitraryApproxNumber :: Arbitrary ApproxNumber
2828
#### `coarbitraryApproxNumber`
2929

3030
``` purescript
31-
instance coarbitraryApproxNumber :: CoArbitrary ApproxNumber
31+
instance coarbitraryApproxNumber :: Coarbitrary ApproxNumber
3232
```
3333

3434

src/Test/QuickCheck/Arbitrary.purs

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,54 +18,54 @@ import Test.QuickCheck.Gen
1818
class Arbitrary t where
1919
arbitrary :: Gen t
2020

21-
-- | The `CoArbitrary` class represents types which appear on the left of
21+
-- | The `Coarbitrary` class represents types which appear on the left of
2222
-- | an `Arbitrary` function arrow.
2323
-- |
2424
-- | To construct an `Arbitrary` instance for the type `a -> b`, we need to
2525
-- | use the input of type `a` to _perturb_ a random generator for `b`. This
2626
-- | is the role of the `coarbitrary` function.
2727
-- |
28-
-- | `CoArbitrary` instances can be written using the `perturbGen` function.
29-
class CoArbitrary t where
28+
-- | `Coarbitrary` instances can be written using the `perturbGen` function.
29+
class Coarbitrary t where
3030
coarbitrary :: forall r. t -> Gen r -> Gen r
3131

3232
instance arbBoolean :: Arbitrary Boolean where
3333
arbitrary = do
3434
n <- uniform
3535
return $ (n * 2) < 1
3636

37-
instance coarbBoolean :: CoArbitrary Boolean where
37+
instance coarbBoolean :: Coarbitrary Boolean where
3838
coarbitrary true = perturbGen 1
3939
coarbitrary false = perturbGen 2
4040

4141
instance arbNumber :: Arbitrary Number where
4242
arbitrary = uniform
4343

44-
instance coarbNumber :: CoArbitrary Number where
44+
instance coarbNumber :: Coarbitrary Number where
4545
coarbitrary = perturbGen
4646

4747
instance arbInt :: Arbitrary Int where
4848
arbitrary = chooseInt (fromNumber (-1000000)) (fromNumber 1000000)
4949

50-
instance coarbInt :: CoArbitrary Int where
50+
instance coarbInt :: Coarbitrary Int where
5151
coarbitrary = perturbGen <<< toNumber
5252

5353
instance arbString :: Arbitrary String where
5454
arbitrary = fromCharArray <$> arbitrary
5555

56-
instance coarbString :: CoArbitrary String where
56+
instance coarbString :: Coarbitrary String where
5757
coarbitrary s = coarbitrary $ (charCodeAt zero <$> split "" s)
5858

5959
instance arbChar :: Arbitrary Char where
6060
arbitrary = fromCharCode <<< fromNumber <<< (* 65535) <$> uniform
6161

62-
instance coarbChar :: CoArbitrary Char where
62+
instance coarbChar :: Coarbitrary Char where
6363
coarbitrary c = coarbitrary $ toCharCode c
6464

6565
instance arbUnit :: Arbitrary Unit where
6666
arbitrary = return unit
6767

68-
instance coarbUnit :: CoArbitrary Unit where
68+
instance coarbUnit :: Coarbitrary Unit where
6969
coarbitrary _ = perturbGen 1
7070

7171
instance arbOrdering :: Arbitrary Ordering where
@@ -76,7 +76,7 @@ instance arbOrdering :: Arbitrary Ordering where
7676
2 -> EQ
7777
3 -> GT
7878

79-
instance coarbOrdering :: CoArbitrary Ordering where
79+
instance coarbOrdering :: Coarbitrary Ordering where
8080
coarbitrary LT = perturbGen 1
8181
coarbitrary EQ = perturbGen 2
8282
coarbitrary GT = perturbGen 3
@@ -89,30 +89,30 @@ instance arbArray :: (Arbitrary a) => Arbitrary [a] where
8989
as <- arbitrary
9090
return (a : as)
9191

92-
instance coarbArray :: (CoArbitrary a) => CoArbitrary [a] where
92+
instance coarbArray :: (Coarbitrary a) => Coarbitrary [a] where
9393
coarbitrary [] = id
9494
coarbitrary (x : xs) = coarbitrary xs <<< coarbitrary x
9595

96-
instance arbFunction :: (CoArbitrary a, Arbitrary b) => Arbitrary (a -> b) where
96+
instance arbFunction :: (Coarbitrary a, Arbitrary b) => Arbitrary (a -> b) where
9797
arbitrary = repeatable (\a -> coarbitrary a arbitrary)
9898

99-
instance coarbFunction :: (Arbitrary a, CoArbitrary b) => CoArbitrary (a -> b) where
99+
instance coarbFunction :: (Arbitrary a, Coarbitrary b) => Coarbitrary (a -> b) where
100100
coarbitrary f gen = do
101101
xs <- arbitrary
102102
coarbitrary (map f xs) gen
103103

104104
instance arbTuple :: (Arbitrary a, Arbitrary b) => Arbitrary (Tuple a b) where
105105
arbitrary = Tuple <$> arbitrary <*> arbitrary
106106

107-
instance coarbTuple :: (CoArbitrary a, CoArbitrary b) => CoArbitrary (Tuple a b) where
107+
instance coarbTuple :: (Coarbitrary a, Coarbitrary b) => Coarbitrary (Tuple a b) where
108108
coarbitrary (Tuple a b) = coarbitrary a >>> coarbitrary b
109109

110110
instance arbMaybe :: (Arbitrary a) => Arbitrary (Maybe a) where
111111
arbitrary = do
112112
b <- arbitrary
113113
if b then pure Nothing else Just <$> arbitrary
114114

115-
instance coarbMaybe :: (CoArbitrary a) => CoArbitrary (Maybe a) where
115+
instance coarbMaybe :: (Coarbitrary a) => Coarbitrary (Maybe a) where
116116
coarbitrary Nothing = perturbGen 1
117117
coarbitrary (Just a) = coarbitrary a
118118

@@ -121,6 +121,6 @@ instance arbEither :: (Arbitrary a, Arbitrary b) => Arbitrary (Either a b) where
121121
b <- arbitrary
122122
if b then Left <$> arbitrary else Right <$> arbitrary
123123

124-
instance coarbEither :: (CoArbitrary a, CoArbitrary b) => CoArbitrary (Either a b) where
124+
instance coarbEither :: (Coarbitrary a, Coarbitrary b) => Coarbitrary (Either a b) where
125125
coarbitrary (Left a) = coarbitrary a
126126
coarbitrary (Right b) = coarbitrary b

src/Test/QuickCheck/Data/AlphaNumString.purs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ instance arbAlphaNumString :: Arbitrary AlphaNumString where
2222
in charAt index chars
2323

2424

25-
instance coarbAlphaNumString :: CoArbitrary AlphaNumString where
25+
instance coarbAlphaNumString :: Coarbitrary AlphaNumString where
2626
coarbitrary (AlphaNumString s) = coarbitrary s

src/Test/QuickCheck/Data/ApproxNumber.purs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ newtype ApproxNumber = ApproxNumber Number
1515
instance arbitraryApproxNumber :: Arbitrary ApproxNumber where
1616
arbitrary = ApproxNumber <$> arbitrary
1717

18-
instance coarbitraryApproxNumber :: CoArbitrary ApproxNumber where
18+
instance coarbitraryApproxNumber :: Coarbitrary ApproxNumber where
1919
coarbitrary (ApproxNumber n) = coarbitrary n
2020

2121
instance eqApproxNumber :: Eq ApproxNumber where

0 commit comments

Comments
 (0)