Skip to content

Commit 38a3ce7

Browse files
committed
Docs: Refresh headlines
1 parent e4e38b8 commit 38a3ce7

File tree

8 files changed

+9
-7
lines changed

8 files changed

+9
-7
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
build/
3636
build_debug/
3737
build_release/
38+
Testing/
3839

3940
# Rust build artifacts
4041
Cargo.lock

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.14)
33
project(
44
fork_union
55
VERSION 2.1.1
6-
DESCRIPTION "OpenMP-style cross-platform fine-grained parallelism library"
6+
DESCRIPTION "Low-latency OpenMP-style NUMA-aware cross-platform fine-grained parallelism library"
77
LANGUAGES CXX
88
)
99

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "fork_union"
3-
description = "OpenMP-style cross-platform fine-grained parallelism library"
3+
description = "Low-latency OpenMP-style NUMA-aware cross-platform fine-grained parallelism library"
44
version = "2.1.1"
55
edition = "2021"
66
authors = ["Ash Vardanian"]

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ search_result_t search(std::span<float, dimensions> query) {
293293
fu::spin_mutex_t result_update; // ? Lighter `std::mutex` alternative w/out system calls
294294
295295
auto concurrent_searcher = [&](auto first_prong, std::size_t count) noexcept {
296-
auto [index, _, colocation] = first_prong;
296+
auto [first_index, _, colocation] = first_prong;
297297
auto& vectors = colocation == 0 ? first_half : second_half;
298298
search_result_t thread_local_result;
299299
for (std::size_t task_index = first_index; task_index < first_index + count; ++task_index) {
@@ -355,6 +355,7 @@ Works in tight loops.
355355
One of the most common parallel workloads is the N-body simulation ¹.
356356
Implementations are available in both C++ and Rust in `scripts/nbody.cpp` and `scripts/nbody.rs`, respectively.
357357
Both are lightweight and involve little logic outside of number-crunching, so both can be easily profiled with `time` and introspected with `perf` Linux tools.
358+
Additional NUMA-aware Search examples are available in `scripts/search.rs`.
358359

359360
---
360361

c/lib.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* @brief OpenMP-style NUMA-aware cross-platform fine-grained parallelism library.
2+
* @brief Low-latency OpenMP-style NUMA-aware cross-platform fine-grained parallelism library.
33
* @file lib.cpp
44
* @author Ash Vardanian
55
* @date June 27, 2025

include/fork_union.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* @brief OpenMP-style NUMA-aware cross-platform fine-grained parallelism library.
2+
* @brief Low-latency OpenMP-style NUMA-aware cross-platform fine-grained parallelism library.
33
* @file fork_union.h
44
* @author Ash Vardanian
55
* @date June 17, 2025

include/fork_union.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* @brief OpenMP-style NUMA-aware cross-platform fine-grained parallelism library.
2+
* @brief Low-latency OpenMP-style NUMA-aware cross-platform fine-grained parallelism library.
33
* @file fork_union.hpp
44
* @author Ash Vardanian
55
* @date May 2, 2025

rust/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Low-latency OpenMP-style NUMA-aware thread pool for fork-join parallelism.
1+
//! Low-latency OpenMP-style NUMA-aware cross-platform fine-grained parallelism library.
22
//!
33
//! Fork Union provides a minimalistic cross-platform thread-pool implementation and Parallel Algorithms,
44
//! avoiding dynamic memory allocations, exceptions, system calls, and heavy Compare-And-Swap instructions.

0 commit comments

Comments
 (0)