Skip to content

Commit 364d8bc

Browse files
Merge pull request #243 from BjarkeHautop/remove-build-mentions
2 parents 49051ac + ccaa002 commit 364d8bc

3 files changed

Lines changed: 6 additions & 12 deletions

File tree

.github/copilot-instructions.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,9 @@ caugi/
8989
### Making Changes
9090

9191
1. **Minimal changes**: Make the smallest possible changes to accomplish the goal
92-
2. **Lazy building**: Remember that graph mutations are batched - test both before and after explicit `build()` calls
93-
3. **Edge registry**: Be careful when modifying the edge registry system
94-
4. **Backward compatibility**: Maintain API compatibility when possible
95-
5. **Update NEWS.md**: Add entries to `NEWS.md` for user-facing changes under the appropriate section:
92+
2. **Edge registry**: Be careful when modifying the edge registry system
93+
3. **Backward compatibility**: Maintain API compatibility when possible
94+
4. **Update NEWS.md**: Add entries to `NEWS.md` for user-facing changes under the appropriate section:
9695
- **New Features**: New functions, methods, or capabilities
9796
- **Improvements**: Enhancements to existing functionality, performance, or documentation
9897
- **Bug Fixes**: Corrections to existing behavior

README.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ We expect this feature to be needing further polishing in future releases, and w
112112

113113
`caugi` graphs are represented in a compact Compressed Sparse Row (CSR) format in Rust. `caugi` works with a front-loading philosophy. Since the `caugi` graph is stored in a CSR format, mutations of the graph is computationally expensive compared to other graph storage systems, _but_ it allows for very fast querying. Additionally to the storage format of the graph itself, `caugi` also stores additional information about node relations in such a way that it allows for faster queries without blowing up the object too much.
114114

115-
To accommodate for the cost of mutations, `caugi` graphs are built lazily. This means that when you mutate the graph, for example by adding edges to it, the graph edits are stored in R, but not in Rust. When you then need to query the graphs, the graph will rebuild itself in Rust, and the query will be executed on the newly built graph. You can also use the `build(cg)` function to force building the graph in Rust at any time.
115+
To accommodate for the cost of mutations, `caugi` graphs are built lazily, but you can force a build by using the function `build()`.
116116

117117
## Why?
118118
It's fast, _dawg_ 🐶 See the [vignette on performance](https://caugi.org/articles/performance.html) for benchmarks.

README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ register_caugi_edge(
100100
)
101101

102102
caugi(A %-->% B, B %<--% C, class = "DAG")
103-
#> <caugi object; 3 nodes, 2 edges; simple: TRUE; session=0x5679606fdb60>
103+
#> <caugi object; 3 nodes, 2 edges; simple: TRUE; session=0x000001a2318f5e90>
104104
#> graph_class: DAG
105105
#> nodes: A, B, C
106106
#> edges: A-->B, B<--C
@@ -136,12 +136,7 @@ relations in such a way that it allows for faster queries without
136136
blowing up the object too much.
137137

138138
To accommodate for the cost of mutations, `caugi` graphs are built
139-
lazily. This means that when you mutate the graph, for example by adding
140-
edges to it, the graph edits are stored in R, but not in Rust. When you
141-
then need to query the graphs, the graph will rebuild itself in Rust,
142-
and the query will be executed on the newly built graph. You can also
143-
use the `build(cg)` function to force building the graph in Rust at any
144-
time.
139+
lazily, but you can force a build by using the function `build()`.
145140

146141
## Why?
147142

0 commit comments

Comments
 (0)