From bc7b06bcb58bb8907e364ff536fc5d951156881c Mon Sep 17 00:00:00 2001 From: Shunsuke Kanda Date: Fri, 2 Jul 2021 15:00:59 +0900 Subject: [PATCH] minor --- README.md | 16 +++++++++++----- include/xcdat.hpp | 2 +- include/xcdat/trie.hpp | 2 +- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 80b24a5..53bf0e4 100644 --- a/README.md +++ b/README.md @@ -282,12 +282,18 @@ Enumerate() = { ## API -`xcdat.hpp` provides +Xcdat can be used by including `xcdat.hpp`. -- `xcdat::trie_7_type`: -- `xcdat::trie_8_type`: +### Trie dictionary types -### Dictionary class +The two dictionary types are difined. + +- `xcdat::trie_8_type` is the trie dictionary using standard DACs using 8-bit integers for elements. +- `xcdat::trie_7_type` is the trie dictionary using pointer-based DACs using 7-bit integers for elements. + +### Trie dictionary class + +The trie dictionary has the following members. ```c++ //! A compressed string dictionary based on an improved double-array trie. @@ -350,7 +356,7 @@ class trie { //! Get the number of unused DA units. std::uint64_t num_free_units() const; - //! Get the number of unused DA units. + //! Get the length of TAIL vector. std::uint64_t tail_length() const; //! Lookup the ID of the keyword. diff --git a/include/xcdat.hpp b/include/xcdat.hpp index 7208997..dc0f389 100644 --- a/include/xcdat.hpp +++ b/include/xcdat.hpp @@ -10,8 +10,8 @@ namespace xcdat { -using trie_7_type = trie; using trie_8_type = trie; +using trie_7_type = trie; //! Set the continuous memory block to a new trie instance. template diff --git a/include/xcdat/trie.hpp b/include/xcdat/trie.hpp index dd769c0..c207c99 100644 --- a/include/xcdat/trie.hpp +++ b/include/xcdat/trie.hpp @@ -97,7 +97,7 @@ class trie { return m_bcvec.num_free_units(); } - //! Get the number of unused DA units. + //! Get the length of TAIL vector. inline std::uint64_t tail_length() const { return m_tvec.size(); }