Stratax 0.2.0
Loading...
Searching...
No Matches
stratax.h

stratax.h

Version: v0.2.0

Status: Complete

Header: include/stratax.h


Overview

stratax.h is the umbrella include for the C++ API surface.

Including this header pulls in core metadata/types, containers, algorithms, operations, and I/O helpers so downstream code can use Stratax without manually including each component header.


Responsibilities

The umbrella header is responsible for:

  • Providing a single include entry point for Stratax C++ usage
  • Aggregating stable public core headers
  • Re-exporting common public types and algorithms under stratax
  • Simplifying consumer include management

The umbrella header is not responsible for:

  • Implementing component APIs directly
  • Runtime initialization behavior
  • Build or link configuration

Aggregated Components

Core Foundations

Containers

Algorithms

Ops

I/O


Usage

#include <stratax.h>
int main()
{
stratax::Vector<double> v{1.0, 2.0, 3.0};
auto t = stratax::to_tensor(v);
(void)t;
}

Common APIs are available directly under stratax. Grouped aliases are also available for module-style calls such as stratax::creation::zeros, stratax::conversions::to_tensor, and stratax::reductions::sum.


Design Notes

This header intentionally acts as a convenience aggregator. Component-level headers should still be preferred in translation units that need tighter include boundaries or reduced compile-time impact.


Future Improvements

  • Add policy guidance on when to prefer umbrella vs component includes
  • Keep include ordering aligned with logical module groupings as APIs expand

See Also

  • docs/dev/README.md
  • docs/dev/core/Concepts.md
  • docs/dev/core/containers/Vector.md