From b72e451410958508c4df0119fed1883e07116504 Mon Sep 17 00:00:00 2001 From: Thomas Jahns <jahns@dkrz.de> Date: Thu, 7 Nov 2024 23:34:40 +0100 Subject: [PATCH] doc: fix minor typos. --- doc/src/idxlists.dox | 8 ++++---- doc/src/rrobin.dox | 2 +- src/xt_config.c | 5 +++-- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/doc/src/idxlists.dox b/doc/src/idxlists.dox index 2e0fbf50..482776ea 100644 --- a/doc/src/idxlists.dox +++ b/doc/src/idxlists.dox @@ -7,7 +7,7 @@ \section idxlist_intro Introduction Index lists are just lists that contain a number of indices. Identical indices can - occur multiple times in an index list. They have no notion 2D or 3D decompostions. + occur multiple times in an index list. They have no notion of 2D or 3D decompostions. However, you are still able to describe any type of decompostion using such an index list. The most general index list type is the index vector. The yaxt library @@ -24,8 +24,8 @@ The index vector takes an array of indices as input and generates an index list from that. It is most efficient for random decompostions. Since it stores a copy of the - input array within the index list, it is not recommand to be used for index list that - can be described more compact with other index list types. + input array within the index list, it is not recommended to be used for index lists that + can be described more succinctly with other index list types. \image html decomp_idxvec.png "index vector decomposition example" @@ -51,7 +51,7 @@ \until ; A very common decomposition is the partioning into n-dimensional blocks. For this - decomposition type the index section is recommanded. Some advanced features of index + decomposition type the index section is recommended. Some advanced features of index sections are described in \ref idxsection_docu. \image html decomp_idxsection.png "index section decomposition example" diff --git a/doc/src/rrobin.dox b/doc/src/rrobin.dox index 0e5d7d6e..88fd3b60 100644 --- a/doc/src/rrobin.dox +++ b/doc/src/rrobin.dox @@ -46,7 +46,7 @@ There are many ways to define, which elements are locally available (source) and which are required (destination). We could define them with an array of indices using an index vector (\ref xt_idxvec.h), or we could define a block of elements we want to have using - index stripes (\ref xt_idxstripes.h). Using stripes we have to name the local start index, + index stripes (\ref idxstripe). Using stripes we have to name the local start index, how many elements we want to have, an the stride between the elements. Here we need for the source an index stripe containing 5 elements with a stride of 1, beginnig at 0 for rank 0, at 1*len for rank 1 etc. diff --git a/src/xt_config.c b/src/xt_config.c index b05b45ec..9ca4a925 100644 --- a/src/xt_config.c +++ b/src/xt_config.c @@ -457,8 +457,9 @@ xt_config_get_xmap_stripe_align(Xt_config config) * to stripes * * When constructing an Xmap via \ref xt_xmap_dist_dir_new or - * \ref xt_xmap_all2all_new, index lists passed in as \ref xt_idxvec will be - * automatically converted to \ref xt_idxstripes if the size is above a + * \ref xt_xmap_all2all_new, index lists passed in as \ref idxvec + * "index vector" will be automatically converted to + * \ref idxstripe "index stripes" if the size is above a * limit which defaults to 128 indices. * * The XT_CONFIG_DEFAULT_IDXVEC_AUTOCONVERT_SIZE environment variable -- GitLab