Skip to content

Fix typos in README #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
foxtran merged 2 commits into from
Jul 7, 2025
Merged

Fix typos in README #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e153d3
Fix typo
foxtran Jul 7, 2025
a758905
MPI_COMM_WORLD -> mpi_comm in C++ API description
foxtran Jul 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ Initialization can be done in the following manner, for example (`StaticLoadBala
```cpp
#include <SLB4MPI.h>
...
StaticLoadBalancer slb(MPI_COMM_WORLD, 1, 100, 2, 4);
StaticLoadBalancer slb(mpi_comm, 1, 100, 2, 4);
```
That will initialize load balancer `slb` with range from lower bound (`1`) to upper bound (`100`) and with min (`2`) and max (`4`) chunk sizes which are optional which will work on communicator `comm`.
That will initialize load balancer `slb` with range from lower bound (`1`) to upper bound (`100`) and with min (`2`) and max (`4`) chunk sizes which are optional which will work on communicator `mpi_comm`.
Simpler initialization is also possible with default min and max chuck sizes:
```cpp
StaticLoadBalancer slb(MPI_COMM_WORLD, 1, 100);
StaticLoadBalancer slb(mpi_comm, 1, 100);
```
This is a barrier for the whole communicator.

Expand All @@ -39,7 +39,7 @@ Internally, it uses RAII, so it most of cases you do not think about destructing
For `Runtime` load balancer, a proper load balancer must be specified via first argument during initialization:
```cpp
std::string rlbtype = std::string("dynamic");
RuntimeLoadBalancer rlb(rlbtype, MPI_COMM_WORLD, 1, 100, 2, 4);
RuntimeLoadBalancer rlb(rlbtype, mpi_comm, 1, 100, 2, 4);
```
See possible values in the next section.

Expand Down Expand Up @@ -206,7 +206,7 @@ Useful flags that changes behaviour of library:
- `SLB4MPI_ENABLE_Fortran` enables/disables MPI load balancers for Fortran language (requires Fortran 2003)
- `SLB4MPI_WITH_MPI` enables/disables support of MPI for MPI/non-MPI builds

See example for [Fortran](examples/Fortran/CMakeLists.txt) and [C++](examples/CXX/CMakeLists.txt).
See examples for [Fortran](examples/Fortran/CMakeLists.txt) and [C++](examples/CXX/CMakeLists.txt).


**NOTE:** The library does not provide ILP64 support.
Expand Down