A fast and efficient, open-source C++ graph library built to handle a wide range of graph types. It provides a flexible, templated API for graph manipulation, analysis, and visualization.
- 🚀 Key Features
- 🗓️ Development Notice
- 📂 Project Structure
- ⚙️ Getting Started
- 🛠️ Technology Stack
- ❓ Why CinderPeak?
- 🧑💻 Community & Contributions
- 📄 License
- Flexible Graph Representations - Supports adjacency lists, adjacency matrices, and hybrid CSR/COO formats for efficient storage.
- Customizable & Templated - Fully templated design allows you to define custom vertex and edge types.
- Integrated Visualization - An integrated SFML-based engine for real-time graph rendering, making it easy to visualize your data.
- Thread Safety - Designed to work seamlessly in multi-threaded applications.
- High Performance - Leverages modern C++ features like smart pointers and STL containers for optimized execution.
- Comprehensive Testing - Built with Google Test (GTest) to ensure reliability and robustness.
- Extensive Documentation - Detailed usage guides, examples, and API references are hosted with Docusaurus.
#include <iostream>
#include "CinderPeak.hpp"
using namespace CinderPeak::PeakStore;
using namespace CinderPeak;
// Custom vertex & edge
class CustomVertex : public CinderVertex {
public:
int data;
CustomVertex(int d = 0) : data(d) {}
};
class CustomEdge : public CinderEdge {
public:
int weight;
CustomEdge(int w = 0) : weight(w) {}
};
int main() {
GraphCreationOptions opts({
GraphCreationOptions::Undirected,
GraphCreationOptions::Weighted
});
// --- Custom Types ---
GraphMatrix<CustomVertex, CustomEdge> customGraph(opts);
CustomVertex A(1), B(2);
customGraph.addVertex(A);
customGraph.addVertex(B);
customGraph[A][B] = CustomEdge(1290);
std::cout << "CustomGraph Edge Weight: "
<< customGraph.getEdge(A, B).weight << "\n";
// --- Primitive Types ---
GraphMatrix<int, int> intGraph(opts);
intGraph.addVertex(1);
intGraph.addVertex(2);
intGraph.addEdge(1, 2, 10);
std::cout << "IntGraph Edge Weight: " << intGraph[1][2] << "\n";
return 0;
}CinderPeak is currently under active development. We are committed to delivering a polished and comprehensive release. The stable version, with refined functionalities and complete documentation, is scheduled to be available soon.
/CinderPeak
├── CMakeLists.txt # Build system configuration
├── docs # Docusaurus documentation
│ ├── examples
│ │ └── GraphMatrixExample.md # Example usage for GraphMatrix
│ ├── GraphList.md # Adjacency List documentation
│ ├── GraphMatrix.md # Adjacency Matrix documentation
│ ├── index.md # Main documentation page
│ ├── installation.md # Installation guide
│ └── usage.md # Usage guide
├── examples # Sample code demonstrating usage
│ ├── CMakeLists.txt # Build config for examples
│ ├── extras
│ │ ├── COOExample.cpp # Coordinate List example
│ │ ├── CSRExample.cpp # Compressed Sparse Row example
│ │ ├── LogExample.cpp # Logging utility example
│ │ └── PeakExample.cpp # General CinderPeak usage example
│ ├── ListExample1.cpp # Adjacency List example
│ ├── MatrixExample.cpp # Adjacency Matrix example
│ └── PrimitiveGraph.cpp # Basic graph example
├── src # Source files
│ ├── ArialFontDataEmbed.hpp # Embedded font data for visualization
│ ├── CinderExceptions.hpp # Custom exception handling
│ ├── CinderPeak.hpp # Main API entry point
│ ├── GraphList.hpp # Adjacency List implementation
│ ├── GraphMatrix.hpp # Adjacency Matrix implementation
│ ├── PeakLogger.hpp # Logging utility
│ ├── PeakStore.hpp # Core storage engine
│ ├── StorageEngine
│ │ ├── AdjacencyList.hpp # Adjacency List storage
│ │ ├── CoordinateList.hpp # Coordinate List storage
│ │ ├── ErrorCodes.hpp # Error handling codes
│ │ ├── GraphContext.hpp # Graph context management
│ │ ├── HybridCSR_COO.hpp # Hybrid CSR/COO storage
│ │ └── Utils.hpp # Utility functions
│ ├── StorageInterface.hpp # Storage interface definition
│ └── Visualizer.hpp # SFML-based visualization engine
├── tests # Unit tests
│ ├── AdjacencyShard.cpp # Tests for adjacency list
│ ├── CoordinateShard.cpp # Tests for coordinate list
│ ├── HybridShard.cpp # Tests for hybrid CSR/COO
│ └── tests.cpp # Main test suite
├── README.md # Project overview and setup
└── LICENSE # License file
- Installation: Follow the installation guide to set up CinderPeak with CMake.
- Usage: Check the usage guide for API details and the examples directory for sample code.
- Documentation: Explore the full documentation hosted with Docusaurus in the docs directory.
- C++17/C++20: Leverages modern C++ features for performance and flexibility.
- SFML: Powers the integrated visualization engine.
- Google Test: Provides the framework for robust unit testing.
- Docusaurus: Hosts comprehensive documentation with examples and API references.
- CMake: Used for the cross-platform build system.
CinderPeak strikes a balance between performance, flexibility, and ease of use. Whether you're building complex network models, analyzing graph-based data, or visualizing relationships, CinderPeak provides a robust and intuitive solution. Its open-source nature encourages community contributions, and its modular design makes it easy to extend for specialized use cases.
We welcome contributions! See the CONTRIBUTING.md file for guidelines on how to get involved. Join the CinderPeak community on GitHub to report issues, suggest features, or contribute code.
This project is licensed under the MIT License.
