Welcome to libmyrtx’s documentation!

libmyrtx is a C99 library that provides useful functions and data structures for use in various C projects. The library focuses on memory allocators, strings, and other fundamental data structures.

Features

• Arena Allocator: A fast, region-based memory allocator

• Context System: Context management and error handling

• String Functions: Utility functions for string manipulation

• String Type: Dynamic string type for easier string handling

• Hash Table: High-performance hash table implementation

• AVL Tree: Self-balancing binary search tree

Contents:

• Getting Started with libmyrtx
  • Prerequisites
  • Building from Source
  • Using the Build Script
  • Integration into Your Project
  • Basic Usage Example
  • Next Steps
• User Guides
  • Arena Allocator Guide
  • Context System Guide
  • String Utility Guide
  • Hash Table Guide
  • AVL Tree Guide
• API Reference
  • Memory API
  • Collections API
  • Context API
  • String API
• Examples
  • Arena Allocator Example
  • AVL Tree Example
  • Context System Example
  • String Manipulation Example
  • Hash Table Example

Getting Started

Requirements

• C99-compliant compiler

• CMake 3.14 or higher

Installation

Using CMake:

git clone https://github.com/your-username/libmyrtx.git
cd libmyrtx
mkdir build && cd build
cmake ..
cmake --build .
cmake --install .

Using the build script:

./build.sh

Integration

To integrate libmyrtx into your CMake project:

add_subdirectory(path/to/libmyrtx)
target_link_libraries(YourProject PRIVATE myrtx)

Indices and tables

• Index

• Search Page