Publish a scannable manual and a bibliography that links each paper back to the pages that use it.
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
parent
cf8054a0b3
commit
695f8e84f7
45 changed files with 4848 additions and 338 deletions
175
doc/libdpf.md
175
doc/libdpf.md
|
|
@ -1,31 +1,35 @@
|
|||
\mainpage notitle
|
||||
<a id="mainpage"/>
|
||||
|
||||
[TOC]
|
||||
|
||||
|
||||
|
||||
%LIBDPF_INCLUDE_GETTING_STARTED_INTRODUCTION%
|
||||
|
||||
- - -
|
||||
<div style="float:left; color:#999;">← Prev</div>
|
||||
<div style="float:right;">[Next →](@ref basics)</div>
|
||||
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
||||
|
||||
|
||||
\page basics DPF Basics
|
||||
|
||||
[TOC]
|
||||
\page basics First program
|
||||
|
||||
%LIBDPF_INCLUDE_GETTING_DPF_BASICS%
|
||||
|
||||
- - -
|
||||
<div style="float:left; color:#999;">[← Prev](mainpage)</div>
|
||||
<div style="float:right;">[Next →](@ref getting_started)</div>
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
||||
|
||||
|
||||
\page getting_started Manual
|
||||
|
||||
The domain, the payload, and the walk.
|
||||
Shorter domains make shorter keys.
|
||||
|
||||
- [Domains](@ref input_types) — the secret index
|
||||
- [Payloads](@ref output_types) — the group at that index
|
||||
- [Evaluation](@ref evaluation) — point, interval, full domain, sequence
|
||||
- [Iterables](@ref iterables) — walk the shares a multi-point eval wrote
|
||||
|
||||
Samples for each of those are under [Code examples](@ref listings).
|
||||
|
||||
|
||||
|
||||
|
|
@ -33,69 +37,30 @@
|
|||
|
||||
|
||||
|
||||
\page getting_started Getting Started
|
||||
|
||||
[TOC]
|
||||
|
||||
The getting started guide consists of the following subsections.
|
||||
|
||||
- \subpage input_types
|
||||
- \subpage output_types
|
||||
- \subpage evaluation
|
||||
- \subpage iterables
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref mainpage)</div>
|
||||
<div style="float:right;">[Next →](@ref input_types)</div>
|
||||
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
||||
|
||||
|
||||
\page input_types Input Types
|
||||
|
||||
[TOC]
|
||||
\page input_types Domains
|
||||
|
||||
%LIBDPF_INCLUDE_GETTING_STARTED_INPUT_TYPES%
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref getting_started)</div>
|
||||
<div style="float:right;">[Next →](@ref output_types)</div>
|
||||
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
||||
|
||||
|
||||
\page output_types Output Types
|
||||
|
||||
[TOC]
|
||||
\page output_types Payloads
|
||||
|
||||
%LIBDPF_INCLUDE_GETTING_STARTED_OUTPUT_TYPES%
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref input_types)</div>
|
||||
<div style="float:right;">[Next →](@ref evaluation)</div>
|
||||
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
||||
|
||||
|
||||
\page evaluation Evaluating DPFs
|
||||
|
||||
[TOC]
|
||||
\page evaluation Evaluation
|
||||
|
||||
%LIBDPF_INCLUDE_GETTING_STARTED_EVALUATION%
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref output_types)</div>
|
||||
<div style="float:right;">[Next →](@ref iterables)</div>
|
||||
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
|
@ -104,58 +69,8 @@ The getting started guide consists of the following subsections.
|
|||
|
||||
\page iterables Iterables
|
||||
|
||||
[TOC]
|
||||
|
||||
%LIBDPF_INCLUDE_GETTING_STARTED_ITERABLES%
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref evaluation)</div>
|
||||
<div style="float:right;">[Next →](@ref pir)</div>
|
||||
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
||||
\page pir PIR
|
||||
|
||||
[TOC]
|
||||
|
||||
The getting started guide consists of the following subsections.
|
||||
|
||||
- \subpage pir1
|
||||
- \subpage pir2
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref iterable)</div>
|
||||
<div style="float:right;">[Next →](@ref pir1)</div>
|
||||
|
||||
\page pir1 PIR1
|
||||
|
||||
[TOC]
|
||||
|
||||
%LIBDPF_INCLUDE_PIR_PIR1%
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref evaluation)</div>
|
||||
<div style="float:right;">[Next →](@ref miscellany)</div>
|
||||
|
||||
\page miscellany Miscellany
|
||||
|
||||
[TOC]
|
||||
|
||||
The miscellany page consists of the following subpages.
|
||||
|
||||
- \subpage bugs
|
||||
- \subpage changes
|
||||
- \subpage todo
|
||||
- \subpage submodules
|
||||
- \subpage authors
|
||||
- \subpage license
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref pir)</div>
|
||||
<div style="float:right;">[Next →](@ref bugs)</div>
|
||||
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
|
@ -164,46 +79,28 @@ The miscellany page consists of the following subpages.
|
|||
|
||||
\page bugs Bugs
|
||||
|
||||
[TOC]
|
||||
|
||||
%LIBDPF_INCLUDE_MISC_BUGS%
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref miscellany)</div>
|
||||
<div style="float:right;">[Next →](@ref changes)</div>
|
||||
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
||||
|
||||
|
||||
\page changes CHANGELOG
|
||||
|
||||
[TOC]
|
||||
\page changes Changelog
|
||||
|
||||
%LIBDPF_INCLUDE_MISC_CHANGES%
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref bugs)</div>
|
||||
<div style="float:right;">[Next →](@ref todo)</div>
|
||||
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
||||
|
||||
|
||||
\page todo TODO list
|
||||
|
||||
[TOC]
|
||||
\page todo TODO
|
||||
|
||||
%LIBDPF_INCLUDE_MISC_TODO%
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref changes)</div>
|
||||
<div style="float:right;">[Next →](@ref submodules)</div>
|
||||
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
|
@ -212,14 +109,8 @@ The miscellany page consists of the following subpages.
|
|||
|
||||
\page submodules Submodules
|
||||
|
||||
[TOC]
|
||||
|
||||
%LIBDPF_INCLUDE_MISC_SUBMODULES%
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref todo)</div>
|
||||
<div style="float:right;">[Next →](@ref authors)</div>
|
||||
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
|
@ -228,14 +119,8 @@ The miscellany page consists of the following subpages.
|
|||
|
||||
\page authors Authors
|
||||
|
||||
[TOC]
|
||||
|
||||
%LIBDPF_INCLUDE_MISC_AUTHORS%
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref submodules)</div>
|
||||
<div style="float:right;">[Next →](@ref license)</div>
|
||||
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
|
@ -244,26 +129,14 @@ The miscellany page consists of the following subpages.
|
|||
|
||||
\page license License
|
||||
|
||||
[TOC]
|
||||
|
||||
%LIBDPF_INCLUDE_MISC_LICENSE%
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref authors)</div>
|
||||
<div style="float:right;">[Next →](@ref listings)</a></div>
|
||||
|
||||
|
||||
|
||||
<!-- PAGE SEPARATOR -->
|
||||
|
||||
|
||||
|
||||
\page listings Code Listings
|
||||
|
||||
[TOC]
|
||||
\page listings Code examples
|
||||
|
||||
%LIBDPF_INCLUDE_CODE_LISTINGS%
|
||||
|
||||
- - -
|
||||
<div style="float:left;">[← Prev](@ref license)</div>
|
||||
<div style="float:right; color:#999;">Next →</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue