Lady’s Gitweb - Habu/blob - README.markdown

   1 # 🎐📦 ハブ
   2
   3 A compact storage data structure for lists of bitfields with support
   4 for arbitrary bitwidths (≤ 64).
   5
   6 ```js
   7 import ハブ from "./mod.js";
   8
   9 const bitWidth = 5;
  10 const length = 18;
  11 const habu = new ハブ(bitWidth, length);
  12 habu[1] = 0b11000n;
  13 habu[17] = 0b01001n;
  14
  15 habu.length; // 18
  16 habu.byteLength; // 12
  17 ```
  18
  19 ## Nomenclature
  20
  21 <i lang="ja">ハブ</i> is a Japanese word meaning “viper” or “hub”.
  22 <i lang="ja">ハブクラゲ</i> is the native name for
  23 [<i>Chironex yamaguchii</i>][C. yamaguchii], a toxic box jellyfish.
  24
  25 [C. yamaguchii]: <https://en.wikipedia.org/wiki/Chironex_yamaguchii>
  26
  27 ## License
  28
  29 Source files are licensed under the terms of the <cite>Mozilla Public
  30 License, version 2.0</cite>. For more information, see
  31 [LICENSE](./LICENSE).