{"id":21884097,"url":"https://github.com/leiless/base16","last_synced_at":"2025-03-22T01:28:09.406Z","repository":{"id":140254758,"uuid":"179308882","full_name":"leiless/base16","owner":"leiless","description":"A wicked fast RFC4648-conformed Base16 encoder/decoder","archived":false,"fork":false,"pushed_at":"2019-04-09T14:02:41.000Z","size":1476,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-15T00:39:52.898Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leiless.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-03T14:35:56.000Z","updated_at":"2021-09-01T09:59:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"9fe2898d-9ba9-4ac0-8d39-507be9eddcde","html_url":"https://github.com/leiless/base16","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leiless%2Fbase16","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leiless%2Fbase16/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leiless%2Fbase16/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leiless%2Fbase16/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leiless","download_url":"https://codeload.github.com/leiless/base16/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244892418,"owners_count":20527448,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-28T10:12:16.940Z","updated_at":"2025-03-22T01:28:09.383Z","avatar_url":"https://github.com/leiless.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"## base16 - A wicked fast RFC4648-conformed Base16 encoder/decoder\n\nThis Base16 implementation presents a way to optimize base16 encode/decode in linear facet(not significant) without intervention of SIMD instructions, provides a simple example of how `.data` segment cache can boost up data lookup.\n\n# Encode APIs\n\nThere're three encode methods:\n\n```c\nvoid nano_base16_encode_baseline(char * restrict, const void * restrict, size_t);\n\nvoid nano_base16_encode(char * restrict, const void * restrict, size_t);\n\nvoid nano_base16_encode2(char * restrict, const void * restrict, size_t);\n```\n\n### Which API should I choose for encode?\n\nTL;DR. `nano_base16_encode`\n\n`nano_base16_encode_baseline` uses definition-intuitive way for encoding.\n\n`nano_base16_encode` which encoding in a manner of taking a byte as a whole, which each time produce two encoded characters in an atomic way, with negligible(1kb) `.data` segment overhead.\n\n`nano_base16_encode2` encode in a manner of taking two bytes as a whole, which each time produce four encoded characters in an atomic way, with relative big `.data` segment overhead(around 512kb).\n\n# Decode APIs\n\nThere're two decode methods:\n\n```c\nssize_t nano_base16_decode_baseline(void * restrict, const char * restrict, size_t);\n\nssize_t nano_base16_decode(void * restrict, const char * restrict, size_t);\n```\n\nThe former uses definition-intuitive way for encoding.\n\nThe latter decode just like opposite of `nano_base16_encode2`, which take two bytes as a while in each iteration.\n\n# Test\n\n`test.c` provides all possible tests for Base16 encode/decode.\n\n```shell\n$ make [ debug | release ]\n$ ./test-debug\n```\n\n# Benchmark\n\nBenchmark machine:\n\n```\nIntel(R) Core(TM) i5-5287U CPU @ 2.90GHz (Max 3.30 GHz, 2 Cores, 4 Threads)\n16 GB 1867 MHz DDR3 RAM\n```\n\nWithout compiler level optimization:\n\n```shell\n$ make [ debug ]\n$ ./test-debug\n\nBenchmarking  size: 1073741824\nTime elapsed: 19.2773s\tnano_base16_encode_baseline()\nTime elapsed: 2.45246s\tnano_base16_encode()\nTime elapsed: 1.40033s\tnano_base16_encode2()\n\nBenchmarking  size: 3221225472\nTime elapsed: 46.7634s\tnano_base16_encode_baseline()\nTime elapsed: 7.32601s\tnano_base16_encode()\nTime elapsed: 4.20426s\tnano_base16_encode2()\n```\n\nWith `-O2` compiler level optimization:\n\n```shell\n$ make release\n$ ./test\n\nBenchmarking  size: 1073741824\nTime elapsed: 1.89828s\tnano_base16_encode_baseline()\nTime elapsed: 0.5519s\tnano_base16_encode()\nTime elapsed: 0.332284s\tnano_base16_encode2()\n\nBenchmarking  size: 3221225472\nTime elapsed: 5.59842s\tnano_base16_encode_baseline()\nTime elapsed: 1.66608s\tnano_base16_encode()\nTime elapsed: 0.993617s\tnano_base16_encode2()\n```\n\nAbove result reveal that the `nano_base16_encode` is a good in-production choice between speed and `.data` segment cache overhead.\n\n`nano_base16_decode_baseline` have similar performance as `nano_base16_encode`.\n\n`nano_base16_decode` have similar performance as `nano_base16_encode2`.\n\n# TODO\n\n* Run tests on big endian machine.\n\n* Windows platform porting.\n\n# *References*\n\n[The Base16, Base32, and Base64 Data Encodings](https://tools.ietf.org/html/rfc4648)\n\n[libbase64 - A simple libbase64 library](https://github.com/gozfree/gear-lib/tree/master/libbase64)\n\n[java base 16 编码和解码](https://gist.github.com/turbidsoul/5226998)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleiless%2Fbase16","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleiless%2Fbase16","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleiless%2Fbase16/lists"}