allfinite

Determine if all array elements are finite

Since R2022a

Syntax

TF = allfinite(A)

Description

TF = allfinite(A) returns logical 1 (true) if all elements of A are finite. It returns 0 (false) if any element is not finite.

If A contains complex numbers, allfinite(A) returns 1 if all elements have finite real and imaginary parts, and 0 otherwise.

Examples

Determine If All Vector Elements Are Finite

Create a row vector and determine if all elements are finite.

A = 1./[-2 -1 1e-23 0.1]

A = 1×4
1023 ×

   -0.0000   -0.0000    1.0000    0.0000

TF = allfinite(A)

TF = logical
   1

Create another row vector and determine if all elements are finite.

B = 0./[-2 -1 0 0.1]

B = 1×4

     0     0   NaN     0

TF = allfinite(B)

TF = logical
   0

Determine If All Matrix Elements Are Finite

Create a matrix and determine if all elements are finite.

A = [0 0 3;0 0 3;0 0 NaN]

A = 3×3

     0     0     3
     0     0     3
     0     0   NaN

TF = allfinite(A)

TF = logical
   0

Determine If All Array Elements Are Finite

Create a 3-D array and determine if all elements are finite.

A(:,:,1) = [2 1; 3 5];
A(:,:,2) = [0 0; 0 Inf];
A(:,:,3) = [-2 9; 4 1]

A = 
A(:,:,1) =

     2     1
     3     5


A(:,:,2) =

     0     0
     0   Inf


A(:,:,3) =

    -2     9
     4     1

TF = allfinite(A)

TF = logical
   0

Determine If All Complex Elements Are Finite

Create a vector of complex numbers. Determine if all elements are finite.

A = [2+3i 3/0+1i -2i]

A = 1×3 complex

   2.0000 + 3.0000i      Inf + 1.0000i   0.0000 - 2.0000i

TF = allfinite(A)

TF = logical
   0

allfinite(A) returns 0 because the second element of A has a real part that is infinite.

Input Arguments

A — Input array

scalar | vector | matrix | multidimensional array

Input array, specified as a scalar, vector, matrix, or multidimensional array.

Example: [pi NaN Inf -Inf]

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char | datetime | duration | calendarDuration
Complex Number Support: Yes

Extended Capabilities

Tall Arrays

Calculate with arrays that have more rows than fit in memory.

The allfinite function fully supports tall arrays. For more information, see Tall Arrays.

C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.

GPU Arrays

Accelerate code by running on a graphics processing unit (GPU) using Parallel Computing Toolbox™.

The allfinite function fully supports GPU arrays. To run the function on a GPU, specify the input data as a gpuArray (Parallel Computing Toolbox). For more information, see Run MATLAB Functions on a GPU (Parallel Computing Toolbox).

Distributed Arrays

Partition large arrays across the combined memory of your cluster using Parallel Computing Toolbox™.

This function fully supports distributed arrays. For more information, see Run MATLAB Functions with Distributed Arrays (Parallel Computing Toolbox).

Version History

Introduced in R2022a