OpenCMISS-Iron Internal API Documentation
strings Module Reference

This module contains all string manipulation and transformation routines. More...

Data Types

interface  character_to_lowercase
 Returns a character string which is the lowercase equivalent of the supplied string. More...
 
interface  character_to_uppercase
 Returns a character string which is the uppercase equivalent of the supplied string. More...
 
interface  charactertolowercase
 Returns a character string which is the lowercase equivalent of the supplied string. More...
 
interface  charactertouppercase
 Returns a character string which is the uppercase equivalent of the supplied string. More...
 
interface  is_abbreviation
 Returns .TRUE. if a supplied string is a valid abbreviation of a second supplied string. More...
 
interface  isabbreviation
 Returns .TRUE. if a supplied string is a valid abbreviation of a second supplied string. More...
 
interface  isdigit
 
interface  isletter
 
interface  iswhitespace
 
interface  list_to_character
 Converts a list to its equivalent character string representation. More...
 
interface  listtocharacter
 Converts a list to its equivalent character string representation. More...
 
interface  logicaltocharacter
 
interface  logicaltovstring
 
interface  number_to_character
 Converts a number to its equivalent character string representation. More...
 
interface  number_to_vstring
 Converts a number to its equivalent varying string representation. More...
 
interface  numbertocharacter
 Converts a number to its equivalent character string representation. More...
 
interface  numbertovstring
 
interface  stingtosingle
 Converts a string representation of a number to a single precision number. More...
 
interface  string_to_double
 Converts a string representation of a number to a double precision number. More...
 
interface  string_to_integer
 Converts a string representation of a number to an integer. More...
 
interface  string_to_logical
 Converts a string representation of a boolean value (TRUE or FALSE) to a logical. More...
 
interface  string_to_long_integer
 Converts a string representation of a number to a long integer. More...
 
interface  string_to_single
 Converts a string representation of a number to a single precision number. More...
 
interface  stringtodouble
 Converts a string representation of a number to a double precision number. More...
 
interface  stringtointeger
 Converts a string representation of a number to an integer. More...
 
interface  stringtological
 Converts a string representation of a boolean value (TRUE or FALSE) to a logical. More...
 
interface  stringtolonginteger
 Converts a string representation of a number to a long integer. More...
 
interface  vstring_to_lowercase
 Returns a varying string which is the lowercase equivalent of the supplied string. More...
 
interface  vstring_to_uppercase
 Returns a varying string which is the uppercase equivalent of the supplied string. More...
 
interface  vstringtolowercase
 Returns a varying string which is the lowercase equivalent of the supplied string. More...
 
interface  vstringtouppercase
 Returns a varying string which is the uppercase equivalent of the supplied string. More...
 

Functions/Subroutines

logical function is_abbreviation_c_c (SHORT, LONG, MIN_NUM_CHARACTERS)
 IS_ABBREVIATION returns .TRUE. if the character string SHORT is an abbreviation of the character string LONG. SHORT must be at least MIN_NUM_CHARACTERS long. More...
 
logical function is_abbreviation_c_vs (SHORT, LONG, MIN_NUM_CHARACTERS)
 IS_ABBREVIATION returns .TRUE. if the character string SHORT is an abbreviation of the varying string LONG. SHORT must be at least MIN_NUM_CHARACTERS long. More...
 
logical function is_abbreviation_vs_c (SHORT, LONG, MIN_NUM_CHARACTERS)
 IS_ABBREVIATION returns .TRUE. if the varying string SHORT is an abbreviation of the character string LONG. SHORT must be at least MIN_NUM_CHARACTERS long. More...
 
logical function is_abbreviation_vs_vs (SHORT, LONG, MIN_NUM_CHARACTERS)
 IS_ABBREVIATION returns .TRUE. if the varying string SHORT is an abbreviation of the varying string LONG. SHORT must be at least MIN_NUM_CHARACTERS long. More...
 
logical function, public is_digit (CHARAC)
 IS_DIGIT returns .TRUE. if the character CHARAC is a digit character (i.e. 0..9) More...
 
logical function, public is_letter (CHARAC)
 IS_LETTER returns .TRUE. if the character CHARAC is a letter character (i.e. A..Z or a..z) More...
 
logical function is_lowercase (CHARC)
 Returns .TRUE. if the supplied character is a lowercase character. More...
 
logical function is_uppercase (CHARC)
 Returns .TRUE. if the supplied character is an uppercase character. More...
 
logical function, public is_whitespace (CHARAC)
 IS_WHITESPACE returns .TRUE. if the character CHARAC is a whitespace character (i.e. space, tabs, etc.) More...
 
character(len=maxstrlen) function list_to_character_c (NUMBER_IN_LIST, LIST, FORMAT, ERR, ERROR, LIST_LENGTHS)
 Converts a character list to its equivalent character string representation as determined by the supplied format. If present, the optional argument LIST_LENGTHS is used for the lengths of each list elements length otherwise the trimmed length is used. NOTE: The FORMAT is ignored for this child FUNCTION. More...
 
character(len=maxstrlen) function list_to_character_intg (NUMBER_IN_LIST, LIST, FORMAT, ERR, ERROR)
 Converts an integer list to its equivalent character string representation as determined by the supplied format. More...
 
character(len=maxstrlen) function list_to_character_lintg (NUMBER_IN_LIST, LIST, FORMAT, ERR, ERROR)
 Converts an long integer list to its equivalent character string representation as determined by the supplied format. More...
 
character(len=maxstrlen) function list_to_character_l (NUMBER_IN_LIST, LIST, FORMAT, ERR, ERROR)
 Converts a logical list to its equivalent character string representation as determined by the supplied format string. The FORMAT is ignored for this child FUNCTION. More...
 
character(len=maxstrlen) function list_to_character_sp (NUMBER_IN_LIST, LIST, FORMAT, ERR, ERROR)
 Converts a single precision list to its equivalent character string representation as determined by the supplied format string. More...
 
character(len=maxstrlen) function list_to_character_dp (NUMBER_IN_LIST, LIST, FORMAT, ERR, ERROR)
 Converts a double precision list to its equivalent character string representation as determined by the supplied format string. More...
 
character(len=maxstrlen) function, public logical_to_character (LOGICALVALUE, ERR, ERROR)
 Converts a logical value to either a "TRUE" or "FALSE" character string. More...
 
type(varying_string) function, public logical_to_vstring (LOGICALVALUE, ERR, ERROR)
 Converts a logical value to either a "TRUE" or "FALSE" varying string. More...
 
character(len=maxstrlen) function number_to_character_intg (NUMBER, FORMAT, ERR, ERROR)
 Converts an integer number to its equivalent character string representation as determined by the supplied format. The format is of the form of a standard Fortran integer format e.g. "I3". More...
 
character(len=maxstrlen) function number_to_character_lintg (NUMBER, FORMAT, ERR, ERROR)
 Converts a long integer number to its equivalent character string representation as determined by the supplied format. The format is of the form of a standard Fortran integer format e.g. "I3". More...
 
character(len=maxstrlen) function number_to_character_sp (NUMBER, FORMAT, ERR, ERROR)
 Converts a single precision number to its equivalent character string representation as determined by the supplied format string. NOTE: If FORMAT is an asterisk followed by a number between 1 and 32 the format will be chosen to maximise the number of significant digits, e.g., FORMAT="*8" will return a string of 8 characters representing the supplied number in either F8.? or E8.? format depending on its magnitude. More...
 
character(len=maxstrlen) function number_to_character_dp (NUMBER, FORMAT, ERR, ERROR)
 Converts a double precision number to its equivalent character string representation as determined by the supplied format string. Note If FORMAT is an asterisk followed by a number between 1 and 32 the format will be chosen to maximise the number of significant digits, e.g., FORMAT="*8" will return a string of 8 characters representing the supplied number in either F8.? or E8.? format depending on its magnitude. More...
 
type(varying_string) function number_to_vstring_intg (NUMBER, FORMAT, ERR, ERROR)
 Converts an integer number to its equivalent varying string representation as determined by the supplied format. The format is of the form of a standard Fortran integer format e.g. "I3". More...
 
type(varying_string) function number_to_vstring_lintg (NUMBER, FORMAT, ERR, ERROR)
 Converts a long integer number to its equivalent varying string representation as determined by the supplied format. The format is of the form of a standard Fortran integer format e.g., "I3". More...
 
type(varying_string) function number_to_vstring_sp (NUMBER, FORMAT, ERR, ERROR)
 Converts a single precision number to its equivalent varying string representation as determined by the supplied format string. Note If FORMAT is an asterisk followed by a number between 1 and 32 the format will be chosen to maximise the number of significant digits, e.g., FORMAT="*8" will return a string of 8 characters representing the supplied number in either F8.? or E8.? format depending on its magnitude. More...
 
type(varying_string) function number_to_vstring_dp (NUMBER, FORMAT, ERR, ERROR)
 Converts a double precision number to its equivalent varying string representation as determined by the supplied format string. Note If FORMAT is an asterisk followed by a number between 1 and 32 the format will be chosen to maximise the number of significant digits, e.g., FORMAT="*8" will return a string of 8 characters representing the supplied number in either F8.? or E8.? format depending on its magnitude. More...
 
real(dp) function string_to_double_c (STRING, ERR, ERROR)
 Converts a character string representation of a number to a double precision number. More...
 
real(dp) function string_to_double_vs (STRING, ERR, ERROR)
 Converts a varying string representation of a number to a double precision number. More...
 
integer(intg) function string_to_integer_c (STRING, ERR, ERROR)
 Converts a character string representation of a number to an integer. More...
 
integer(intg) function string_to_integer_vs (STRING, ERR, ERROR)
 Converts a varying string representation of a number to an integer. More...
 
integer(lintg) function string_to_long_integer_c (STRING, ERR, ERROR)
 Converts a character string representation of a number to a long integer. More...
 
integer(lintg) function string_to_long_integer_vs (STRING, ERR, ERROR)
 Converts a varying string representation of a number to a long integer. More...
 
logical function string_to_logical_c (STRING, ERR, ERROR)
 Converts a character string representation of a boolean (TRUE or FALSE) to a logical. More...
 
logical function string_to_logical_vs (STRING, ERR, ERROR)
 Converts a varying string representation of a boolean (TRUE or FALSE) to a logical. More...
 
real(sp) function string_to_single_c (STRING, ERR, ERROR)
 Converts a character string representation of a number to a single precision number. More...
 
real(sp) function string_to_single_vs (STRING, ERR, ERROR)
 Converts a varying string representation of a number to a single precision number. More...
 
character(len=len(string)) function character_to_lowercase_c (STRING)
 
character(len=len(string)) function character_to_lowercase_vs (STRING)
 Returns a character string that is the lowercase equivalent of the supplied varying string. More...
 
type(varying_string) function vstring_to_lowercase_c (STRING)
 Returns a varying string that is the lowercase equivalent of the supplied character string. More...
 
type(varying_string) function vstring_to_lowercase_vs (STRING)
 Returns a varying string that is the lowercase equivalent of the supplied varying string. More...
 
character(len=len(string)) function character_to_uppercase_c (STRING)
 Returns a character string which is uppercase equivalent of the supplied character string. More...
 
character(len=len(string)) function character_to_uppercase_vs (STRING)
 Returns a character string which is uppercase equivalent of the supplied varying string. More...
 
type(varying_string) function vstring_to_uppercase_c (STRING)
 Returns a varying string which is uppercase equivalent of the supplied character string. More...
 
type(varying_string) function vstring_to_uppercase_vs (STRING)
 Returns a varying string which is uppercase equivalent of the supplied varying string. More...
 

Detailed Description

This module contains all string manipulation and transformation routines.

Function/Subroutine Documentation

character(len=len(string)) function strings::character_to_lowercase_c ( character(len=*), intent(in)  STRING)
private
Parameters
[in]stringThe string to convert to lowercase
Returns
On exit, the lowercase equivalent of the string

Definition at line 1722 of file strings.f90.

References is_uppercase().

character(len=len(string)) function strings::character_to_lowercase_vs ( type(varying_string), intent(in)  STRING)
private

Returns a character string that is the lowercase equivalent of the supplied varying string.

Parameters
[in]stringThe string to convert
Returns
On exit, the lowercase equivalent of the string

Definition at line 1747 of file strings.f90.

References is_uppercase().

character(len=len(string)) function strings::character_to_uppercase_c ( character(len=*), intent(in)  STRING)
private

Returns a character string which is uppercase equivalent of the supplied character string.

Parameters
[in]stringThe string to convert
Returns
On exit, the uppercase equivalent of the string

Definition at line 1822 of file strings.f90.

References is_lowercase().

character(len=len(string)) function strings::character_to_uppercase_vs ( type(varying_string), intent(in)  STRING)
private

Returns a character string which is uppercase equivalent of the supplied varying string.

Parameters
[in]stringThe string to convert
Returns
On exit, the uppercase equivalent of the string

Definition at line 1847 of file strings.f90.

References is_lowercase().

logical function strings::is_abbreviation_c_c ( character(len=*), intent(in)  SHORT,
character(len=*), intent(in)  LONG,
integer(intg), intent(in)  MIN_NUM_CHARACTERS 
)
private

IS_ABBREVIATION returns .TRUE. if the character string SHORT is an abbreviation of the character string LONG. SHORT must be at least MIN_NUM_CHARACTERS long.

Parameters
[in]shortThe short form of the string
[in]longThe long form of the string
[in]min_num_charactersThe minimum number of characters to match
Returns
On exit, .TRUE. if the short string is an abbreviation

Definition at line 296 of file strings.f90.

logical function strings::is_abbreviation_c_vs ( character(len=*), intent(in)  SHORT,
type(varying_string), intent(in)  LONG,
integer(intg), intent(in)  MIN_NUM_CHARACTERS 
)
private

IS_ABBREVIATION returns .TRUE. if the character string SHORT is an abbreviation of the varying string LONG. SHORT must be at least MIN_NUM_CHARACTERS long.

Parameters
[in]shortThe short form of the string
[in]longThe long form of the string
[in]min_num_charactersThe minimum number of characters to match
Returns
On exit, .TRUE. if the short string is an abbreviation

Definition at line 328 of file strings.f90.

logical function strings::is_abbreviation_vs_c ( type(varying_string), intent(in)  SHORT,
character(len=*), intent(in)  LONG,
integer(intg), intent(in)  MIN_NUM_CHARACTERS 
)
private

IS_ABBREVIATION returns .TRUE. if the varying string SHORT is an abbreviation of the character string LONG. SHORT must be at least MIN_NUM_CHARACTERS long.

Parameters
[in]shortThe short form of the string
[in]longThe long form of the string
[in]min_num_charactersThe minimum number of characters to match
Returns
On exit, .TRUE. if the short string is an abbreviation

Definition at line 360 of file strings.f90.

logical function strings::is_abbreviation_vs_vs ( type(varying_string), intent(in)  SHORT,
type(varying_string), intent(in)  LONG,
integer(intg), intent(in)  MIN_NUM_CHARACTERS 
)
private

IS_ABBREVIATION returns .TRUE. if the varying string SHORT is an abbreviation of the varying string LONG. SHORT must be at least MIN_NUM_CHARACTERS long.

Parameters
[in]shortThe short form of the string
[in]longThe long form of the string
[in]min_num_charactersThe minimum number of characters to match
Returns
On exit, .TRUE. if the short string is an abbreviation

Definition at line 392 of file strings.f90.

logical function, public strings::is_digit ( character(len=1), intent(in)  CHARAC)

IS_DIGIT returns .TRUE. if the character CHARAC is a digit character (i.e. 0..9)

Parameters
[in]characThe character to test if it is a digit
Returns
On exit, .TRUE. if the character is a digit

Definition at line 423 of file strings.f90.

logical function, public strings::is_letter ( character(len=1), intent(in)  CHARAC)

IS_LETTER returns .TRUE. if the character CHARAC is a letter character (i.e. A..Z or a..z)

Parameters
[in]characThe character to test if it is a letter
Returns
On exit, .TRUE. if the character is a letter

Definition at line 441 of file strings.f90.

logical function strings::is_lowercase ( character(len=1), intent(in)  CHARC)
private

Returns .TRUE. if the supplied character is a lowercase character.

Parameters
[in]charcThe character to test if it is lowercase
Returns
On exit, .TRUE. if the character is lowercase

Definition at line 460 of file strings.f90.

Referenced by character_to_uppercase_c(), character_to_uppercase_vs(), vstring_to_uppercase_c(), and vstring_to_uppercase_vs().

logical function strings::is_uppercase ( character(len=1), intent(in)  CHARC)
private

Returns .TRUE. if the supplied character is an uppercase character.

Parameters
[in]charcThe character to test if it is uppercase
Returns
On exit, .TRUE. if the character is uppercase

Definition at line 482 of file strings.f90.

Referenced by character_to_lowercase_c(), character_to_lowercase_vs(), vstring_to_lowercase_c(), and vstring_to_lowercase_vs().

logical function, public strings::is_whitespace ( character(len=1), intent(in)  CHARAC)

IS_WHITESPACE returns .TRUE. if the character CHARAC is a whitespace character (i.e. space, tabs, etc.)

Parameters
[in]characThe character to test if it is whitespace
Returns
On exit, .TRUE. if the character is whitespace

Definition at line 504 of file strings.f90.

character(len=maxstrlen) function strings::list_to_character_c ( integer(intg), intent(in)  NUMBER_IN_LIST,
character(len=*), dimension(number_in_list), intent(in)  LIST,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR,
integer(intg), dimension(number_in_list), intent(in), optional  LIST_LENGTHS 
)
private

Converts a character list to its equivalent character string representation as determined by the supplied format. If present, the optional argument LIST_LENGTHS is used for the lengths of each list elements length otherwise the trimmed length is used. NOTE: The FORMAT is ignored for this child FUNCTION.

Parameters
[in]number_in_listThe number of items in the list
[in]listLIST(i). The i'th item in the list
[in]formatThe format to use. Ignored for character lists.
[out]errThe error code
[out]errorThe error string
[in]list_lengthsLIST_LENGTHS(i). Optional, The length of the i'th list item.
Returns
On exit, the character equivalent of the list

Definition at line 523 of file strings.f90.

References base_routines::enters(), base_routines::exits(), and constants::maxstrlen.

character(len=maxstrlen) function strings::list_to_character_dp ( integer(intg), intent(in)  NUMBER_IN_LIST,
real(dp), dimension(number_in_list), intent(in)  LIST,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a double precision list to its equivalent character string representation as determined by the supplied format string.

Parameters
[in]number_in_listThe number of items in the list
[in]listLIST(i). The i'th item in the list
[in]formatThe format to use for the conversion
[out]errThe error code
[out]errorThe error string
Returns
On exit, the character equivalent of the list

Definition at line 799 of file strings.f90.

References base_routines::enters(), base_routines::exits(), constants::maxstrlen, and number_to_character_dp().

character(len=maxstrlen) function strings::list_to_character_intg ( integer(intg), intent(in)  NUMBER_IN_LIST,
integer(intg), dimension(number_in_list), intent(in)  LIST,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts an integer list to its equivalent character string representation as determined by the supplied format.

Parameters
[in]number_in_listThe number of items in the list
[in]listLIST(i). The i'th item in the list
[in]formatThe format to use for the conversion
[out]errThe error code
[out]errorThe error string
Returns
On exit, the character equivalent of the list

Definition at line 593 of file strings.f90.

References base_routines::enters(), base_routines::exits(), constants::maxstrlen, and number_to_character_intg().

character(len=maxstrlen) function strings::list_to_character_l ( integer(intg), intent(in)  NUMBER_IN_LIST,
logical, dimension(number_in_list), intent(in)  LIST,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a logical list to its equivalent character string representation as determined by the supplied format string. The FORMAT is ignored for this child FUNCTION.

Parameters
[in]number_in_listThe number of items in the list
[in]listLIST(i). The i'th item in the list
[in]formatThe format to use. Ignored for logical lists.
[out]errThe error code
[out]errorThe error string
Returns
On exit, the character equivalent of the list

Definition at line 697 of file strings.f90.

References base_routines::enters(), base_routines::exits(), logical_to_character(), and constants::maxstrlen.

character(len=maxstrlen) function strings::list_to_character_lintg ( integer(intg), intent(in)  NUMBER_IN_LIST,
integer(lintg), dimension(number_in_list), intent(in)  LIST,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts an long integer list to its equivalent character string representation as determined by the supplied format.

Parameters
[in]number_in_listThe number of items in the list
[in]listLIST(i). The i'th item in the list
[in]formatThe format to use for the conversion
[out]errThe error code
[out]errorThe error string
Returns
On exit, the character equivalent of the list

Definition at line 645 of file strings.f90.

References base_routines::enters(), base_routines::exits(), constants::maxstrlen, and number_to_character_lintg().

character(len=maxstrlen) function strings::list_to_character_sp ( integer(intg), intent(in)  NUMBER_IN_LIST,
real(sp), dimension(number_in_list), intent(in)  LIST,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a single precision list to its equivalent character string representation as determined by the supplied format string.

Parameters
[in]number_in_listThe number of items in the list
[in]listLIST(i). The i'th item in the list
[in]formatThe format to use for the conversion
[out]errThe error code
[out]errorThe error string
Returns
On exit, the character equivalent of the list

Definition at line 748 of file strings.f90.

References base_routines::enters(), base_routines::exits(), constants::maxstrlen, and number_to_character_sp().

character(len=maxstrlen) function, public strings::logical_to_character ( logical, intent(in)  LOGICALVALUE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Converts a logical value to either a "TRUE" or "FALSE" character string.

Parameters
[in]logicalvalueThe logical value to convert
[out]errThe error code
[out]errorThe error string
Returns
On exit, the character equivalent value

Definition at line 850 of file strings.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by list_to_character_l().

type(varying_string) function, public strings::logical_to_vstring ( logical, intent(in)  LOGICALVALUE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
character(len=maxstrlen) function strings::number_to_character_dp ( real(dp), intent(in)  NUMBER,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a double precision number to its equivalent character string representation as determined by the supplied format string. Note If FORMAT is an asterisk followed by a number between 1 and 32 the format will be chosen to maximise the number of significant digits, e.g., FORMAT="*8" will return a string of 8 characters representing the supplied number in either F8.? or E8.? format depending on its magnitude.

Parameters
[in]numberThe number to convert
[in]formatThe format to use in the conversion
[out]errThe error code
[out]errorThe error string
Returns
On exit, the character equivalent of the number

Definition at line 1072 of file strings.f90.

References base_routines::enters(), base_routines::exits(), and constants::maxstrlen.

Referenced by list_to_character_dp().

character(len=maxstrlen) function strings::number_to_character_intg ( integer(intg), intent(in)  NUMBER,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts an integer number to its equivalent character string representation as determined by the supplied format. The format is of the form of a standard Fortran integer format e.g. "I3".

Parameters
[in]numberThe number to convert
[in]formatThe format to use in the conversion
[out]errThe error code
[out]errorThe error string
Returns
On exit, the character equivalent of the number

Definition at line 908 of file strings.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by list_to_character_intg().

character(len=maxstrlen) function strings::number_to_character_lintg ( integer(lintg), intent(in)  NUMBER,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a long integer number to its equivalent character string representation as determined by the supplied format. The format is of the form of a standard Fortran integer format e.g. "I3".

Parameters
[in]numberThe number to convert
[in]formatThe format to use in the conversion
[out]errThe error code
[out]errorThe error string
Returns
On exit, the character equivalent of the number

Definition at line 944 of file strings.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by list_to_character_lintg().

character(len=maxstrlen) function strings::number_to_character_sp ( real(sp), intent(in)  NUMBER,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a single precision number to its equivalent character string representation as determined by the supplied format string. NOTE: If FORMAT is an asterisk followed by a number between 1 and 32 the format will be chosen to maximise the number of significant digits, e.g., FORMAT="*8" will return a string of 8 characters representing the supplied number in either F8.? or E8.? format depending on its magnitude.

Parameters
[in]numberThe number to convert
[in]formatThe format to use in the conversion
[out]errThe error code
[out]errorThe error string
Returns
On exit, the character equivalent of the number

Definition at line 980 of file strings.f90.

References base_routines::enters(), base_routines::exits(), and constants::maxstrlen.

Referenced by list_to_character_sp().

type(varying_string) function strings::number_to_vstring_dp ( real(dp), intent(in)  NUMBER,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a double precision number to its equivalent varying string representation as determined by the supplied format string. Note If FORMAT is an asterisk followed by a number between 1 and 32 the format will be chosen to maximise the number of significant digits, e.g., FORMAT="*8" will return a string of 8 characters representing the supplied number in either F8.? or E8.? format depending on its magnitude.

Parameters
[in]numberThe number to convert
[in]formatThe format to use in the conversion
[out]errThe error code
[out]errorThe error string
Returns
On exit, the varying string equivalent of the number

Definition at line 1344 of file strings.f90.

References constants::maxstrlen.

type(varying_string) function strings::number_to_vstring_intg ( integer(intg), intent(in)  NUMBER,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts an integer number to its equivalent varying string representation as determined by the supplied format. The format is of the form of a standard Fortran integer format e.g. "I3".

Parameters
[in]numberThe number to convert
[in]formatThe format to use in the conversion
[out]errThe error code
[out]errorThe error string
Returns
On exit, the varying string equivalent of the number

Definition at line 1163 of file strings.f90.

type(varying_string) function strings::number_to_vstring_lintg ( integer(lintg), intent(in)  NUMBER,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a long integer number to its equivalent varying string representation as determined by the supplied format. The format is of the form of a standard Fortran integer format e.g., "I3".

Parameters
[in]numberThe number to convert
[in]formatThe format to use in the conversion
[out]errThe error code
[out]errorThe error string
Returns
On exit, the varying string equivalent of the number

Definition at line 1205 of file strings.f90.

type(varying_string) function strings::number_to_vstring_sp ( real(sp), intent(in)  NUMBER,
character(len=*), intent(in)  FORMAT,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a single precision number to its equivalent varying string representation as determined by the supplied format string. Note If FORMAT is an asterisk followed by a number between 1 and 32 the format will be chosen to maximise the number of significant digits, e.g., FORMAT="*8" will return a string of 8 characters representing the supplied number in either F8.? or E8.? format depending on its magnitude.

Parameters
[in]numberThe number to convert
[in]formatThe format to use in the conversion
[out]errThe error code
[out]errorThe error string
Returns
On exit, the varying string equivalent of the number

Definition at line 1248 of file strings.f90.

References base_routines::enters(), base_routines::exits(), and constants::maxstrlen.

real(dp) function strings::string_to_double_c ( character(len=*), intent(in)  STRING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a character string representation of a number to a double precision number.

Parameters
[in]stringThe string to convert
[out]errThe error code !<The error code
[out]errorThe error string !<The error string
Returns
On exit, the double precision equivalent of the string

Definition at line 1444 of file strings.f90.

References base_routines::enters(), and base_routines::exits().

real(dp) function strings::string_to_double_vs ( type(varying_string), intent(in)  STRING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a varying string representation of a number to a double precision number.

Parameters
[in]stringThe string to convert
[out]errThe error code
[out]errorThe error string
Returns
On exit, the double precision equivalent of the string

Definition at line 1470 of file strings.f90.

References base_routines::enters(), and base_routines::exits().

integer(intg) function strings::string_to_integer_c ( character(len=*), intent(in)  STRING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a character string representation of a number to an integer.

Parameters
[in]stringThe string to convert
[out]errThe error code
[out]errorThe error string
Returns
On exit, the integer equivalent of the string

Definition at line 1500 of file strings.f90.

References base_routines::enters(), and base_routines::exits().

integer(intg) function strings::string_to_integer_vs ( type(varying_string), intent(in)  STRING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a varying string representation of a number to an integer.

Parameters
[in]stringThe string to convert
[out]errThe error code
[out]errorThe error string
Returns
On exit, the integer equivalent of the string

Definition at line 1526 of file strings.f90.

References base_routines::enters(), and base_routines::exits().

logical function strings::string_to_logical_c ( character(len=*), intent(in)  STRING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a character string representation of a boolean (TRUE or FALSE) to a logical.

Parameters
[in]stringThe string to convert
[out]errThe error code
[out]errorThe error string
Returns
On exit, the logical equivalent of the string

Definition at line 1612 of file strings.f90.

References base_routines::enters(), and base_routines::exits().

logical function strings::string_to_logical_vs ( type(varying_string), intent(in)  STRING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a varying string representation of a boolean (TRUE or FALSE) to a logical.

Parameters
[in]stringThe string to convert
[out]errThe error code
[out]errorThe error string
Returns
On exit, the logical equivalent of the string

Definition at line 1638 of file strings.f90.

References base_routines::enters(), and base_routines::exits().

integer(lintg) function strings::string_to_long_integer_c ( character(len=*), intent(in)  STRING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a character string representation of a number to a long integer.

Parameters
[in]stringThe string to convert
[out]errThe error code
[out]errorThe error string
Returns
On exit, the long integer equivalent of the string

Definition at line 1556 of file strings.f90.

References base_routines::enters(), and base_routines::exits().

integer(lintg) function strings::string_to_long_integer_vs ( type(varying_string), intent(in)  STRING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a varying string representation of a number to a long integer.

Parameters
[in]stringThe string to convert
[out]errThe error code
[out]errorThe error string
Returns
On exit, the long integer equivalent of the string

Definition at line 1582 of file strings.f90.

References base_routines::enters(), and base_routines::exits().

real(sp) function strings::string_to_single_c ( character(len=*), intent(in)  STRING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a character string representation of a number to a single precision number.

Parameters
[in]stringThe string to convert
[out]errThe error code
[out]errorThe error string
Returns
On exit, the single precision equivalent of the string

Definition at line 1666 of file strings.f90.

References base_routines::enters(), and base_routines::exits().

real(sp) function strings::string_to_single_vs ( type(varying_string), intent(in)  STRING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Converts a varying string representation of a number to a single precision number.

Parameters
[in]stringThe string to convert
[out]errThe error code
[out]errorThe error string
Returns
On exit, the single precision equivalent of the string

Definition at line 1692 of file strings.f90.

References base_routines::enters(), and base_routines::exits().

type(varying_string) function strings::vstring_to_lowercase_c ( character(len=*), intent(in)  STRING)
private

Returns a varying string that is the lowercase equivalent of the supplied character string.

Parameters
[in]stringThe string to convert
Returns
On exit, the lowercase equivalent of the string

Definition at line 1772 of file strings.f90.

References is_uppercase().

type(varying_string) function strings::vstring_to_lowercase_vs ( type(varying_string), intent(in)  STRING)
private

Returns a varying string that is the lowercase equivalent of the supplied varying string.

Parameters
[in]stringThe string to convert
Returns
On exit, the lowercase equivalent of the string

Definition at line 1797 of file strings.f90.

References is_uppercase().

type(varying_string) function strings::vstring_to_uppercase_c ( character(len=*), intent(in)  STRING)
private

Returns a varying string which is uppercase equivalent of the supplied character string.

Parameters
[in]stringThe string to convert
Returns
On exit, the uppercase equivalent of the string

Definition at line 1872 of file strings.f90.

References is_lowercase().

type(varying_string) function strings::vstring_to_uppercase_vs ( type(varying_string), intent(in)  STRING)
private

Returns a varying string which is uppercase equivalent of the supplied varying string.

Parameters
[in]stringThe string to convert
Returns
On exit, the uppercase equivalent of the string

Definition at line 1897 of file strings.f90.

References is_lowercase().