https://github.com/konnov/tlaki
TLAki: Little cute typed definitions in TLA+
https://github.com/konnov/tlaki
apalache tlaplus types
Last synced: 3 months ago
JSON representation
TLAki: Little cute typed definitions in TLA+
- Host: GitHub
- URL: https://github.com/konnov/tlaki
- Owner: konnov
- License: apache-2.0
- Created: 2024-05-14T07:33:30.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-16T11:11:29.000Z (almost 2 years ago)
- Last Synced: 2024-07-16T13:53:38.953Z (almost 2 years ago)
- Topics: apalache, tlaplus, types
- Language: TLA
- Homepage:
- Size: 9.77 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TLAki: Little cute typed definitions in TLA+
This project contains alternative definitions of commonly-used data structures:
- [Lists.tla][] are typed 0-based sequences of elements, as an alternative
to untyped 1-based [TLA+ Sequences][].
- [Tuples.tla][] are typed constructors for [TLA+ Tuples][].
When using these constructors, you do not need additional type annotations.
Our goal is not to replace the standard constructs of TLA+, but to
provide specification writers with alternative definitions, if they need them.
If you are looking for TLA+ definitions for all life circumstances,
check [TLA+ Community Modules][].
For example, too many people were wondering, why indices of TLA+
sequences start with 1? Why cannot they start with zero? The answer is simple:
They can, [Lists.tla][] contains definitions like that. To avoid name collisions
with [TLA+ Sequences][], we use alternative names that you can find in
programming languages.
## Examples
```tla
\* with Sequences
<<1, 2, 3>>[2] = 2
<<2, 3>> \o <<5, 6>> = <<2, 3, 5, 6>>
\* with Lists
At(List(<<1, 2, 3>>), 1) = 2
Concat(List(<<2, 3>>), List(<<5, 6>>)) = List(<<2, 3, 5, 6>>)
\* standard TLA+: a triple is also a sequence
<<5, 6>>
<<1, 2, 3>>
\* with Tuples: a triple that is definitely annotated as a tuple
Pair(5, 6)
T2(5, 6)
T3(1, 2, 3)
```
## Name
How to pronounce TLAki? [tee-el-ay-kee]. In my mother tongue, the suffix '-ki'
usually points to little or cute things, animals, or people. Like, in
[Pirozhki][].
[TLA+ Community Modules]: https://github.com/tlaplus/CommunityModules
[Lists.tla]: ./src/Lists.tla
[Tuples.tla]: ./src/Tuples.tla
[TLA+ Sequences]: https://apalache.informal.systems/docs/lang/sequences.html
[TLA+ Tuples]: https://apalache.informal.systems/docs/lang/tuples.html
[Apalache]: https://github.com/informalsystems/apalache
[Pirozhki]: https://en.wikipedia.org/wiki/Pirozhki