FLOOR

The FLOOR function returns the closest integer less than or equal to its argument.

Syntax

Result = FLOOR(X [, /L64 ] )

Return Value

If the input argument X is an integer type, Result has the same value and type as X. Otherwise, Result is a 32-bit longword integer with the same structure as X.

Arguments

X

The value for which the FLOOR function is to be evaluated. This value can be any numeric type (integer, floating, or complex).

Keywords

L64

If set, the result type is 64-bit integer regardless of the input type. This is useful for situations in which a floating point number contains a value too large to be represented in a 32-bit integer.

Thread Pool Keywords

This routine is written to make use of IDL's thread pool, which can increase execution speed on systems with multiple CPUs. The values stored in the !CPU system variable control whether IDL uses the thread pool for a given computation. In addition, you can use the thread pool keywords TPOOL_MAX_ELTS, TPOOL_MIN_ELTS, and TPOOL_NOTHREAD to override the defaults established by !CPU for a single invocation of this routine. See Thread Pool Keywords for details.

Examples

To print the floor function of 5.9, enter:

PRINT, FLOOR(5.9) 
; IDL prints: 
5 

To print the floor function of 3000000000.1, the result of which is too large to represent in a 32-bit integer:

PRINT, FLOOR(3000000000.1D, /L64) 
; IDL prints: 
3000000000 

Version History

Introduced: Pre 4.0

See Also

CEIL, COMPLEXROUND, ROUND