stdlib_optval#

See also the specification page: stdlib_optval.

stdlib_optval (module)#

Provides a generic function optval, which can be used to conveniently implement fallback values for optional arguments to subprograms (Specification: stdlib_optval)

If x is an optional parameter of a subprogram, then the expression optval(x, default) inside that subprogram evaluates to x if it is present, otherwise default.

It is an error to call optval with a single actual argument.

Interfaces

optval (interface)#

optval (interface)

Fallback value for optional arguments (Specification: stdlib_optval)

Procedures:

Procedures

optval_rsp (function)#

pure elemental function optval_rsp(x, default) -> y
Arguments:
xreal(kind=sp), intent(in), optional
defaultreal(kind=sp), intent(in)
Returns:
yreal(kind=sp)

optval_rdp (function)#

pure elemental function optval_rdp(x, default) -> y
Arguments:
xreal(kind=dp), intent(in), optional
defaultreal(kind=dp), intent(in)
Returns:
yreal(kind=dp)

optval_iint8 (function)#

pure elemental function optval_iint8(x, default) -> y
Arguments:
xinteger(kind=int8), intent(in), optional
defaultinteger(kind=int8), intent(in)
Returns:
yinteger(kind=int8)

optval_iint16 (function)#

pure elemental function optval_iint16(x, default) -> y
Arguments:
xinteger(kind=int16), intent(in), optional
defaultinteger(kind=int16), intent(in)
Returns:
yinteger(kind=int16)

optval_iint32 (function)#

pure elemental function optval_iint32(x, default) -> y
Arguments:
xinteger(kind=int32), intent(in), optional
defaultinteger(kind=int32), intent(in)
Returns:
yinteger(kind=int32)

optval_iint64 (function)#

pure elemental function optval_iint64(x, default) -> y
Arguments:
xinteger(kind=int64), intent(in), optional
defaultinteger(kind=int64), intent(in)
Returns:
yinteger(kind=int64)

optval_csp (function)#

pure elemental function optval_csp(x, default) -> y
Arguments:
xcomplex(kind=sp), intent(in), optional
defaultcomplex(kind=sp), intent(in)
Returns:
ycomplex(kind=sp)

optval_cdp (function)#

pure elemental function optval_cdp(x, default) -> y
Arguments:
xcomplex(kind=dp), intent(in), optional
defaultcomplex(kind=dp), intent(in)
Returns:
ycomplex(kind=dp)

optval_ll1 (function)#

pure elemental function optval_ll1(x, default) -> y
Arguments:
xlogical, intent(in), optional
defaultlogical, intent(in)
Returns:
ylogical

optval_character (function)#

pure function optval_character(x, default) -> y
Arguments:
xcharacter(len=*), intent(in), optional
defaultcharacter(len=*), intent(in)
Returns:
ycharacter(len=:), allocatable