You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/specs/stdlib_stringlist_type.md
+11-9Lines changed: 11 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -2,23 +2,25 @@
2
2
title: stringlist type
3
3
---
4
4
5
-
# `stdlib_stringlist_type` module (1-D List of strings)
5
+
# `stdlib_stringlist_type` module (1-D list of strings)
6
6
7
7
[TOC]
8
8
9
9
## Introduction
10
10
11
11
The `stdlib_stringlist_type` module provides with 2 derived types to deal with lists of strings.
12
-
`stringlist_type` derived type represents a one-dimensional list of variable-length strings which is compatible with Fortran intrinsic character and `stringlist_index_type` derived type represents an index to access, modify the elements of a stringlist and insert strings to a stringlist.
12
+
`stringlist_type` derived type represents one-dimensional list of variable-length strings (also referred as one-dimensional stringlist) which is compatible with Fortran intrinsic character and `stringlist_index_type` derived type represents an index to access, modify the elements of a stringlist, insert elements to a stringlist and much more.
The `stringlist_type` derived type represents one-dimensional list of strings.
19
+
The `stringlist_type` derived type represents one-dimensional list of strings (also referred as one-dimensional stringlist).
20
20
The internal representation of the list is implementation dependent and is not visible to the user of the module.
21
21
22
+
Note: `stringlist` is an abstract concept which is expressed through the derived type `stringlist_type`.
23
+
22
24
#### Status
23
25
24
26
Experimental
@@ -30,7 +32,7 @@ Experimental
30
32
An instance of the derived type `stringlist_index_type` represents either a forward index OR a backward index.
31
33
The internal representation is implementation dependent and is not visible to the user of the module.
32
34
`list_head` and `list_tail` are 2 special instances of this type representing the head and the tail of a stringlist respectively.
33
-
An instance is independent of the `stringlist_type` it is used with and hence, an index can be used with multiple stringlists in the same program.
35
+
An index is independent of the stringlist(or `stringlist_type`) it is used with and hence, an index can be used with multiple stringlists in the same program.
### Constructor for `stringlist_type`(or stringlist)
90
92
91
93
#### Description
92
94
93
-
No arguments given: Initializes an empty stringlist(a list containing no elements in it).
95
+
No arguments given: Initializes an empty stringlist(a stringlist containing no elements in it).
94
96
95
97
With argument: Initializes a stringlist equivalent to the input array `array` i.e. a stringlist containing all elements of the input array `array` in the same order.
96
98
@@ -389,7 +391,7 @@ a [[stdlib_stringlist_type(module):stringlist_type(type)]].
389
391
390
392
#### Result value
391
393
392
-
The result is a default logical scalar value.
394
+
The result is a default `logical` scalar value.
393
395
394
396
#### Example
395
397
@@ -459,7 +461,7 @@ a [[stdlib_stringlist_type(module):stringlist_type(type)]].
459
461
460
462
#### Result value
461
463
462
-
The result is a default logical scalar value.
464
+
The result is a default `logical` scalar value.
463
465
464
466
#### Example
465
467
@@ -501,7 +503,7 @@ end program demo_inequality_operator
501
503
502
504
#### Description
503
505
504
-
Concatenates left hand side (lhs) and right hand side (rhs).
506
+
Returns the concatenated output of left hand side (lhs) and right hand side (rhs).
0 commit comments