Skip to content

Commit

Permalink
Fix error in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
irukoa committed Apr 15, 2024
1 parent 832c9e8 commit c650492
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Upper bounds handle. <br /> Usage: <br /> `ub = a%ubounds()`| Returns the upper
Layout handle. <br /> Usage: <br /> `lyt = a%layout()`| Returns the layout of the represented array.| `class(container_specifier), intent(in) :: a`: initialized array handle. <br /> `integer, intent(out) :: lyt`: layout of the represented array. `lyt = 0` means `"F"` layout and `lyt = 1`, `"C"` layout.
Specifier initialization checker. <br /> Usage: <br /> `init = a%spec_init()`| Defines whether the container specifier is initialized.| `class(container_specifier), intent(in) :: a`: array handle. <br /> `logical, intent(out) :: init`: initialization status of the specifier.
Indexing functions. <br /> Usage: <br /> `[arr], {mem} = a%ind([mem], {arr})` | Shifts between memory layout representation and array layout representation. | `class(container_specifier), intent(in) :: a`: initialized array handle. <br /> Given `mem`: <br /> `integer, intent(in) :: mem`: integer referencing a memory layout address. Must be in the range `mem`$\in[1,$ `a%size()`$]$. <br /> `integer, intent(out) :: arr(:)`: 1D integer array referencing the corresponding array layout address. The number of components is equal to the rank of the represented array. Each component `arr(i)` is in the range `arr(i)`$\in[$ `lb(i)` $,$ `lb(i) + spc(i) - 1`$]$. Where `lb(i)` and `spc(i)` are the lower bounds and number of elements for dimension `i` of the represented array, respectively. <br /> Given `arr(:)`: <br /> `integer, intent(in) :: arr(:)`: 1D integer array referencing an array layout address. Each component `arr(i)` must be the range `arr(i)`$\in[$ `lb(i)` $,$ `lb(i) + spc(i) - 1`$]$. <br /> `integer, intent(out) :: mem`: integer array referencing the corresponding memory layout address. Will be in the range `mem`$\in[1,$ `a%size()`$]$.
Partial permutation utility. <br /> Usage: <br /> `call a%partial_permutation(dims, dictionary)` | Defines a dictionary containing the partial permutations of a set of dimensions { `spc(i)` } given by their set of labels `dims =` { $i$ }. The dictionary is a 2-dimensional array containing the particular partial permutation label and the corresponding array layout reference. The array dimensions `spc(j)` that have not been permuted are fixed to `lbs(j)`.| `class(container_specifier), intent(in) :: a`: initialized array handle. <br /> `integer, intent(in) :: dims(:)`: 1D array with `size(dims)` $\in [1,$ `size(spc)` $]$ containing the labels of the dimensions to permute on. <br /> `integer, allocatable, intent(out) :: dictionary(:, :)`: 2D array with the first index labelling the permutation label and the second the array layout component value of the permutation. Thus, `dictionary(i, :)` is an array layout reference of `a` which references the $i$-th partial permutation of dimensions `dims`. In the case of `a` having `"F"` layout, the permutation labels contiguous in the dictionary are those which permute the dimension label given in `dims(1)` first. In the case of `"C"` layout, the dimension label given in `dims(size(dims))` is permuted first.
Partial permutation utility. <br /> Usage: <br /> `dictionary = a%partial_permutation(dims)` | Defines a dictionary containing the partial permutations of a set of dimensions { `spc(i)` } given by their set of labels `dims =` { $i$ }. The dictionary is a 2-dimensional array containing the particular partial permutation label and the corresponding array layout reference. The array dimensions `spc(j)` that have not been permuted are fixed to `lbs(j)`.| `class(container_specifier), intent(in) :: a`: initialized array handle. <br /> `integer, intent(in) :: dims(:)`: 1D array with `size(dims)` $\in [1,$ `size(spc)` $]$ containing the labels of the dimensions to permute on. <br /> `integer, allocatable, intent(out) :: dictionary(:, :)`: 2D array with the first index labelling the permutation label and the second the array layout component value of the permutation. Thus, `dictionary(i, :)` is an array layout reference of `a` which references the $i$-th partial permutation of dimensions `dims`. In the case of `a` having `"F"` layout, the permutation labels contiguous in the dictionary are those which permute the dimension label given in `dims(1)` first. In the case of `"C"` layout, the dimension label given in `dims(size(dims))` is permuted first.

## `type(container) :: b`

Expand Down

0 comments on commit c650492

Please sign in to comment.