Godot Stat Math Documentation

Godot Stat Math is a comprehensive Godot 4 addon providing statistical functions for game developers, exposed via the global StatMath autoload singleton. It offers distributions, statistical analysis, special functions, and advanced sampling methods designed for practical game development use.

🚀 Quick Start

The StatMath singleton provides access to all functionality through organized modules:

# Generate random numbers from distributions
var normal_val = StatMath.Distributions.randf_normal(0.0, 1.0)
var poisson_val = StatMath.Distributions.randi_poisson(3.5)

# Calculate statistics
var data = [95.5, 87.2, 92.1, 88.8, 90.0]
var avg = StatMath.BasicStats.mean(data)
var std_dev = StatMath.BasicStats.standard_deviation(data)

# Use distribution functions
var cdf_value = StatMath.CdfFunctions.normal_cdf(1.96, 0.0, 1.0)
var quantile = StatMath.PpfFunctions.normal_ppf(0.975, 0.0, 1.0)

📚 Table of Contents

Getting Started

• Installation
  • Prerequisites
  • Installation Methods
  • Verification
  • Configuration
  • Troubleshooting
• Quick Start Guide
  • Basic Usage
  • Core Modules Overview
  • Common Use Cases
  • Working with Distributions
  • Data Cleaning and Preprocessing
  • Reproducible Results
  • Next Steps

Core Modules

• StatMath
  • Usage
  • Constants
  • Functions
• StatMath.BasicStats
  • Usage
  • Functions
• StatMath.Distributions
  • Usage
  • Functions
• StatMath.CdfFunctions
  • Usage
  • Functions
• StatMath.PpfFunctions
  • Usage
  • Constants
  • Functions
• StatMath.PmfPdfFunctions
  • Usage
  • Functions
• StatMath.ErrorFunctions
  • Usage
  • Functions
• StatMath.HelperFunctions
  • Usage
  • Functions
• StatMath.SamplingGen
  • Usage
  • Constants
  • Functions

Tests

• Unit Testing
  • Test Coverage
  • Test Results Overview
  • Understanding Test Status
• Performance Testing
  • Test Methodology
  • Understanding the Results
• Testing Standards
  • Overview
  • 1. Standards & Philosophy
  • 2. Implementation & Organization
  • 3. Infrastructure & Process
  • 4. Performance Testing

Indices and Tables

• Index

• Search Page

Key Features

• 🎲 Random Number Generation: 20+ probability distributions (Normal, Poisson, Gamma, Beta, Weibull, etc.)

• 📊 Statistical Analysis: Mean, variance, quantiles, and robust statistics

• 🧮 Distribution Functions: CDF, PMF/PDF, and PPF (quantile) functions

• 🔬 Special Functions: Error functions, Gamma, Beta, incomplete functions

• 🎯 Advanced Sampling: Sobol, Halton, Latin Hypercube sampling

• 🎮 Game-Focused: Optimized for game development workflows

• 🔄 Reproducible: Comprehensive seeding system for deterministic results

Compatibility: Godot 4.0+