stdlib_stringlist_type#

See also the specification page: stdlib_stringlist_type.

stdlib_stringlist_type (module)#

Variables

list_headtype(stringlist_index_type), parameter, Default = stringlist_index_type(.true., 1)
list_tailtype(stringlist_index_type), parameter, Default = stringlist_index_type(.false., 1)

Types

stringlist_index_type (type)#

stringlist_index_type (type)

stringlist_type (type)#

stringlist_type (type)
Procedures:
  • clear => clear_list

  • len => length_list

  • insert_at => insert_at_char_idx, insert_at_string_idx, insert_at_stringlist_idx, insert_at_chararray_idx, insert_at_stringarray_idx

  • get => get_string_idx

Interfaces

fidx (interface)#

fidx (interface)

Returns an instance of type ‘stringlist_index_type’ representing forward index Specifications: stdlib_stringlist_type

Procedures:

bidx (interface)#

bidx (interface)

Returns an instance of type ‘stringlist_index_type’ representing backward index Specifications: stdlib_stringlist_type

Procedures:

operator(//) (interface)#

operator(//) (interface)

Concatenates stringlist with the input entity Returns a new stringlist Specifications: stdlib_stringlist_type

Procedures:

operator(==) (interface)#

operator(==) (interface)

Compares stringlist for equality with the input entity Returns a logical Specifications: stdlib_stringlist_type

Procedures:

operator(/=) (interface)#

operator(/=) (interface)

Compares stringlist for inequality with the input entity Returns a logical Specifications: stdlib_stringlist_type

Procedures:

Procedures

forward_index (function)#

pure function forward_index(idx) -> forward_index

Returns an instance of type ‘stringlist_index_type’ representing forward index ‘idx’

Arguments:
idxinteger, intent(in)
Returns:
forward_indextype(stringlist_index_type)

backward_index (function)#

pure function backward_index(idx) -> backward_index

Returns an instance of type ‘stringlist_index_type’ representing backward index ‘idx’

Arguments:
idxinteger, intent(in)
Returns:
backward_indextype(stringlist_index_type)

append_char (function)#

function append_char(lhs, rhs) -> append_char

Appends character scalar ‘rhs’ to the stringlist ‘list’ Returns a new stringlist

Arguments:
lhstype(stringlist_type), intent(in)
rhscharacter(len=*), intent(in)
Returns:
append_chartype(stringlist_type)

append_string (function)#

function append_string(lhs, rhs) -> append_string

Appends string ‘rhs’ to the stringlist ‘list’ Returns a new stringlist

Arguments:
lhstype(stringlist_type), intent(in)
rhstype(string_type), intent(in)
Returns:
append_stringtype(stringlist_type)

prepend_char (function)#

function prepend_char(lhs, rhs) -> prepend_char

Prepends character scalar ‘lhs’ to the stringlist ‘rhs’ Returns a new stringlist

Arguments:
lhscharacter(len=*), intent(in)
rhstype(stringlist_type), intent(in)
Returns:
prepend_chartype(stringlist_type)

prepend_string (function)#

function prepend_string(lhs, rhs) -> prepend_string

Prepends string ‘lhs’ to the stringlist ‘rhs’ Returns a new stringlist

Arguments:
lhstype(string_type), intent(in)
rhstype(stringlist_type), intent(in)
Returns:
prepend_stringtype(stringlist_type)

append_stringlist (function)#

function append_stringlist(lhs, rhs) -> append_stringlist

Appends stringlist ‘rhs’ to the stringlist ‘lhs’ Returns a new stringlist

Arguments:
lhstype(stringlist_type), intent(in)
rhstype(stringlist_type), intent(in)
Returns:
append_stringlisttype(stringlist_type)

append_carray (function)#

function append_carray(lhs, rhs) -> append_carray

Appends chararray ‘rhs’ to the stringlist ‘lhs’ Returns a new stringlist

Arguments:
lhstype(stringlist_type), intent(in)
rhscharacter(len=*), dimension(:), intent(in)
Returns:
append_carraytype(stringlist_type)

append_sarray (function)#

function append_sarray(lhs, rhs) -> append_sarray

Appends stringarray ‘rhs’ to the stringlist ‘lhs’ Returns a new stringlist

Arguments:
lhstype(stringlist_type), intent(in)
rhstype(string_type), dimension(:), intent(in)
Returns:
append_sarraytype(stringlist_type)

prepend_carray (function)#

function prepend_carray(lhs, rhs) -> prepend_carray

Prepends chararray ‘lhs’ to the stringlist ‘rhs’ Returns a new stringlist

Arguments:
lhscharacter(len=*), dimension(:), intent(in)
rhstype(stringlist_type), intent(in)
Returns:
prepend_carraytype(stringlist_type)

prepend_sarray (function)#

function prepend_sarray(lhs, rhs) -> prepend_sarray

Prepends stringarray ‘lhs’ to the stringlist ‘rhs’ Returns a new stringlist

Arguments:
lhstype(string_type), dimension(:), intent(in)
rhstype(stringlist_type), intent(in)
Returns:
prepend_sarraytype(stringlist_type)

eq_stringlist (function)#

pure function eq_stringlist(lhs, rhs) -> eq_stringlist

Compares stringlist ‘lhs’ for equality with stringlist ‘rhs’ Returns a logical

Arguments:
lhstype(stringlist_type), intent(in)
rhstype(stringlist_type), intent(in)
Returns:
eq_stringlistlogical

eq_stringlist_carray (function)#

pure function eq_stringlist_carray(lhs, rhs) -> eq_stringlist_carray

Compares stringlist ‘lhs’ for equality with chararray ‘rhs’ Returns a logical

Arguments:
lhstype(stringlist_type), intent(in)
rhscharacter(len=*), dimension(:), intent(in)
Returns:
eq_stringlist_carraylogical

eq_stringlist_sarray (function)#

pure function eq_stringlist_sarray(lhs, rhs) -> eq_stringlist_sarray

Compares stringlist ‘lhs’ for equality with stringarray ‘rhs’ Returns a logical

Arguments:
lhstype(stringlist_type), intent(in)
rhstype(string_type), dimension(:), intent(in)
Returns:
eq_stringlist_sarraylogical

eq_carray_stringlist (function)#

pure function eq_carray_stringlist(lhs, rhs) -> eq_carray_stringlist

Compares chararray ‘lhs’ for equality with stringlist ‘rhs’ Returns a logical

Arguments:
lhscharacter(len=*), dimension(:), intent(in)
rhstype(stringlist_type), intent(in)
Returns:
eq_carray_stringlistlogical

eq_sarray_stringlist (function)#

pure function eq_sarray_stringlist(lhs, rhs) -> eq_sarray_stringlist

Compares stringarray ‘lhs’ for equality with stringlist ‘rhs’ Returns a logical

Arguments:
lhstype(string_type), dimension(:), intent(in)
rhstype(stringlist_type), intent(in)
Returns:
eq_sarray_stringlistlogical

ineq_stringlist (function)#

pure function ineq_stringlist(lhs, rhs) -> ineq_stringlist

Compares stringlist ‘lhs’ for inequality with stringlist ‘rhs’ Returns a logical

Arguments:
lhstype(stringlist_type), intent(in)
rhstype(stringlist_type), intent(in)
Returns:
ineq_stringlistlogical

ineq_stringlist_carray (function)#

pure function ineq_stringlist_carray(lhs, rhs) -> ineq_stringlist_carray

Compares stringlist ‘lhs’ for inequality with chararray ‘rhs’ Returns a logical

Arguments:
lhstype(stringlist_type), intent(in)
rhscharacter(len=*), dimension(:), intent(in)
Returns:
ineq_stringlist_carraylogical

ineq_stringlist_sarray (function)#

pure function ineq_stringlist_sarray(lhs, rhs) -> ineq_stringlist_sarray

Compares stringlist ‘lhs’ for inequality with stringarray ‘rhs’ Returns a logical

Arguments:
lhstype(stringlist_type), intent(in)
rhstype(string_type), dimension(:), intent(in)
Returns:
ineq_stringlist_sarraylogical

ineq_carray_stringlist (function)#

pure function ineq_carray_stringlist(lhs, rhs) -> ineq_carray_stringlist

Compares chararray ‘lhs’ for inequality with stringlist ‘rhs’ Returns a logical

Arguments:
lhscharacter(len=*), dimension(:), intent(in)
rhstype(stringlist_type), intent(in)
Returns:
ineq_carray_stringlistlogical

ineq_sarray_stringlist (function)#

pure function ineq_sarray_stringlist(lhs, rhs) -> ineq_sarray_stringlist

Compares stringarray ‘lhs’ for inequality with stringlist ‘rhs’ Returns a logical

Arguments:
lhstype(string_type), dimension(:), intent(in)
rhstype(stringlist_type), intent(in)
Returns:
ineq_sarray_stringlistlogical

length_list (function)#

pure function length_list(list) -> length_list

Returns the len (length) of the list Returns an integer

Arguments:
listclass(stringlist_type), intent(in)
Returns:
length_listinteger

clear_list (subroutine)#

subroutine clear_list(list)

Resets stringlist ‘list’ to an empy stringlist of len 0 Modifies the input stringlist ‘list’

Arguments:
listclass(stringlist_type), intent(inout)