Skip to content

Commit e822675

Browse files
authored
[fixes #2168] Change names in Algebra.Consequences.* to reflect style-guide conventions (#2206)
* fixes issue #2168 * added more names for deprecation, plus `hiding` them in `Propositional`
1 parent afdc679 commit e822675

File tree

13 files changed

+383
-141
lines changed

13 files changed

+383
-141
lines changed

CHANGELOG.md

Lines changed: 54 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1276,6 +1276,44 @@ Deprecated modules
12761276
Deprecated names
12771277
----------------
12781278

1279+
* In `Algebra.Consequences.Propositional`:
1280+
```agda
1281+
comm+assoc⇒middleFour ↦ comm∧assoc⇒middleFour
1282+
identity+middleFour⇒assoc ↦ identity∧middleFour⇒assoc
1283+
identity+middleFour⇒comm ↦ identity∧middleFour⇒comm
1284+
comm+distrˡ⇒distrʳ ↦ comm∧distrˡ⇒distrʳ
1285+
comm+distrʳ⇒distrˡ ↦ comm∧distrʳ⇒distrˡ
1286+
assoc+distribʳ+idʳ+invʳ⇒zeˡ ↦ assoc∧distribʳ∧idʳ∧invʳ⇒zeˡ
1287+
assoc+distribˡ+idʳ+invʳ⇒zeʳ ↦ assoc∧distribˡ∧idʳ∧invʳ⇒zeʳ
1288+
assoc+id+invʳ⇒invˡ-unique ↦ assoc∧id∧invʳ⇒invˡ-unique
1289+
assoc+id+invˡ⇒invʳ-unique ↦ assoc∧id∧invˡ⇒invʳ-unique
1290+
subst+comm⇒sym ↦ subst∧comm⇒sym
1291+
```
1292+
1293+
* In `Algebra.Consequences.Setoid`:
1294+
```agda
1295+
comm+assoc⇒middleFour ↦ comm∧assoc⇒middleFour
1296+
identity+middleFour⇒assoc ↦ identity∧middleFour⇒assoc
1297+
identity+middleFour⇒comm ↦ identity∧middleFour⇒comm
1298+
comm+cancelˡ⇒cancelʳ ↦ comm∧cancelˡ⇒cancelʳ
1299+
comm+cancelʳ⇒cancelˡ ↦ comm∧cancelʳ⇒cancelˡ
1300+
comm+almostCancelˡ⇒almostCancelʳ ↦ comm∧almostCancelˡ⇒almostCancelʳ
1301+
comm+almostCancelʳ⇒almostCancelˡ ↦ comm∧almostCancelʳ⇒almostCancelˡ
1302+
comm+idˡ⇒idʳ ↦ comm∧idˡ⇒idʳ
1303+
comm+idʳ⇒idˡ ↦ comm∧idʳ⇒idˡ
1304+
comm+zeˡ⇒zeʳ ↦ comm∧zeˡ⇒zeʳ
1305+
comm+zeʳ⇒zeˡ ↦ comm∧zeʳ⇒zeˡ
1306+
comm+invˡ⇒invʳ ↦ comm∧invˡ⇒invʳ
1307+
comm+invʳ⇒invˡ ↦ comm∧invʳ⇒invˡ
1308+
comm+distrˡ⇒distrʳ ↦ comm∧distrˡ⇒distrʳ
1309+
comm+distrʳ⇒distrˡ ↦ comm∧distrʳ⇒distrˡ
1310+
assoc+distribʳ+idʳ+invʳ⇒zeˡ ↦ assoc∧distribʳ∧idʳ∧invʳ⇒zeˡ
1311+
assoc+distribˡ+idʳ+invʳ⇒zeʳ ↦ assoc∧distribˡ∧idʳ∧invʳ⇒zeʳ
1312+
assoc+id+invʳ⇒invˡ-unique ↦ assoc∧id∧invʳ⇒invˡ-unique
1313+
assoc+id+invˡ⇒invʳ-unique ↦ assoc∧id∧invˡ⇒invʳ-unique
1314+
subst+comm⇒sym ↦ subst∧comm⇒sym
1315+
```
1316+
12791317
* In `Algebra.Construct.Zero`:
12801318
```agda
12811319
rawMagma ↦ Algebra.Construct.Terminal.rawMagma
@@ -2177,21 +2215,21 @@ Additions to existing modules
21772215

21782216
* Added new proof to `Algebra.Consequences.Base`:
21792217
```agda
2180-
reflexive+selfInverse⇒involutive : Reflexive _≈_ → SelfInverse _≈_ f → Involutive _≈_ f
2218+
reflexiveselfInverse⇒involutive : Reflexive _≈_ → SelfInverse _≈_ f → Involutive _≈_ f
21812219
```
21822220

21832221
* Added new proofs to `Algebra.Consequences.Propositional`:
21842222
```agda
2185-
comm+assoc⇒middleFour : Commutative _∙_ → Associative _∙_ → _∙_ MiddleFourExchange _∙_
2186-
identity+middleFour⇒assoc : Identity e _∙_ → _∙_ MiddleFourExchange _∙_ → Associative _∙_
2187-
identity+middleFour⇒comm : Identity e _+_ → _∙_ MiddleFourExchange _+_ → Commutative _∙_
2223+
commassoc⇒middleFour : Commutative _∙_ → Associative _∙_ → _∙_ MiddleFourExchange _∙_
2224+
identitymiddleFour⇒assoc : Identity e _∙_ → _∙_ MiddleFourExchange _∙_ → Associative _∙_
2225+
identitymiddleFour⇒comm : Identity e _+_ → _∙_ MiddleFourExchange _+_ → Commutative _∙_
21882226
```
21892227

21902228
* Added new proofs to `Algebra.Consequences.Setoid`:
21912229
```agda
2192-
comm+assoc⇒middleFour : Congruent₂ _∙_ → Commutative _∙_ → Associative _∙_ → _∙_ MiddleFourExchange _∙_
2193-
identity+middleFour⇒assoc : Congruent₂ _∙_ → Identity e _∙_ → _∙_ MiddleFourExchange _∙_ → Associative _∙_
2194-
identity+middleFour⇒comm : Congruent₂ _∙_ → Identity e _+_ → _∙_ MiddleFourExchange _+_ → Commutative _∙_
2230+
commassoc⇒middleFour : Congruent₂ _∙_ → Commutative _∙_ → Associative _∙_ → _∙_ MiddleFourExchange _∙_
2231+
identitymiddleFour⇒assoc : Congruent₂ _∙_ → Identity e _∙_ → _∙_ MiddleFourExchange _∙_ → Associative _∙_
2232+
identitymiddleFour⇒comm : Congruent₂ _∙_ → Identity e _+_ → _∙_ MiddleFourExchange _+_ → Commutative _∙_
21952233
21962234
involutive⇒surjective : Involutive f → Surjective f
21972235
selfInverse⇒involutive : SelfInverse f → Involutive f
@@ -2201,15 +2239,15 @@ Additions to existing modules
22012239
selfInverse⇒injective : SelfInverse f → Injective f
22022240
selfInverse⇒bijective : SelfInverse f → Bijective f
22032241
2204-
comm+idˡ⇒id : Commutative _∙_ → LeftIdentity e _∙_ → Identity e _∙_
2205-
comm+idʳ⇒id : Commutative _∙_ → RightIdentity e _∙_ → Identity e _∙_
2206-
comm+zeˡ⇒ze : Commutative _∙_ → LeftZero e _∙_ → Zero e _∙_
2207-
comm+zeʳ⇒ze : Commutative _∙_ → RightZero e _∙_ → Zero e _∙_
2208-
comm+invˡ⇒inv : Commutative _∙_ → LeftInverse e _⁻¹ _∙_ → Inverse e _⁻¹ _∙_
2209-
comm+invʳ⇒inv : Commutative _∙_ → RightInverse e _⁻¹ _∙_ → Inverse e _⁻¹ _∙_
2210-
comm+distrˡ⇒distr : Commutative _∙_ → _∙_ DistributesOverˡ _◦_ → _∙_ DistributesOver _◦_
2211-
comm+distrʳ⇒distr : Commutative _∙_ → _∙_ DistributesOverʳ _◦_ → _∙_ DistributesOver _◦_
2212-
distrib+absorbs⇒distribˡ : Associative _∙_ → Commutative _◦_ → _∙_ Absorbs _◦_ → _◦_ Absorbs _∙_ → _◦_ DistributesOver _∙_ → _∙_ DistributesOverˡ _◦_
2242+
commidˡ⇒id : Commutative _∙_ → LeftIdentity e _∙_ → Identity e _∙_
2243+
commidʳ⇒id : Commutative _∙_ → RightIdentity e _∙_ → Identity e _∙_
2244+
commzeˡ⇒ze : Commutative _∙_ → LeftZero e _∙_ → Zero e _∙_
2245+
commzeʳ⇒ze : Commutative _∙_ → RightZero e _∙_ → Zero e _∙_
2246+
comminvˡ⇒inv : Commutative _∙_ → LeftInverse e _⁻¹ _∙_ → Inverse e _⁻¹ _∙_
2247+
comminvʳ⇒inv : Commutative _∙_ → RightInverse e _⁻¹ _∙_ → Inverse e _⁻¹ _∙_
2248+
commdistrˡ⇒distr : Commutative _∙_ → _∙_ DistributesOverˡ _◦_ → _∙_ DistributesOver _◦_
2249+
commdistrʳ⇒distr : Commutative _∙_ → _∙_ DistributesOverʳ _◦_ → _∙_ DistributesOver _◦_
2250+
distribabsorbs⇒distribˡ : Associative _∙_ → Commutative _◦_ → _∙_ Absorbs _◦_ → _◦_ Absorbs _∙_ → _◦_ DistributesOver _∙_ → _∙_ DistributesOverˡ _◦_
22132251
```
22142252

22152253
* Added new functions to `Algebra.Construct.DirectProduct`:

src/Algebra/Consequences/Base.agda

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,21 @@ module _ {ℓ} {_•_ : Op₂ A} (_≈_ : Rel A ℓ) where
2323

2424
module _ {ℓ} {f : Op₁ A} (_≈_ : Rel A ℓ) where
2525

26-
reflexive+selfInverse⇒involutive : Reflexive _≈_
26+
reflexiveselfInverse⇒involutive : Reflexive _≈_
2727
SelfInverse _≈_ f
2828
Involutive _≈_ f
29-
reflexive+selfInverse⇒involutive refl inv _ = inv refl
29+
reflexiveselfInverse⇒involutive refl inv _ = inv refl
3030

31+
------------------------------------------------------------------------
32+
-- DEPRECATED NAMES
33+
------------------------------------------------------------------------
34+
-- Please use the new names as continuing support for the old names is
35+
-- not guaranteed.
36+
37+
-- Version 2.0
38+
39+
reflexive+selfInverse⇒involutive = reflexive∧selfInverse⇒involutive
40+
{-# WARNING_ON_USAGE reflexive+selfInverse⇒involutive
41+
"Warning: reflexive+selfInverse⇒involutive was deprecated in v2.0.
42+
Please use reflexive∧selfInverse⇒involutive instead."
43+
#-}

src/Algebra/Consequences/Propositional.agda

Lines changed: 97 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,21 @@ import Algebra.Consequences.Setoid (setoid A) as Base
2626

2727
open Base public
2828
hiding
29-
( comm+assoc⇒middleFour
29+
( comm∧assoc⇒middleFour
30+
; identity∧middleFour⇒assoc
31+
; identity∧middleFour⇒comm
32+
; assoc∧distribʳ∧idʳ∧invʳ⇒zeˡ
33+
; assoc∧distribˡ∧idʳ∧invʳ⇒zeʳ
34+
; assoc∧id∧invʳ⇒invˡ-unique
35+
; assoc∧id∧invˡ⇒invʳ-unique
36+
; comm∧distrˡ⇒distrʳ
37+
; comm∧distrʳ⇒distrˡ
38+
; comm⇒sym[distribˡ]
39+
; subst∧comm⇒sym
40+
; wlog
41+
; sel⇒idem
42+
-- plus all the deprecated versions of the above
43+
; comm+assoc⇒middleFour
3044
; identity+middleFour⇒assoc
3145
; identity+middleFour⇒comm
3246
; assoc+distribʳ+idʳ+invʳ⇒zeˡ
@@ -35,54 +49,51 @@ open Base public
3549
; assoc+id+invˡ⇒invʳ-unique
3650
; comm+distrˡ⇒distrʳ
3751
; comm+distrʳ⇒distrˡ
38-
; comm⇒sym[distribˡ]
3952
; subst+comm⇒sym
40-
; wlog
41-
; sel⇒idem
4253
)
4354

4455
------------------------------------------------------------------------
4556
-- Group-like structures
4657

4758
module _ {_∙_ _⁻¹ ε} where
4859

49-
assoc+id+invʳ⇒invˡ-unique : Associative _∙_ Identity ε _∙_
60+
assoc∧id∧invʳ⇒invˡ-unique : Associative _∙_ Identity ε _∙_
5061
RightInverse ε _⁻¹ _∙_
5162
x y (x ∙ y) ≡ ε x ≡ (y ⁻¹)
52-
assoc+id+invʳ⇒invˡ-unique = Base.assoc+id+invʳ⇒invˡ-unique (cong₂ _)
63+
assoc∧id∧invʳ⇒invˡ-unique = Base.assoc∧id∧invʳ⇒invˡ-unique (cong₂ _)
5364

54-
assoc+id+invˡ⇒invʳ-unique : Associative _∙_ Identity ε _∙_
65+
assoc∧id∧invˡ⇒invʳ-unique : Associative _∙_ Identity ε _∙_
5566
LeftInverse ε _⁻¹ _∙_
5667
x y (x ∙ y) ≡ ε y ≡ (x ⁻¹)
57-
assoc+id+invˡ⇒invʳ-unique = Base.assoc+id+invˡ⇒invʳ-unique (cong₂ _)
68+
assoc∧id∧invˡ⇒invʳ-unique = Base.assoc∧id∧invˡ⇒invʳ-unique (cong₂ _)
5869

5970
------------------------------------------------------------------------
6071
-- Ring-like structures
6172

6273
module _ {_+_ _*_ -_ 0#} where
6374

64-
assoc+distribʳ+idʳ+invʳ⇒zeˡ : Associative _+_ _*_ DistributesOverʳ _+_
75+
assocdistribʳidʳinvʳ⇒zeˡ : Associative _+_ _*_ DistributesOverʳ _+_
6576
RightIdentity 0# _+_ RightInverse 0# -_ _+_
6677
LeftZero 0# _*_
67-
assoc+distribʳ+idʳ+invʳ⇒zeˡ =
68-
Base.assoc+distribʳ+idʳ+invʳ⇒zeˡ (cong₂ _+_) (cong₂ _*_)
78+
assocdistribʳidʳinvʳ⇒zeˡ =
79+
Base.assocdistribʳidʳinvʳ⇒zeˡ (cong₂ _+_) (cong₂ _*_)
6980

70-
assoc+distribˡ+idʳ+invʳ⇒zeʳ : Associative _+_ _*_ DistributesOverˡ _+_
81+
assocdistribˡidʳinvʳ⇒zeʳ : Associative _+_ _*_ DistributesOverˡ _+_
7182
RightIdentity 0# _+_ RightInverse 0# -_ _+_
7283
RightZero 0# _*_
73-
assoc+distribˡ+idʳ+invʳ⇒zeʳ =
74-
Base.assoc+distribˡ+idʳ+invʳ⇒zeʳ (cong₂ _+_) (cong₂ _*_)
84+
assocdistribˡidʳinvʳ⇒zeʳ =
85+
Base.assocdistribˡidʳinvʳ⇒zeʳ (cong₂ _+_) (cong₂ _*_)
7586

7687
------------------------------------------------------------------------
7788
-- Bisemigroup-like structures
7889

7990
module _ {_∙_ _◦_ : Op₂ A} (∙-comm : Commutative _∙_) where
8091

81-
comm+distrˡ⇒distrʳ : _∙_ DistributesOverˡ _◦_ _∙_ DistributesOverʳ _◦_
82-
comm+distrˡ⇒distrʳ = Base.comm+distrˡ⇒distrʳ (cong₂ _) ∙-comm
92+
commdistrˡ⇒distrʳ : _∙_ DistributesOverˡ _◦_ _∙_ DistributesOverʳ _◦_
93+
commdistrˡ⇒distrʳ = Base.comm+distrˡ⇒distrʳ (cong₂ _) ∙-comm
8394

84-
comm+distrʳ⇒distrˡ : _∙_ DistributesOverʳ _◦_ _∙_ DistributesOverˡ _◦_
85-
comm+distrʳ⇒distrˡ = Base.comm+distrʳ⇒distrˡ (cong₂ _) ∙-comm
95+
commdistrʳ⇒distrˡ : _∙_ DistributesOverʳ _◦_ _∙_ DistributesOverˡ _◦_
96+
commdistrʳ⇒distrˡ = Base.commdistrʳ⇒distrˡ (cong₂ _) ∙-comm
8697

8798
comm⇒sym[distribˡ] : x Symmetric (λ y z (x ◦ (y ∙ z)) ≡ ((x ◦ y) ∙ (x ◦ z)))
8899
comm⇒sym[distribˡ] = Base.comm⇒sym[distribˡ] (cong₂ _◦_) ∙-comm
@@ -100,31 +111,91 @@ module _ {_∙_ : Op₂ A} where
100111

101112
module _ {_∙_ : Op₂ A} where
102113

103-
comm+assoc⇒middleFour : Commutative _∙_ Associative _∙_
114+
commassoc⇒middleFour : Commutative _∙_ Associative _∙_
104115
_∙_ MiddleFourExchange _∙_
105-
comm+assoc⇒middleFour = Base.comm+assoc⇒middleFour (cong₂ _∙_)
116+
commassoc⇒middleFour = Base.commassoc⇒middleFour (cong₂ _∙_)
106117

107-
identity+middleFour⇒assoc : {e : A} Identity e _∙_
118+
identitymiddleFour⇒assoc : {e : A} Identity e _∙_
108119
_∙_ MiddleFourExchange _∙_
109120
Associative _∙_
110-
identity+middleFour⇒assoc = Base.identity+middleFour⇒assoc (cong₂ _∙_)
121+
identitymiddleFour⇒assoc = Base.identitymiddleFour⇒assoc (cong₂ _∙_)
111122

112-
identity+middleFour⇒comm : {_+_ : Op₂ A} {e : A} Identity e _+_
123+
identitymiddleFour⇒comm : {_+_ : Op₂ A} {e : A} Identity e _+_
113124
_∙_ MiddleFourExchange _+_
114125
Commutative _∙_
115-
identity+middleFour⇒comm = Base.identity+middleFour⇒comm (cong₂ _∙_)
126+
identitymiddleFour⇒comm = Base.identitymiddleFour⇒comm (cong₂ _∙_)
116127

117128
------------------------------------------------------------------------
118129
-- Without Loss of Generality
119130

120131
module _ {p} {P : Pred A p} where
121132

122-
subst+comm⇒sym : {f} (f-comm : Commutative f)
133+
substcomm⇒sym : {f} (f-comm : Commutative f)
123134
Symmetric (λ a b P (f a b))
124-
subst+comm⇒sym = Base.subst+comm⇒sym {P = P} subst
135+
substcomm⇒sym = Base.substcomm⇒sym {P = P} subst
125136

126137
wlog : {f} (f-comm : Commutative f)
127138
{r} {_R_ : Rel _ r} Total _R_
128139
( a b a R b P (f a b))
129140
a b P (f a b)
130141
wlog = Base.wlog {P = P} subst
142+
143+
144+
------------------------------------------------------------------------
145+
-- DEPRECATED NAMES
146+
------------------------------------------------------------------------
147+
-- Please use the new names as continuing support for the old names is
148+
-- not guaranteed.
149+
150+
-- Version 2.0
151+
152+
comm+assoc⇒middleFour = comm∧assoc⇒middleFour
153+
{-# WARNING_ON_USAGE comm+assoc⇒middleFour
154+
"Warning: comm+assoc⇒middleFour was deprecated in v2.0.
155+
Please use comm∧assoc⇒middleFour instead."
156+
#-}
157+
identity+middleFour⇒assoc = identity∧middleFour⇒assoc
158+
{-# WARNING_ON_USAGE identity+middleFour⇒assoc
159+
"Warning: identity+middleFour⇒assoc was deprecated in v2.0.
160+
Please use identity∧middleFour⇒assoc instead."
161+
#-}
162+
identity+middleFour⇒comm = identity∧middleFour⇒comm
163+
{-# WARNING_ON_USAGE identity+middleFour⇒comm
164+
"Warning: identity+middleFour⇒comm was deprecated in v2.0.
165+
Please use identity∧middleFour⇒comm instead."
166+
#-}
167+
comm+distrˡ⇒distrʳ = comm∧distrˡ⇒distrʳ
168+
{-# WARNING_ON_USAGE comm+distrˡ⇒distrʳ
169+
"Warning: comm+distrˡ⇒distrʳ was deprecated in v2.0.
170+
Please use comm∧distrˡ⇒distrʳ instead."
171+
#-}
172+
comm+distrʳ⇒distrˡ = comm∧distrʳ⇒distrˡ
173+
{-# WARNING_ON_USAGE comm+distrʳ⇒distrˡ
174+
"Warning: comm+distrʳ⇒distrˡ was deprecated in v2.0.
175+
Please use comm∧distrʳ⇒distrˡ instead."
176+
#-}
177+
assoc+distribʳ+idʳ+invʳ⇒zeˡ = assoc∧distribʳ∧idʳ∧invʳ⇒zeˡ
178+
{-# WARNING_ON_USAGE assoc+distribʳ+idʳ+invʳ⇒zeˡ
179+
"Warning: assoc+distribʳ+idʳ+invʳ⇒zeˡ was deprecated in v2.0.
180+
Please use assoc∧distribʳ∧idʳ∧invʳ⇒zeˡ instead."
181+
#-}
182+
assoc+distribˡ+idʳ+invʳ⇒zeʳ = assoc∧distribˡ∧idʳ∧invʳ⇒zeʳ
183+
{-# WARNING_ON_USAGE assoc+distribˡ+idʳ+invʳ⇒zeʳ
184+
"Warning: assoc+distribˡ+idʳ+invʳ⇒zeʳ was deprecated in v2.0.
185+
Please use assoc∧distribˡ∧idʳ∧invʳ⇒zeʳ instead."
186+
#-}
187+
assoc+id+invʳ⇒invˡ-unique = assoc∧id∧invʳ⇒invˡ-unique
188+
{-# WARNING_ON_USAGE assoc+id+invʳ⇒invˡ-unique
189+
"Warning: assoc+id+invʳ⇒invˡ-unique was deprecated in v2.0.
190+
Please use assoc∧id∧invʳ⇒invˡ-unique instead."
191+
#-}
192+
assoc+id+invˡ⇒invʳ-unique = assoc∧id∧invˡ⇒invʳ-unique
193+
{-# WARNING_ON_USAGE assoc+id+invˡ⇒invʳ-unique
194+
"Warning: assoc+id+invˡ⇒invʳ-unique was deprecated in v2.0.
195+
Please use assoc∧id∧invˡ⇒invʳ-unique instead."
196+
#-}
197+
subst+comm⇒sym = subst∧comm⇒sym
198+
{-# WARNING_ON_USAGE subst+comm⇒sym
199+
"Warning: subst+comm⇒sym was deprecated in v2.0.
200+
Please use subst∧comm⇒sym instead."
201+
#-}

0 commit comments

Comments
 (0)