any

Date:

10-12-2011

NAME

ANY - Determines whether any values are true in MASK along dimension DIM

SYNOPSIS

ANY ([MASK=]mask [,[DIM=]dim])

STANDARDS

Fortran

DESCRIPTION

The ANY intrinsic function determines whether any value is true in argument mask along dimension dim. It accepts the following arguments:

mask

Must be of type logical. It must not be a scalar.

dim

Must be a scalar. It must be an integer value in the range 1 <= dim <= n, where n is the rank of mask. The corresponding actual argument must not be an optional dummy argument.

ANY is a transformational function. The name of this intrinsic cannot be passed as an argument.

RETURN VALUES

The result is type logical with the same kind type parameter as MASK. It is a scalar result if dim is absent or if mask has rank one. Otherwise, the result is an array of rank n-1 and of shape

(d1, d2, ..., ddim-1, ddim+1, ..., dn)

where

(d1, d2, ..., dn)

is the shape of mask.

The result of ANY(mask) has the value TRUE if any element of mask is true. The result has the value FALSE if no elements of mask are true or if mask is a zero-sized array.

If mask has rank one, ANY(mask,dim) has a value equal to that of ANY(mask). Otherwise, the value of element

(s1, s2, ..., sdim-1, sdim+1, ..., sn)

of ANY(mask,di) is equal to

ANY(mask (s1, s2, ..., sdim-1, : ,sdim+1, ..., sn) )

EXAMPLES

Example 1:

  • ANY((.TRUE.,.FALSE.,.TRUE.)) yields .TRUE..

  • ANY( mask ) yields .FALSE. when mask is a zero-sized array.

Example 2: Assume that B and C are arrays as follows:

B is the following array:

| 1 3 5 |
| 2 4 6 |

C is the following array:

| 0 3 5 |
| 7 4 8 |

  • ANY(B.NE.C) yields .TRUE..

  • ANY(B.NE.C,DIM=1) yields [.TRUE.,.FALSE.,.TRUE.].

  • ANY(B.NE.C,DIM=2) yields [.TRUE.,.TRUE.].

  • ANY(C.EQ.1) yields [.FALSE.] because no elements of the mask are true.

Example 3: Assume that array N is as follows:

| 0 1 2 3 |
| 4 5 6 7 |
| 8 9 0 1 |

In an array section reference, you can expect the following results:

  • ANY((N(2:3,2:4).NE.0)) yields [.TRUE.].

  • ANY((N(2:3,2:4).NE.0),DIM=1) yields [.TRUE.,.TRUE.,.TRUE.].

  • ANY((N(2:3,2:4).NE.0),DIM=2) yields [.TRUE.,.TRUE.].