Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1.48 KB

File metadata and controls

43 lines (29 loc) · 1.48 KB

🌋 CinderPeak Documentation

Welcome to the official documentation for CinderPeak, a high-performance, modular C++ graph library designed for modern systems and real-world applications.

CinderPeak is built for speed, scalability, and ease of use, supporting multiple graph storage backends such as adjacency lists and matrices. Whether you're working with sparse data, dynamic updates, or dense graphs, CinderPeak works efficiently to your needs.


📖 Contents

  • 📦 Installation Guide
    Step-by-step instructions to build and install CinderPeak on your system.
  • 🍎 CinderGraph
    List Based Graph Implementation
  • ⚙️ Usage Guide
    Learn how to create, modify, and query graphs using CinderPeak's API.

✨ Features

  • 🚀 High-performance in-memory graph processing
  • 🧩 Modular storage engine (Adjacency List, Matrix, CSR, etc.)
  • 🔄 Dynamic switching based on graph density
  • 🧵 Thread-safe with std::shared_mutex and std::atomic
  • 🔍 Easy-to-integrate API with extensive unit tests
  • Verbose Extensive console and file based logging.
  • Complete Exception and error handling

🙌 Contributing

Want to contribute or report an issue? Visit the main GitLab repository and check out the contribution guidelines. Feedback and PRs are always welcome!


📬 Contact

Maintained by PBL Team DAA-IV-T060
For questions, reach out via issues.

Happy graphing! 🧠📊