tetengo 1.8.1

Table of Contents

• Features
  • tetengo::json
  • tetengo::lattice
  • tetengo::property
  • tetengo::text
  • tetengo::trie
• How to Build and Install
  • With Visual C++ on Windows
    • Requirements
    • Downloading the prebuilt library files
    • Building from the source files cloned from the GitHub repository
    • Building setup
    • Generating documents
  • With Clang or GCC on Linux
    • Requirements
    • Getting the source files
      • Downloading the source files from www.tetengo.org
      • Cloning the source files from the GitHub repository
    • Building and installing
    • Generating documents

A multipurpose library set.

It provides both class-based libraries for C++ and function-based libraries for C.

Features

tetengo::json

A JSON parser library.

It is a pull-style parser based on RFC 8259, plus an extension for supporting UNIX shell style comments.

• Detail description

tetengo::lattice

A Viterbi search library.

The Viterbi search is a dynamic programming algorithm. It finds the most likely path in the lattice consisting of the observed event nodes.

This library also provides the A* search algorithm for the lattice created by the Viterbi search.

• Detail description

tetengo::property

An application setting library.

It enables to acquire and save the settings in a common, platform-independent way.

The storage of the settings is platform-specific: the Windows registry on Windows, home directory dot files on UNIX, etc.

• Detail description

tetengo::text

A text library.

The utility for text processing.

This library provides the following features:

• A string encoding converter.
• A grapheme splitter conforming to Unicode 14.0.0.
• Detail description

tetengo::trie

A trie library.

The trie is an associative data structure. Given a key, it returns the corresponding value in a constant time.

The trie is also able to perform a prefix search. It has a method to enumerate the values with the same prefix.

• Detail description

How to Build and Install

With Visual C++ on Windows

Requirements

• Visual Studio 2022
• Boost C++ libraries 1.82.0
• Doxygen 1.9.7
• Graphviz
• WiX toolset 3.11.2
• Python 3.9 or Python 3.10
• mypy
• Black
• isort

If you build the source cloned from the GitHub repository, the following is necessary in addition to the above tools.

• Git

Downloading the prebuilt library files

Download the .zip archive file for Windows from the website www.tetengo.org.

Execute setup.exe in the archive..

Building from the source files cloned from the GitHub repository

Clone the source files from GitHub:

> git clone --recurse-submodules https://github.com/tetengo/tetengo.git

Open the file tetengo.sln in the work tree.

Execute the menu command [Build]-[Build Solution] in Visual Studio.

Building setup

Open the file tetengo.setup.sln in the work tree, and execute the menu command [Build]-[Build Solution] in Visual Studio.

setup.exe and tetengo.msi will be created under the bin.setup folder in the work tree.

Generating documents

To generate the documents, open a command prompt, and execute the command doxygen in the top directory. Doxygen will output the documents into the directory doc.

> doxygen

With Clang or GCC on Linux

Requirements

• Clang 11, Clang 14, GCC 10 or GCC 12
• Boost C++ libraries 1.82.0
• Doxygen 1.9.7
• Graphviz
• include-what-you-use 0.15 or include-what-you-use 0.17
• Clang Format 11
• Dos2Unix
• Python 3.9 or Python 3.10
• mypy
• Black
• isort

If you build the source cloned from the GitHub repository, the followings are necessary in addition to the above tools.

• Git
• Autoconf and GNU Autoconf Archive
• Automake
• GNU Libtool

Getting the source files

Downloading the source files from www.tetengo.org

Download the .tar.bz2 archive file for Linux from the website www.tetengo.org.

Expand the archive into your preferred path.

 -session
$ tar -xf tetengo-X.Y.Z.tar.bz2

Cloning the source files from the GitHub repository

Clone the source files from GitHub:

 -session
$ git clone --recurse-submodules https://github.com/tetengo/tetengo.git

Run the script bootstrap.sh in the top directory to generate the script configure.

 -session
$ ./bootstrap.sh

Building and installing

Configure, build and install tetengo by the following commands:

 -session
$ ./configure
$ make
$ sudo make install

By default, tetengo will be installed in the directory /usr/local. To change the directory where to install tetengo, specify the option --prefix to the script configure.

Generating documents

To generate the documents, execute the command make doc in the top directory:

 -session
$ make doc

---

Copyright (C) 2019-2023 kaoru https://www.tetengo.org/

This product is released under the MIT license. See the COPYING file for details.