Skip to content

Commit b25949f

Browse files
committed
add an overview of the directory structure to the README
1 parent 8cc2990 commit b25949f

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ cd cpp_algorithm && mkdir out && cd out && cmake .. && cd ..
2020
cmake --build out/ && ./out/unit_tests && ./out/main
2121
```
2222

23+
## Directory structure
24+
- `src/simple/ ` contains the implementations of the algorithms as functions, they are simple and can be used on their own
25+
- `src/pipeline/` contains function objects which serve as pipeline adapters for each of the algorithms and allow creating bash-style pipelines with the `|` operator
26+
- `src/meta/ ` contains several meta functions, including the implementation of the `|` operator itself
27+
2328
# Algorithms
2429

2530
These algorithm implementations are designed for ease-of-use, but are hard-coded to std::vector and do copy-by-value, which makes them slow.
@@ -64,13 +69,13 @@ It does allow playing around with the algorithms early on, and are a first step
6469
## Arithmetic and boolean functions
6570

6671
### Unary functions
67-
- logical_not
72+
- not (logical)
6873
- identity
6974
- negate
7075

7176
### Binary functions
72-
- logical_and
73-
- logical_or
77+
- and (logical)
78+
- or (logical)
7479
- plus
7580
- minus
7681
- multiply

0 commit comments

Comments
 (0)