API Reference

This section provides detailed API documentation for all AnalysisG components, automatically generated from the C++ source code using Doxygen and Breathe.

API Documentation:

• Core Module
  • Template Classes
  • Utility Classes
  • Classes and Functions
• Events Module
  • Event Implementations
  • Usage Pattern
• Graphs Module
  • Graph Implementations
  • Graph Structure
  • Common Features
  • Usage Example
• Metrics Module
  • Metric Implementations
  • Metric Interface
  • Usage Example
• Models Module
  • Model Implementations
  • Model Interface
  • Usage Example
  • Custom Models
• Infrastructure Modules
  • Module Components
  • Design Principles
• Python-C++ Interface
  • Interface Components
  • Usage Examples
  • Design Philosophy
  • Cython Implementation
  • Adding New Bindings
• Templates Module
  • Template Types
  • Using Templates
  • Template Structure
  • Best Practices
  • Example Customizations
  • Deprecated Documentation

Overview

The AnalysisG API is organized into several main modules:

• Core Module - Core functionality and base templates

• Events Module - Event processing implementations

• Graphs Module - Graph construction from events

• Metrics Module - Performance metrics

• Models Module - Neural network models

• Infrastructure Modules - Infrastructure components

• Python-C++ Interface - Python-C++ interface

• Templates Module - Code templates

Namespaces and Classes

The framework uses a modular design with clear separation of concerns. Each module provides specific functionality and can be used independently or combined for complex analyses.

Documentation Format

The API documentation includes:

• Classes: Complete class documentation with all members

• Functions: Function signatures and descriptions

• Variables: Public and private member variables

• Types: Type definitions and enumerations

• Examples: Usage examples where applicable

Browsing the API

You can browse the API in several ways:

• Use the table of contents to navigate by module

• Use the search function to find specific classes or functions

• Follow cross-references to related components

• View source code directly from documentation pages

Conventions

The API follows these conventions:

• Classes: CamelCase (e.g., event_template)

• Functions: snake_case (e.g., build_event)

• Member variables: snake_case with trailing underscore for private (e.g., _hidden)

• Constants: UPPER_CASE