Skip to content

Commit e1fb268

Browse files
committed
Add a stub for incremental algorithms
1 parent 7116ce8 commit e1fb268

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

_toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ parts:
1212
chapters:
1313
- file: analysing_tree_sequences
1414
- file: analysing_trees
15+
- file: incremental_algorithms
1516
- file: counting_topologies
1617
- file: parallelization
1718
- caption: Further tskit tutorials

incremental_algorithms.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
jupytext:
3+
text_representation:
4+
extension: .md
5+
format_name: myst
6+
format_version: 0.12
7+
jupytext_version: 1.9.1
8+
kernelspec:
9+
display_name: Python 3
10+
language: python
11+
name: python3
12+
---
13+
14+
```{currentmodule} tskit
15+
```
16+
17+
(sec_incremental)=
18+
# _Incremental algorithms_
19+
20+
Much of the [efficiency](sec_what_is_analysis)
21+
of the tskit approach comes from the use of incremental algorithms.
22+
By considering only the difference between adjacent trees,
23+
incremental algorithms avoid having to perform the same
24+
calculation multiple times on different trees.
25+
26+
This tutorial will explain the philosophy behind incremental algorithms,
27+
and provide examples of how to create your own (e.g. using the
28+
{meth}`TreeSequence.edge_diffs` method).
29+
30+
:::{todo}
31+
Create content. See [issue 233](https://github.com/tskit-dev/tutorials/issues/233)
32+
:::

0 commit comments

Comments
 (0)