From 037d3db802424e94cc2924edcdec310e28c23a73 Mon Sep 17 00:00:00 2001 From: Austen Adler Date: Wed, 15 Feb 2023 21:16:59 -0500 Subject: [PATCH] Decrement word range from 1-3 to 0-2 --- docs/ALGORITHM.adoc | 6 +++--- docs/DESIGN.adoc | 16 ++++++++-------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/ALGORITHM.adoc b/docs/ALGORITHM.adoc index 035d2e3..f7f5de1 100644 --- a/docs/ALGORITHM.adoc +++ b/docs/ALGORITHM.adoc @@ -15,9 +15,9 @@ [source,title='this_algorithm and S2 CellID Format'] ---- === this_algorithm Format === -WORD3 (13 bits) : vvvvvvvvvvvvv -WORD2 (13 bits) : | |vvv vvvvvvvvvv -WORD1 (13 bits) : | | |vvvvvv vvvvvvv +WORD2 (13 bits) : vvvvvvvvvvvvv +WORD1 (13 bits) : | |vvv vvvvvvvvvv +WORD0 (13 bits) : | | |vvvvvv vvvvvvv 0000 (10 bits) : | | | |vvvvvvvvv v Not represented : | | | | | : | | | | | diff --git a/docs/DESIGN.adoc b/docs/DESIGN.adoc index fefb1d0..ad9b78b 100644 --- a/docs/DESIGN.adoc +++ b/docs/DESIGN.adoc @@ -304,7 +304,7 @@ Where stem:[text(num_prefix)] is the number of number/letter combinations in the |=== -NOTE: This project will use the `(1-1024) WORD1 WORD2 WORD3` variation (1 number component, and 3 word component). +NOTE: This project will use the `(1-1024) WORD0 WORD1 WORD2` variation (1 number component, and 3 word component). It is longer than Xaddress and what3words, but with the tradeoff of having a significantly smaller dictionary than both. It requires a larger wordlist than the `9999 WORD WORD WORD` variation, but it allows versioning. @@ -316,7 +316,7 @@ This might make more sense in loactions where numbers might come before word por TODO: I need better reasoning here with examples. NOTE: This algorithm will allow exactly two encoding types. -Both `0000 WORD1 WORD2 WORD3` and `WORD3 WORD2 WORD1 0000` formats are equivalent. +Both `0000 WORD0 WORD1 WORD2` and `WORD2 WORD1 WORD0 0000` formats are equivalent. === Versioning [[versioning]] @@ -390,12 +390,12 @@ For example, the digits could be the smallest resolution on a per-adjacent cell |=== -The domain of each component of the address `0000 WORD1 WORD2 WORD3` is as follows: +The domain of each component of the address `0000 WORD0 WORD1 WORD2` is as follows: . `0000` - Responsible for the least significant bits in the encoded layout (smallest area) +. `WORD0` . `WORD1` -. `WORD2` -. `WORD3` - Responsible for the most significant bits in the encoded layout (largest area) +. `WORD2` - Responsible for the most significant bits in the encoded layout (largest area) NOTE: This algorithm will preserve locality in all components by requiring that sameness implies locality in every component. @@ -489,9 +489,9 @@ Bit : 64 48 32 16 : 01001011101010001011100010010011 1001001100100l001100000000000000 Not represented : ^^^^^^^^^^^^^^^ 0000 (10 bits) : ^^^^^^^^^^ -WORD1 (13 bits) : ^^^^^^ ^^^^^^^ -WORD2 (13 bits) : ^^^^^^^^^^^^^ -WORD3 (13 bits) : ^^^^^^^^^^^^^ +WORD0 (13 bits) : ^^^^^^ ^^^^^^^ +WORD1 (13 bits) : ^^^^^^^^^^^^^ +WORD2 (13 bits) : ^^^^^^^^^^^^^ ---- Note that this is just what each component is responsible for encoding, but does not specify exactly how to encode the selected bits.