naming.txt 1.45 KB
Newer Older
1 2
------------------ Naming conventions for variables/arguments/hypotheses in the Coq development ------------------

3 4 5 6 7 8
== small letters ==
a : A : cmraT or cofeT
b : B : cmraT or cofeT
c
d
e : expr = expressions
Ralf Jung's avatar
Ralf Jung committed
9 10
f : some generic function
g : some generic function
11 12 13 14 15 16 17 18
h : heap
i
j
k
l
m : iGst = ghost state
n
o
David Swasey's avatar
David Swasey committed
19
p
20
q
Ralf Jung's avatar
Ralf Jung committed
21
r : iRes = resources
22
s : state (STSs), stuckness bits
23 24 25 26 27 28 29 30 31 32 33 34 35 36
t
u
v : val = values of language
w
x
y
z 

== capital letters ==
A : Type, cmraT or cofeT
B : Type, cmraT or cofeT
C
D   
E : coPset = Viewshift masks
Ralf Jung's avatar
Ralf Jung committed
37
F : a functor
38
G
Ralf Jung's avatar
Ralf Jung committed
39
H : hypotheses
40 41 42
I : indexing sets
J
K : ectx = evaluation contexts
Ralf Jung's avatar
Ralf Jung committed
43
    keys of a map
44
L
Ralf Jung's avatar
Ralf Jung committed
45
M : maps / global CMRA
46 47 48 49 50 51 52 53
N : namespace
O 
P : uPred, iProp or Prop
Q : uPred, iProp or Prop
R : uPred, iProp or Prop
S : set state = state sets in STSs
T : set token = token sets in STSs
U
Ralf Jung's avatar
Ralf Jung committed
54
V : abstraction of value type in frame shift assertions
55 56 57 58 59 60
W
X : sets
Y : sets
Z : sets

== small greek letters ==
Ralf Jung's avatar
Ralf Jung committed
61
γ : gname
62
σ : state = state of language
Ralf Jung's avatar
Ralf Jung committed
63 64 65 66 67
φ : interpretation of STS/Auth

== capital greek letters ==
Φ : general predicate (over uPred, iProp or Prop)
Ψ : general predicate (over uPred, iProp or Prop)
68 69 70 71 72 73 74 75 76 77 78

------------------ Naming conventions for definitions in the Coq development ------------------

== Postfixes (may be combined) ==

C: OFEs
R: resource algebras and cameras
F: functors
UR: unital cameras or resources algebras
T: canonical structurs with extra algebraic structure (for example ofeT for OFEs, cmraT for cameras)
G: global camera functor management