flintmax

Largest consecutive integer in floating-point format

Syntax

f = flintmax

f = flintmax(precision)

f = flintmax("like",p)

Description

f = flintmax returns the largest consecutive integer in IEEE^® double precision, which is 2^53. Above this value, double-precision format does not have integer precision, and not all integers can be represented exactly.

f = flintmax(precision) returns the largest consecutive integer in IEEE single or double precision. flintmax returns single(2^24) for single precision and 2^53 for double precision.

f = flintmax("like",p) returns the largest consecutive integer with the same data type, sparsity, and complexity (real or complex) as the floating-point variable p.

Examples

Double Precision

Return the largest consecutive integer in IEEE® double precision, 2^53.

format long e
f = flintmax

f = 
     9.007199254740992e+15

Single Precision

Return the largest consecutive integer in IEEE® single precision, single(2^24).

f = flintmax("single")

f = single

16777216

Check the class of f.

class(f)

ans = 
'single'

Limit of Integer Single Precision

Above the value returned by flintmax("single"), not all integers can be represented exactly with single precision.

Return the largest consecutive integer in IEEE® single precision, single(2^24).

f = flintmax("single")

f = single

16777216

Add 1 to the value returned from flintmax.

f1 = f+1

f1 = single

16777216

f1 is the same as f.

isequal(f,f1)

ans = logical
   1

Add 2 to the value returned from flintmax. The number 16777218 is represented exactly in single precision while 16777217 is not.

f2 = f+2

f2 = single

16777218

Specify Data Type and Complexity from Existing Array

Return the largest consecutive integer with the same data type and complexity as an existing array.

First, create a complex vector of single data type.

p = single([0.12+2i -0.5i 3]);

Return the largest consecutive integer as a scalar that is complex like p.

f = flintmax("like",p)

f = single

1.6777e+07 +0.0000e+00i

Input Arguments

precision — Floating-point precision type

"double" (default) | "single"

Floating-point precision type, specified as "double" or "single".

Data Types: char

p — Prototype

floating-point variable

Prototype, specified as a floating-point variable.

Data Types: double | single
Complex Number Support: Yes

Output Arguments

f — Largest consecutive integer in floating-point format

scalar constant

Largest consecutive integer in floating-point format returned as a scalar constant. This constant is 2^53 for double precision and single(2^24) for single precision.

Extended Capabilities

Tall Arrays

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

This function supports tall arrays with the limitations:

• The supported syntax is flintmax("like",p), where the underlying data type of p must be a floating-point type.

For more information, see Tall Arrays.

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

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

This function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

GPU Arrays

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

The flintmax function supports GPU array input with these usage notes and limitations:

• The supported syntax is flintmax("like",p), where the underlying data type of p must be a floating-point type.

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™.

Usage notes and limitations:

• The supported syntax is flintmax("like",p), where the underlying data type of p must be a floating-point type.

For more information, see Run MATLAB Functions with Distributed Arrays (Parallel Computing Toolbox).

Version History

Introduced in R2013a