diff options
| author | ywang <yw05@forksworld.de> | 2021-11-03 18:55:31 +0100 |
|---|---|---|
| committer | ywang <yw05@forksworld.de> | 2021-11-07 13:49:01 +0100 |
| commit | be2f37a0678c66278d1c491b8f1250a8a3be9feb (patch) | |
| tree | ff592e9890892b0d0c6c9dc9b5e8ec81f76a956c /advtrains/doc/advtrains_speed_lessp.3advtrains.md | |
| parent | 22994705235dfcdfbdc9966a9ba037d657188b5a (diff) | |
| download | advtrains-be2f37a0678c66278d1c491b8f1250a8a3be9feb.tar.gz advtrains-be2f37a0678c66278d1c491b8f1250a8a3be9feb.tar.bz2 advtrains-be2f37a0678c66278d1c491b8f1250a8a3be9feb.zip | |
Support different types of speed restrictions; add documentation
Diffstat (limited to 'advtrains/doc/advtrains_speed_lessp.3advtrains.md')
| -rw-r--r-- | advtrains/doc/advtrains_speed_lessp.3advtrains.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/advtrains/doc/advtrains_speed_lessp.3advtrains.md b/advtrains/doc/advtrains_speed_lessp.3advtrains.md new file mode 100644 index 0000000..165d028 --- /dev/null +++ b/advtrains/doc/advtrains_speed_lessp.3advtrains.md @@ -0,0 +1,15 @@ +% advtrains.speed.lessp(3advtrains) | Advtrains Developer's Manual + +# NAME +`advtrains.speed.lessp`, `advtrains.speed.greaterp`, `advtrains.speed.not_lessp`, `advtrains.speed_not_greaterp`, `advtrains.speed.equalp`, `advtrains.speed.not_equalp`, `advtrains.speed.max`, `advtrains.speed.min` - speed restriction comparison functions + +# SYNOPSIS +Each function takes two arguments and returns a boolean or (for `advtrains.speed.max` and `advtrains.speed.min`) a valid speed limit + +# DESCRIPTION + +The functions above correspond to the arithmetic `<`, `>`, `>=`, `<=`, `==`, `~=` operators and the `math.max` and `math.min` functions, respectively. The constants `nil` and `false` are treated as -1. + +# NOTES + +These functions are trivial to implement and the implementation can be easily embedded into existing code. They are simply provided for convenience. |