FortranLib Type

Constructors

Constructor Description

FortranLib()

Full Usage: FortranLib()

Instance members

Instance member Description

this.ADJUSTR

Full Usage: this.ADJUSTR

Parameters:
    s : string -

Returns: string

ADJUSTR(STRING) Adjust to the right, removing trailing blanks and inserting leading blanks. Argument Type and Attributes STRING must be of type character. Class Elemental function Result Type and Attributes Character of the same length and kind type parameter as STRING. Result Value The value of the result is the same as STRING except that any trailing blanks have been deleted and the same number of leading blanks have been inserted. Examples ADJUSTR (’WORDb’) has the value ’bWORD’.

IBM XL Fortran for AIX

s : string

Returns: string

Static members

Static member Description

FortranLib.ADJUSTL(s)

Full Usage: FortranLib.ADJUSTL(s)

Parameters:
    s : string -

Returns: string

ADJUSTL(STRING) Adjust to the left, removing leading blanks and inserting trailing blanks. Argument Type and Attributes STRING must be of type character. Class Elemental function Result Type and Attributes Character of the same length and kind type parameter as STRING. Result Value The value of the result is the same as STRING except that any leading blanks have been deleted and the same number of trailing blanks have been inserted. Examples ADJUSTL (’bWORD’) has the value ’WORDb’.

IBM XL Fortran for AIX

s : string

Returns: string

FortranLib.AMod(a1, a2)

Full Usage: FortranLib.AMod(a1, a2)

Parameters:
    a1 : float32 - A divisor.
    a2 : float32 - A dividend.

Returns: float32 A number equal to x - (y Q), where Q = Math.Truncate(x/y)

Summary: Returns the remainder resulting from the division of a specified number by another specified number. Parameters: y: A divisor. x: A dividend. Returns: A number equal to x - (y Q), where Q = Math.Truncate(x/y)

a1 : float32

A divisor.

a2 : float32

A dividend.

Returns: float32

A number equal to x - (y Q), where Q = Math.Truncate(x/y)

FortranLib.Copy(destinationString, startIndex, lastIndex, sourceString)

Full Usage: FortranLib.Copy(destinationString, startIndex, lastIndex, sourceString)

Parameters:
    destinationString : byref<string>
    startIndex : int
    lastIndex : int
    sourceString : string

destinationString : byref<string>
startIndex : int
lastIndex : int
sourceString : string

FortranLib.Copy(destinationString, startIndex, lastIndex, source)

Full Usage: FortranLib.Copy(destinationString, startIndex, lastIndex, source)

Parameters:
    destinationString : byref<string>
    startIndex : int
    lastIndex : int
    source : char

destinationString : byref<string>
startIndex : int
lastIndex : int
source : char

FortranLib.Copy(destinationString, startIndex, sourceString)

Full Usage: FortranLib.Copy(destinationString, startIndex, sourceString)

Parameters:
    destinationString : byref<string>
    startIndex : int
    sourceString : string

destinationString : byref<string>
startIndex : int
sourceString : string

FortranLib.Copy(destinationString, sourceString)

Full Usage: FortranLib.Copy(destinationString, sourceString)

Parameters:
    destinationString : byref<string>
    sourceString : string

destinationString : byref<string>
sourceString : string

FortranLib.Copy(destinationArray, startIndex, lastIndex, sourceArray)

Full Usage: FortranLib.Copy(destinationArray, startIndex, lastIndex, sourceArray)

Parameters:
    destinationArray : char[]
    startIndex : int
    lastIndex : int
    sourceArray : char[]

destinationArray : char[]
startIndex : int
lastIndex : int
sourceArray : char[]

FortranLib.Copy(destinationArray, startIndex, sourceArray)

Full Usage: FortranLib.Copy(destinationArray, startIndex, sourceArray)

Parameters:
    destinationArray : char[]
    startIndex : int
    sourceArray : char[]

destinationArray : char[]
startIndex : int
sourceArray : char[]

FortranLib.Copy(destination, startIndex, lastIndex, source)

Full Usage: FortranLib.Copy(destination, startIndex, lastIndex, source)

Parameters:

destination : Characters
startIndex : int
lastIndex : int
source : Characters

FortranLib.Copy(destination, startIndex, source)

Full Usage: FortranLib.Copy(destination, startIndex, source)

Parameters:

destination : Characters
startIndex : int
source : Characters

FortranLib.Copy(destination, source)

Full Usage: FortranLib.Copy(destination, source)

Parameters:

destination : Characters
source : Characters

FortranLib.Copy(destination, startIndex, lastIndex, source)

Full Usage: FortranLib.Copy(destination, startIndex, lastIndex, source)

Parameters:
    destination : Characters
    startIndex : int
    lastIndex : int
    source : string

destination : Characters
startIndex : int
lastIndex : int
source : string

FortranLib.Copy(destination, startIndex, source)

Full Usage: FortranLib.Copy(destination, startIndex, source)

Parameters:
    destination : Characters
    startIndex : int
    source : string

destination : Characters
startIndex : int
source : string

FortranLib.Copy(destination, source)

Full Usage: FortranLib.Copy(destination, source)

Parameters:

destination : Characters
source : string

FortranLib.DMod(a1, a2)

Full Usage: FortranLib.DMod(a1, a2)

Parameters:
    a1 : float - A divisor.
    a2 : float - A dividend.

Returns: float A number equal to x - (y Q), where Q = Math.Truncate(x/y)

Summary: Returns the remainder resulting from the division of a specified number by another specified number. Parameters: y: A divisor. x: A dividend. Returns: A number equal to x - (y Q), where Q = Math.Truncate(x/y)

a1 : float

A divisor.

a2 : float

A dividend.

Returns: float

A number equal to x - (y Q), where Q = Math.Truncate(x/y)

FortranLib.INDEX(s, value, back)

Full Usage: FortranLib.INDEX(s, value, back)

Parameters:
    s : string -
    value : string -
    back : bool -

Returns: int

INDEX INDEX(STRING, SUBSTRING, BACK) Returns the starting position of a substring within a string. Argument Type and Attributes STRING must be of type character. SUBSTRING must be of type character with the same kind type parameter as STRING. BACK (optional) must be of type logical. Class Elemental function Result Type and Attributes Default integer. Result Value v Case (i): If BACK is absent or present with the value .FALSE., the result is the minimum positive value of I such that STRING (I : I + LEN (SUBSTRING) - 1) = SUBSTRING or zero if there is no such value. Zero is returned if LEN (STRING) .LT. LEN (SUBSTRING). One is returned if LEN (SUBSTRING) = 0. v Case (ii): If BACK is present with the value .TRUE., the result is the maximum value of I less than or equal to LEN (STRING) - LEN (SUBSTRING) + 1, such that STRING (I : I + LEN (SUBSTRING) - 1) = SUBSTRING or zero if there is no such value. Zero is returned if LEN (STRING) .LT. LEN (SUBSTRING) and LEN (STRING) + 1 is returned if LEN (SUBSTRING) = 0. Examples INDEX (’FORTRAN’, ’R’) has the value 3. INDEX (’FORTRAN’, ’R’, BACK = .TRUE.) has the value 5.

IBM XL Fortran for AIX

s : string

value : string

back : bool

Returns: int

FortranLib.INDEX(s, value)

Full Usage: FortranLib.INDEX(s, value)

Parameters:
    s : string
    value : string

Returns: int

s : string
value : string
Returns: int

FortranLib.INDEX(chars, value, back)

Full Usage: FortranLib.INDEX(chars, value, back)

Parameters:
Returns: int

chars : Characters
value : string
back : bool
Returns: int

FortranLib.INDEX(chars, value)

Full Usage: FortranLib.INDEX(chars, value)

Parameters:
Returns: int

chars : Characters
value : string
Returns: int

FortranLib.INDEX(chars, value, back)

Full Usage: FortranLib.INDEX(chars, value, back)

Parameters:
Returns: int

chars : Characters
value : Characters
back : bool
Returns: int

FortranLib.INDEX(chars, value)

Full Usage: FortranLib.INDEX(chars, value)

Parameters:
Returns: int

chars : Characters
value : Characters
Returns: int

FortranLib.LEN_TRIM(s)

Full Usage: FortranLib.LEN_TRIM(s)

Parameters:
    s : string -

Returns: int

LEN_TRIM Description: Returns the length of the character argument without counting trailing blank characters. Syntax: result = LEN_TRIM (string [, kind]) Class: Elemental function; Generic Arguments: string Must be of type character. kind (opt) Must be a scalar integer initialization expression. Examples LEN_TRIM (' C D ') has the value 7. LEN_TRIM (' ') has the value 0.

From Intel Fortran Language Reference

s : string

Returns: int

FortranLib.LEN_TRIM(chars)

Full Usage: FortranLib.LEN_TRIM(chars)

Parameters:
Returns: int

chars : Characters
Returns: int

FortranLib.Mod(a1, a2)

Full Usage: FortranLib.Mod(a1, a2)

Parameters:
    a1 : int - A divisor.
    a2 : int - A dividend.

Returns: int A number equal to x - (y Q), where Q = Math.Truncate(x/y)

Summary: Returns the remainder resulting from the division of a specified number by another specified number. Parameters: y: A divisor. x: A dividend. Returns: A number equal to x - (y Q), where Q = Math.Truncate(x/y)

a1 : int

A divisor.

a2 : int

A dividend.

Returns: int

A number equal to x - (y Q), where Q = Math.Truncate(x/y)

FortranLib.REPEAT(s, ncopies)

Full Usage: FortranLib.REPEAT(s, ncopies)

Parameters:
    s : string -
    ncopies : int -

Returns: string

REPEAT Description: Concatenates several copies of a string. Syntax: result = REPEAT (string, ncopies) Class: Transformational function; Generic Arguments: string Must be scalar and of type character. ncopies Must be scalar and of type integer. It must not be negative. Results: The result is a scalar of type character and length ncopies x LEN(string). The kind parameter is the same as string. The value of the result is the concatenation of ncopies copies of string. Examples REPEAT ('S', 3) has the value SSS. REPEAT ('ABC', 0) has the value of a zero-length string.

From Intel Fortran Language Reference

s : string

ncopies : int

Returns: string

FortranLib.SCAN(s, set, back)

Full Usage: FortranLib.SCAN(s, set, back)

Parameters:
    s : string -
    set : string -
    back : bool -

Returns: int

SCAN(STRING, SET, BACK) Scan a string for any one of the characters in a set of characters. Argument Type and Attributes STRING must be of type character. SET must be of type character with the same kind type parameter as STRING. BACK (optional) must be of type logical. Class Elemental function Result Type and Attributes Default integer. Result Value v Case (i): If BACK is absent or is present with the value .FALSE. and if STRING contains at least one character that is in SET, the value of the result is the position of the leftmost character of STRING that is in SET. v Case (ii): If BACK is present with the value .TRUE. and if STRING contains at least one character that is in SET, the value of the result is the position of the rightmost character of STRING that is in SET. v Case (iii): The value of the result is zero if no character of STRING is in SET or if the length of STRING or SET is zero. Examples v Case (i): SCAN (’FORTRAN’, ’TR’) has the value 3. v Case (ii): SCAN (’FORTRAN’, ’TR’, BACK = .TRUE.) has the value 5. v Case (iii): SCAN (’FORTRAN’, ’BCD’) has the value 0.

IBM XL Fortran for AIX

s : string

set : string

back : bool

Returns: int

FortranLib.SCAN(s, set)

Full Usage: FortranLib.SCAN(s, set)

Parameters:
    s : string
    set : string

Returns: int

s : string
set : string
Returns: int

FortranLib.SCAN(charArray, set, back)

Full Usage: FortranLib.SCAN(charArray, set, back)

Parameters:
Returns: int

charArray : Characters
set : string
back : bool
Returns: int

FortranLib.SCAN(charArray, set)

Full Usage: FortranLib.SCAN(charArray, set)

Parameters:
Returns: int

charArray : Characters
set : string
Returns: int

FortranLib.Sign(a1, a2)

Full Usage: FortranLib.Sign(a1, a2)

Parameters:
    a1 : int
    a2 : int

Returns: int Returns |a1| if a2>= 0, Returns -|a1| if a2<0

Transfer of sign Returns |a1| if a2>= 0 Returns -|a1| if a2<0

a1 : int
a2 : int
Returns: int

Returns |a1| if a2>= 0, Returns -|a1| if a2<0

FortranLib.Sign(a1, a2)

Full Usage: FortranLib.Sign(a1, a2)

Parameters:
    a1 : float32
    a2 : float32

Returns: float32 Returns |a1| if a2>= 0, Returns -|a1| if a2<0

Transfer of sign Returns |a1| if a2>= 0 Returns -|a1| if a2<0

a1 : float32
a2 : float32
Returns: float32

Returns |a1| if a2>= 0, Returns -|a1| if a2<0

FortranLib.Sign(a1, a2)

Full Usage: FortranLib.Sign(a1, a2)

Parameters:
    a1 : float
    a2 : float

Returns: float Returns |a1| if a2>= 0, Returns -|a1| if a2<0

Transfer of sign Returns |a1| if a2>= 0 Returns -|a1| if a2<0

a1 : float
a2 : float
Returns: float

Returns |a1| if a2>= 0, Returns -|a1| if a2<0

FortranLib.Substring(s, startIndex, lastIndex)

Full Usage: FortranLib.Substring(s, startIndex, lastIndex)

Parameters:
    s : string
    startIndex : int
    lastIndex : int

Returns: string

s : string
startIndex : int
lastIndex : int
Returns: string

FortranLib.Substring(s, startIndex)

Full Usage: FortranLib.Substring(s, startIndex)

Parameters:
    s : string
    startIndex : int

Returns: string

s : string
startIndex : int
Returns: string

FortranLib.Substring(s, startIndex, lastIndex)

Full Usage: FortranLib.Substring(s, startIndex, lastIndex)

Parameters:
    s : char[] -
    startIndex : int -
    lastIndex : int -

Returns: char[]

Retrieves a substring . The substring starts at a specified character position and finisch a specified position.

s : char[]

startIndex : int

lastIndex : int

Returns: char[]

FortranLib.Substring(s, startIndex)

Full Usage: FortranLib.Substring(s, startIndex)

Parameters:
    s : char[] -
    startIndex : int -

Returns: char[]

Retrieves a substring . The substring starts at a specified character position.

s : char[]

startIndex : int

Returns: char[]