PnF: Point & Figure Chart Library

Overview

The PnF library builds Point & Figure charts by converting price movements into discrete boxes and columns. The design centers on a core C++ engine and a stable C ABI for language bindings.

Concepts (Quick)

• Box: A single X or O at a price level.
• Column: A vertical run of boxes in one direction.
• Reversal: A directional change after a configured number of boxes.
• Box Size: The price increment per box; can be Fixed, Traditional, Percentage, or Points.

Core Flow

flowchart TD
  A[Prices/OHLC] --> B[Chart.add_data]
  B --> C[Box size resolution]
  C --> D[Grid rounding]
  D --> E[Column append or reversal]
  E --> F[Trend line update]
  F --> G[Indicators]
  G --> H[Visualization/Export]

Loading

A professional-grade C++ library for Point & Figure (P&F) charting with multi-language bindings.

Docs:

• Documentation Home
• Getting Started
• Build and Test
• Architecture
• C++ API Reference
• API Symbol Index (Generated)
• Numeric Examples
• Guides: Common Workflows
• Guides: Troubleshooting
• Operations: Compatibility Matrix
• Operations: Release and Versioning
• Project Changelog
• Bindings (C ABI)
• Bindings (Python)
• Bindings (Java)
• Bindings (Rust)
• Bindings (C#)

At a Glance

graph TD
  A[App Code] --> B[Bindings]
  B --> C[C ABI]
  C --> D[C++ Core]
  D --> E[Indicators]
  D --> F[Visualization]
  D --> G[Trend Lines]

Loading

Deep Concepts

Box Size Resolution

flowchart TD
  A[price] --> B{Method}
  B -->|Fixed| C[box = config.box_size]
  B -->|Points| D[box = config.box_size]
  B -->|Percentage| E[box = price * pct / 100]
  B -->|Traditional| F[price-tier table]

Loading

Reversal Logic

flowchart TD
  A[Current Column] --> B{Type}
  B -->|X| C[price <= highest - reversal*box]
  B -->|O| D[price >= lowest + reversal*box]
  C --> E[Reversal to O]
  D --> F[Reversal to X]

Loading

Indicator Summary

• SMA: Average of column midpoints over a period
• Bollinger: SMA ± (std dev * multiplier)
• RSI: Gain/loss ratio mapped to 0–100
• OBV: Volume flow by close direction
• Signals: Buy/sell signals based on breakouts
• Patterns: Multiple P&F patterns detected per column
• S/R: Merge levels by relative threshold
• Objectives: Vertical count targets
• Congestion: Zones by relative range threshold
• Events: Incremental chart, column, signal, pattern, objective, S/R, and congestion events
• Backtesting: Event-driven signal/pattern strategy runner with trade logs and portfolio metrics

Features

• Multiple construction methods (Close, High/Low)
• Multiple box size strategies (Fixed, Traditional, Percentage, Points)
• Indicators: SMA, Bollinger, RSI, OBV, signals, patterns, S/R, objectives, congestion
• Event streaming: chart updates, column lifecycle, signals, patterns, objectives, levels, congestion
• Backtesting: fixed-size signal/pattern strategies, commissions, slippage, equity curve, drawdown, win rate, profit factor, exposure, Sharpe
• Exports: ASCII, JSON, CSV
• Bindings: Python, Java, Rust, C#

Documentation and Version Governance

• Canonical release version: root VERSION
• Release notes and change history: CHANGELOG.md
• Cross-binding version consistency check:
  • python3 tools/check_versions.py
• Generated exhaustive API symbol index:
  • python3 tools/generate_api_symbol_index.py
• API docs coverage validation:
  • python3 tools/check_docs_coverage.py

Build (C++ Core)

git clone --recursive https://github.com/gregorian-09/pnf-chart-system.git
cd pnf-chart-system
cmake -S . -B build-linux -DCMAKE_BUILD_TYPE=Release -DPNF_BUILD_VIEWER=OFF
cmake --build build-linux -j$(nproc)
ctest --test-dir build-linux --output-on-failure

Quick Usage (C++)

#include <pnf/pnf.hpp>
#include <chrono>
#include <iostream>

int main() {
    pnf::ChartConfig config;
    config.method = pnf::ConstructionMethod::Close;
    config.box_size_method = pnf::BoxSizeMethod::Fixed;
    config.box_size = 1.0;
    config.reversal = 3;

    pnf::Chart chart(config);
    auto now = std::chrono::system_clock::now();
    chart.add_data(100.0, now);
    chart.add_data(101.0, now + std::chrono::hours(1));

    std::cout << pnf::Visualization::to_ascii(chart) << "\n";
    return 0;
}

Binding Tests (All)

# Python
PYTHONPATH=build-linux/python python3 -m pytest bindings/python/test_pypnf.py

# Java
cd bindings/java
mvn test -Dmaven.repo.local=/tmp/m2 -Dnative.library.path=$(pwd)/../../build-linux/lib
cd -

# Rust
cd bindings/rust
cargo test --release
cd -

# C# (.NET 8 LTS)
cd bindings/csharp
DOTNET_CLI_HOME=/tmp/dotnet DOTNET_SKIP_FIRST_TIME_EXPERIENCE=1 dotnet test -c Release
cd -

License

MIT (see LICENSE).