Skip to content

Commit 99fa382

Browse files
committed
typography fixes
1 parent 5c2779d commit 99fa382

File tree

1 file changed

+32
-37
lines changed

1 file changed

+32
-37
lines changed

doc/specs/stdlib_bitsets.md

Lines changed: 32 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ defines three bitset types, multiple constants, a character string
2121
literal that can be read to and from strings and formatted files, a
2222
simple character string literal that can be read to and from strings,
2323
assignments, procedures, methods, and operators. Note that the module
24-
assumes two's complement integers, but all current Fortran 95+
24+
assumes two's complement integers, but all current Fortran 95 and later
2525
processors use such integers.
2626

2727
Note that the module defines a number of "binary" procedures,
@@ -64,7 +64,7 @@ bits. The other constants that are error codes are summarized below:
6464
The `stdlib_bitsets` module defines three derived types,
6565
`bitset_type`, `bitset_64`, and `bitset_large`. `bitset_type` is an abstract
6666
type that serves as the ancestor of `bitset_64` and
67-
`bitset_large`. `bitset_type` defines one method, `bits`, all of its
67+
`bitset_large`. `bitset_type` defines one method, `bits`, and all of its
6868
other methods are deferred to its extensions. `bitset_64` is a bitset
6969
that can handle up to 64 bits. `bitset_large` is a bitset that can handle
7070
up `huge(0_bits_kind)` bits. All attributes of the bitset types are
@@ -238,12 +238,12 @@ are summarized in the following table:
238238

239239
|Operator|Description|
240240
|--------|-----------|
241-
|`==`, `.EQ.`|`.true.` if all bits in `set1` and `set2` have the same value, `.false.` otherwise|
242-
|`/=`, `.NE.`|`.true.` if any bits in `set1` and `set2` differ in value, `.false.` otherwise|
243-
|`>`, `.GT.`|`.true.` if the bits in `set1` and `set2` differ in value and the highest order differing bit is 1 in `set1` and 0 in `set2`, `.false.` otherwise|
244-
|`>=`, `.GE.`|`.true.` if the bits in `set1` and `set2` are the same or the highest order differing bit is 1 in `set1` and 0 in `set2`, `.false.` otherwise|
245-
|`<`, `.LT.`|`.true.` if the bits in `set1` and `set2` differ in value and the highest order differing bit is 0 in `set1` and 1 in `set2`, `.false.` otherwise|
246-
|`<=`, `.LE.`|`.true.` if the bits in `set1` and `set2` are the same or the highest order differing bit is 0 in `set1` and 1 in `set2`, `.false.` otherwise|
241+
|`==`, `.eq.`|`.true.` if all bits in `set1` and `set2` have the same value, `.false.` otherwise|
242+
|`/=`, `.ne.`|`.true.` if any bits in `set1` and `set2` differ in value, `.false.` otherwise|
243+
|`>`, `.gt.`|`.true.` if the bits in `set1` and `set2` differ in value and the highest order differing bit is 1 in `set1` and 0 in `set2`, `.false.` otherwise|
244+
|`>=`, `.ge.`|`.true.` if the bits in `set1` and `set2` are the same or the highest order differing bit is 1 in `set1` and 0 in `set2`, `.false.` otherwise|
245+
|`<`, `.lt.`|`.true.` if the bits in `set1` and `set2` differ in value and the highest order differing bit is 0 in `set1` and 1 in `set2`, `.false.` otherwise|
246+
|`<=`, `.le.`|`.true.` if the bits in `set1` and `set2` are the same or the highest order differing bit is 0 in `set1` and 1 in `set2`, `.false.` otherwise|
247247

248248

249249
## Specification of the `stdlib_bitsets` methods and procedures
@@ -256,7 +256,7 @@ Experimental
256256

257257
#### Description
258258

259-
Determines whether all bits are set to 1 in self.
259+
Determines whether all bits are set to 1 in `self`.
260260

261261
#### Syntax
262262

@@ -744,7 +744,7 @@ Subroutine
744744

745745
#### Arguments
746746

747-
`self`: shall be a scalar class `bitset_type` variable. It is an
747+
`self`: shall be a scalar class `bitset_type` variable. It is an
748748
`intent(out)` argument.
749749

750750
`string`: shall be a scalar default character expression. It is an
@@ -871,8 +871,8 @@ Subroutine
871871

872872
`unit`: shall be a scalar default integer expression. It is an
873873
`intent(in)` argument. Its value must be that of a logical unit
874-
number for an open unformatted file with `READ` or `READWRITE`
875-
access positioned at the start of a BITSET value written by a
874+
number for an open unformatted file with `read` or `readwrite`
875+
access positioned at the start of a bitset value written by a
876876
`bitset_type` `output` subroutine by the same processor.
877877

878878
`status` (optional): shall be a scalar default integer variable. If
@@ -997,8 +997,8 @@ Elemental subroutine.
997997
#### Argument
998998

999999
`self` shall be a scalar variable of class `bitset_type`. It is an
1000-
`intent(inout)` argument. On return its bits shall be the logical
1001-
complement of their values on input.
1000+
`intent(inout)` argument. On return its bits shall be the logical
1001+
complement of their values on input.
10021002

10031003
#### Example
10041004

@@ -1041,9 +1041,9 @@ Elemental subroutine.
10411041
#### Arguments
10421042

10431043
`set1`: shall be a scalar `bitset_64` or `bitset_large` variable. It
1044-
is an `intent(inout)` argument. On return the values of the bits in
1045-
`setf` are the bitwise `or` of the original bits in `set1` with the
1046-
corresponding bits in `set2`.
1044+
is an `intent(inout)` argument. On return the values of the bits in
1045+
`setf` are the bitwise `or` of the original bits in `set1` with the
1046+
corresponding bits in `set2`.
10471047

10481048
`set2`: shall be a scalar expression of the same type as `set1`. It is
10491049
an `intent(in)` argument. Note `bits(set2)` must equal `bits(set1)`
@@ -1097,7 +1097,7 @@ Subroutine.
10971097

10981098
`unit`: shall be a scalar default integer expression. It is an
10991099
`intent(in)` argument. Its value must be that of an I/O unit number
1100-
for an open unformatted file with `WRITE` or `READWRITE` access.
1100+
for an open unformatted file with `write` or `readwrite` access.
11011101

11021102
`status` (optional): shall be a scalar default integer variable. It is
11031103
an `intent(out)` argument. If present on return it will have the value
@@ -1182,7 +1182,7 @@ or a blank.
11821182

11831183
`unit` (optional): shall be a scalar default integer expression. It is
11841184
an `intent(in)` argument. Its value must be that of an I/O unit number
1185-
for an open formatted file with `READ` or `READWRITE` access
1185+
for an open formatted file with `read` or `readwrite` access
11861186
positioned at the start of a *bitset-literal*.
11871187

11881188
`advance` (optional): shall be a scalar default character
@@ -1394,7 +1394,7 @@ Subroutine
13941394
`intent(in)` argument.
13951395

13961396
`string`: shall be a scalar default character variable of allocatable
1397-
length. It is an `intent(out)` argument. On return it shall hav a
1397+
length. It is an `intent(out)` argument. On return it shall have a
13981398
*binary-literal* representation of the bitset `self`.
13991399

14001400
`status` (optional): shall be a scalar default integer variable. It is
@@ -1644,12 +1644,11 @@ Returns `.true.` if all bits in `set1` and `set2` have the same value,
16441644

16451645
#### Syntax
16461646

1647-
`result = set1 [[stdlib_bitsets(module):==(interface)]] set2
1647+
`result = set1 [[stdlib_bitsets(module):==(interface)]] set2`
16481648

16491649
or
16501650

1651-
`result = set1 [[stdlib_bitsets(module):.EQ.(interface)]] set2
1652-
1651+
`result = set1 [[stdlib_bitsets(module):.EQ.(interface)]] set2`
16531652

16541653
#### Class
16551654

@@ -1668,7 +1667,7 @@ argument.
16681667

16691668
The result is a default logical scalar.
16701669
The result is `.true.` if the bits in both bitsets are set
1671-
to the same value, otherwise the result is `.FALSE.`.
1670+
to the same value, otherwise the result is `.false.`.
16721671

16731672
#### Example
16741673

@@ -1702,7 +1701,6 @@ Experimental
17021701
Returns `.true.` if any bits in `self` and `set2` differ in value,
17031702
`.false.` otherwise.
17041703

1705-
17061704
#### Syntax
17071705

17081706
`result = set1 [[stdlib_bitsets(module):/=(interface)]] set2`
@@ -1762,8 +1760,7 @@ Experimental
17621760
Returns `.true.` if the bits in `set1` and `set2` are the same or the
17631761
highest order different bit is set to 1 in `set1` and to 0 in `set2`,
17641762
`.false.`. otherwise. The sets must be the same size otherwise the
1765-
results are undefined
1766-
1763+
results are undefined.
17671764

17681765
#### Syntax
17691766

@@ -1825,8 +1822,8 @@ Experimental
18251822

18261823
Returns `.true.` if the bits in `set1` and `set2` differ and the
18271824
highest order different bit is set to 1 in `set1` and to 0 in `set2`,
1828-
`.false.` otherwise. The sets must be the same size otherwise the
1829-
results are undefined
1825+
`.false.` otherwise. The sets must be the same size otherwise the
1826+
results are undefined.
18301827

18311828
#### Syntax
18321829

@@ -1854,7 +1851,7 @@ argument.
18541851
The result is a default logical scalar.
18551852
The result is `.true.` if the bits in `set1` and `set2` differ and the
18561853
highest order different bit is set to 1 in `set1` and to 0 in `set2`,
1857-
`.false.`. otherwise.
1854+
`.false.` otherwise.
18581855

18591856
#### Example
18601857

@@ -1887,9 +1884,8 @@ Experimental
18871884

18881885
Returns `.true.` if the bits in `set1` and `set2` are the same or the
18891886
highest order different bit is set to 0 in `set1` and to 1 in `set2`,
1890-
`.false.` otherwise. The sets must be the same size otherwise the
1891-
results are undefined
1892-
1887+
`.false.` otherwise. The sets must be the same size otherwise the
1888+
results are undefined.
18931889

18941890
#### Syntax
18951891

@@ -1917,7 +1913,7 @@ argument.
19171913
The result is a default logical scalar.
19181914
The result is `.true.` if the bits in `set1` and `set2` are the same
19191915
or the highest order different bit is set to 0 in `set1` and to 1 in
1920-
`set2`, `.false.` otherwise.
1916+
`set2`, `.false.` otherwise.
19211917

19221918
#### Example
19231919

@@ -1952,8 +1948,7 @@ Experimental
19521948
Returns `.true.` if the bits in `set1` and `set2` differ and the
19531949
highest order different bit is set to 0 in `set1` and to 1 in `set2`,
19541950
`.false.` otherwise. The sets must be the same size otherwise the
1955-
results are undefined
1956-
1951+
results are undefined.
19571952

19581953
#### Syntax
19591954

@@ -1981,7 +1976,7 @@ argument.
19811976
The result is a default logical scalar.
19821977
The result is `.true.` if the bits in `set1` and `set2` differ and the
19831978
highest order different bit is set to 0 in `set1` and to 1 in `set2`,
1984-
`.false.` otherwise.
1979+
`.false.` otherwise.
19851980

19861981
#### Example
19871982

0 commit comments

Comments
 (0)