Skip to content

Commit 5c2779d

Browse files
committed
Documented the "named" form for the comparison operations
Documented the use of the "named" forms, .EQ., .NE., .GT., .GE., .LT., .LE., as alternatives to the symbolic forms, ==, /=, >, >=, <, <= of the comparison operations. [ticket: X]
1 parent 9c03d16 commit 5c2779d

File tree

1 file changed

+31
-6
lines changed

1 file changed

+31
-6
lines changed

doc/specs/stdlib_bitsets.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -238,12 +238,12 @@ are summarized in the following table:
238238

239239
|Operator|Description|
240240
|--------|-----------|
241-
|`==`|`.true.` if all bits in `set1` and `set2` have the same value, `.false.` otherwise|
242-
|`/=`|`.true.` if any bits in `set1` and `set2` differ in value, `.false.` otherwise|
243-
|`>`|`.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-
|`>=`|`.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-
|`<`|`.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-
|`<=`|`.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
@@ -1646,6 +1646,11 @@ Returns `.true.` if all bits in `set1` and `set2` have the same value,
16461646

16471647
`result = set1 [[stdlib_bitsets(module):==(interface)]] set2
16481648

1649+
or
1650+
1651+
`result = set1 [[stdlib_bitsets(module):.EQ.(interface)]] set2
1652+
1653+
16491654
#### Class
16501655

16511656
Elemental operator
@@ -1702,6 +1707,10 @@ Returns `.true.` if any bits in `self` and `set2` differ in value,
17021707

17031708
`result = set1 [[stdlib_bitsets(module):/=(interface)]] set2`
17041709

1710+
or
1711+
1712+
`result = set1 [[stdlib_bitsets(module):.NE.(interface)]] set2`
1713+
17051714
#### Class
17061715

17071716
Elemental function
@@ -1760,6 +1769,10 @@ results are undefined
17601769

17611770
`result = set1 [[stdlib_bitsets(module):>=(interface)]] set2`
17621771

1772+
or
1773+
1774+
`result = set1 [[stdlib_bitsets(module):.GE.(interface)]] set2`
1775+
17631776
#### Class
17641777

17651778
Elemental operator
@@ -1819,6 +1832,10 @@ results are undefined
18191832

18201833
`result = set1 [[stdlib_bitsets(module):>(interface)]] set2`
18211834

1835+
or
1836+
1837+
`result = set1 [[stdlib_bitsets(module):.GT.(interface)]] set2`
1838+
18221839
#### Class
18231840

18241841
Elemental operator
@@ -1878,6 +1895,10 @@ results are undefined
18781895

18791896
`result = set1 [[stdlib_bitsets(module):<=(interface)]] set2`
18801897

1898+
or
1899+
1900+
`result = set1 [[stdlib_bitsets(module):.LE.(interface)]] set2`
1901+
18811902
#### Class
18821903

18831904
Elemental operator
@@ -1938,6 +1959,10 @@ results are undefined
19381959

19391960
`result = set1 [[stdlib_bitsets(module):<(interface)]] set2`
19401961

1962+
or
1963+
1964+
`result = set1 [[stdlib_bitsets(module):.LT.(interface)]] set2
1965+
19411966
#### Class
19421967

19431968
Elemental operator

0 commit comments

Comments
 (0)