CDC.IO Utility - Code Documentation

License

This is licensed software a copy of the license should have been included in the source tree for this module. You may find a copy of the license here: https://www.gnu.org/licenses/gpl-3.0.en.html

Copyright (c) 2019-2024 Steven Zoppi

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Indexes and tables

Word Formats

CDC Words are 60-bit, big-endian. CDC Characters are 6-bits each. Zero-based offsets are shown here though it is common to use one-based offsets.

CDC Words are ones-complement integer representations so -0 is not the same as 0.

(MSB + 5 and 5 + LSB are shown here for illustration.)

01234567891011MSBchr0chr1chr2chr3chr4chr5chr6chr7chr8chr9LSB

On-Disk representations of the structures are found on the codex at https://codex.sjzoppi.com/cdc.io:start