OpenCMISS-Iron Internal API Documentation
strings::number_to_vstring Interface Reference

Converts a number to its equivalent varying string representation. More...

Private Member Functions

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...
 

Detailed Description

Converts a number to its equivalent varying string representation.

Definition at line 161 of file strings.f90.

Member Function/Subroutine Documentation

type(varying_string) function strings::number_to_vstring::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.

type(varying_string) function strings::number_to_vstring::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::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::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.