treeweave
Getting started
Installation
Python
C++
C
Julia
MATLAB
Octave
Fortran
JavaScript / TypeScript
CMake
Language guides
Python
Install
Minimal example
Decorator form
Evaluation routes
Multi-dimensional fits
Options
Further
Julia
Install
Minimal example
Evaluation routes
Multi-dimensional fits
Options
Fit file
Further
MATLAB / Octave
Install (MATLAB)
Install (Octave)
Build from source
Minimal example
Evaluation routes
Multi-dimensional fits
Options
Further
C++
Install
Download headers, no CMake
CMake, FetchContent
CMake, CPM
1-D fit
Multi-dimensional fit
Options
Thread safety
Build from source
Lower-level: the guru interface
C
Install
Direct tarball
CMake package
Source build
Minimal example
Evaluation entry points
Handle and callbacks
Fit
Evaluate
By-value scalar eval
Introspection and teardown
Options
Multi-arch dispatch
Thread safety
Further
Fortran
Install
Prebuilt C ABI
Source build
Minimal example
Batch & sorted eval
Options
Fit file
Further
JavaScript / TypeScript
Install
Usage
Options
Source build
Reference
Fit options
Common fit options
Language-specific options
TolKind
CMake
Vendored C++
Targets
Profiles
Options
Installed package
Source build
Performance
Batch over scalar
The sorted fast path
The leaf-table fast path
Memory and degree
Multi-threading
Cross-language throughput and latency
Throughput, Mevals/s, higher is better
Latency, ns/eval, lower is better
Batch vs sorted batch
Runtime ISA dispatch
How the build chooses the family
Why no SVE on ARM
Forcing an ISA for testing
Guru interface (
treeweave::guru
)
When to use it
The helpers
Rules worth pinning
Comparison with native interpolators
The problem
The rules
Results
Why treeweave is faster
Where treeweave is not faster
Reproduce
How treeweave works
Phase 1, fit: adaptive paneling
Phase 2, eval: descent
Phase 3, leaf evaluation: tensor-product Horner
Phase 4, batched eval: counting sort by leaf
What costs what
TL;DR
Degree selection: C ABI vs C++ header API
Background and further reading
The math, briefly
Known issues
MATLAB/Octave single-point eval overhead
API reference
treeweave API Reference
Class Hierarchy
File Hierarchy
Full API
Functions
Template Function treeweave::fit
Template Function treeweave::guru::counting_sort
Template Function treeweave::guru::eval_leaf_aos
Template Function treeweave::guru::eval_leaf_soa
Function treeweave::guru::exclusive_scan
Template Function treeweave::guru::fill_out_of_domain(const F&, typename F::value_type *, std::size_t)
Template Function treeweave::guru::fill_out_of_domain(const F&, std::array<typename F::value_type *, F::output_dim>, std::size_t)
Template Function treeweave::guru::for_each_run
Template Function treeweave::guru::for_each_sorted_run
Template Function treeweave::guru::gather
Function treeweave::guru::histogram
Template Function treeweave::guru::scatter
Function treeweave::version_at_least
Function treeweave_active_arch
Function treeweave_arch_available
Function treeweave_batch
Function treeweave_default_opts
Function treeweave_dtype
Function treeweave_eval
Function treeweave_eval_1d
Function treeweave_eval_2d
Function treeweave_eval_3d
Function treeweave_fit
Function treeweave_free
Function treeweave_input_dim
Function treeweave_last_error
Function treeweave_memory_usage
Function treeweave_output_dim
Function treeweave_print_stats
Function treeweave_sorted
Function treeweave_transposed
Function treeweave_version
Function treeweave_version_string
Function treeweavef_batch
Function treeweavef_eval
Function treeweavef_eval_1d
Function treeweavef_eval_2d
Function treeweavef_eval_3d
Function treeweavef_fit
Function treeweavef_sorted
Function treeweavef_transposed
Directories
Directory include
Directory treeweave
Directory detail
Files
File guru.hpp
File tol_kind.hpp
File treeweave.h
File treeweave.hpp
treeweave
Namespace treeweave::guru::gdetail
Edit on GitHub
Namespace treeweave::guru::gdetail