Define Generic Operators

Intel® Fortran Compiler Classic and Intel® Fortran Compiler Developer Guide and Reference

Download PDF

ID 767251

Date 6/24/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-D95E20C1-2B57-4709-A3C9-8A65E6E32BF5

View Details

Define Generic Operators

An interface block or a GENERIC statement can be used to define a generic operator. The only procedures allowed in the interface block are functions that can be referenced as defined operations.

The initial line for such an interface block takes the following form:

INTERFACE OPERATOR (op)

`op`	Is one of the following: A defined unary operator (one argument) A defined binary operator (two arguments) An extended intrinsic operator (number of arguments must be consistent with the intrinsic uses of that operator)

The functions within the interface block must have one or two nonoptional arguments with the INTENT(IN) and/or the VALUE attribute, and the function result must not be of type character with assumed length. A defined operation is treated as a reference to the function.

The following shows the form (and an example) of a defined unary and defined binary operation:

Operation	Form	Example
Defined Unary	.defined-operator. operand^¹	.MINUS. C
Defined Binary	operand^² .defined-operator. operand^³	B .MINUS. C
¹ The operand corresponds to the function's dummy argument. ² The left operand corresponds to the first dummy argument of the function. ³ The right operand corresponds to the second argument.

Operation

Form

Example

Defined Unary

.defined-operator. operand^¹

.MINUS. C

Defined Binary

operand^² .defined-operator. operand^³

B .MINUS. C

¹ The operand corresponds to the function's dummy argument.

² The left operand corresponds to the first dummy argument of the function.

³ The right operand corresponds to the second argument.

For intrinsic operator symbols, the generic properties include the intrinsic operations they represent. Both forms of each relational operator have the same interpretation, so extending one form (such as >=) defines both forms (>= and .GE.).

The following is an example of a procedure interface block defining a new operator:

  INTERFACE OPERATOR(.BAR.)
    FUNCTION BAR(A_1)
      INTEGER, INTENT(IN) :: A_1
      INTEGER :: BAR
    END FUNCTION BAR
  END INTERFACE

The following example shows a way to reference function BAR by using the new operator:

  INTEGER B
  I = 4 + (.BAR. B)

The following is an example of a procedure interface block with a defined operator extending an existing operator:

  INTERFACE OPERATOR(+)
    FUNCTION LGFUNC (A, B)
      LOGICAL, INTENT(IN) :: A(:), B(SIZE(A))
      LOGICAL :: LGFUNC(SIZE(A))
    END FUNCTION LGFUNC
  END INTERFACE

The following example shows two equivalent ways to reference function LGFUNC:

  LOGICAL, DIMENSION(1:10) :: C, D, E
  N = 10
  E = LGFUNC(C(1:N), D(1:N))
  E = C(1:N) + D(1:N)

The following generic statement extends the operator + to include the function MY_SUM. There must be a an accessible explicit interface for MY_SUM.

  GENERIC :: OPERATOR(+)=> MY_SUM

Parent topic: Procedure Interfaces

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Intel® Fortran Compiler Classic and Intel® Fortran Compiler Developer Guide and Reference

Define Generic Operators

See Also