floor

Round toward negative infinity

Syntax

Y = floor(X)

Y = floor(t)

Y = floor(t,unit)

Description

Y = floor(X) rounds each element of X to the nearest integer less than or equal to that element.

Y = floor(t) rounds each element of the duration array t to the nearest number of seconds less than or equal to that element.

Y = floor(t,unit) rounds each element of t to the nearest number of the specified unit of time less than or equal to that element.

Examples

Round Matrix Elements Toward Negative Infinity

X = [-1.9  -0.2  3.4;  5.6  7.0  2.4+3.6i];
Y = floor(X)

Y = 2×3 complex

  -2.0000 + 0.0000i  -1.0000 + 0.0000i   3.0000 + 0.0000i
   5.0000 + 0.0000i   7.0000 + 0.0000i   2.0000 + 3.0000i

Round Duration Values Toward Negative Infinity

Round each value in a duration array to the nearest number of seconds less than or equal to that value.

t = hours(8) + minutes(29:31) + seconds(1.23);
t.Format = 'hh:mm:ss.SS'

t = 1×3 duration
   08:29:01.23   08:30:01.23   08:31:01.23

Y1 = floor(t)

Y1 = 1×3 duration
   08:29:01.00   08:30:01.00   08:31:01.00

Round each value in t to the nearest number of hours less than or equal to that value.

Y2 = floor(t,'hours')

Y2 = 1×3 duration
   08:00:00.00   08:00:00.00   08:00:00.00

Input Arguments

X — Input array

scalar | vector | matrix | multidimensional array | table | timetable

Input array, specified as a scalar, vector, matrix, multidimensional array, table, or timetable. For complex X, floor treats the real and imaginary parts independently.

floor converts logical and char elements of X into double values.

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

t — Input duration

duration array

Input duration, specified as a duration array.

unit — Unit of time

'seconds' (default) | 'minutes' | 'hours' | 'days' | 'years'

Unit of time, specified as 'seconds', 'minutes', 'hours', 'days', or 'years'. A duration of 1 year is equal to exactly 365.2425 24-hour days.

Extended Capabilities

Tall Arrays

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

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

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

GPU Code Generation
Generate CUDA® code for NVIDIA® GPUs using GPU 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 floor 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 before R2006a

R2023a: Perform calculations directly on tables and timetables

The floor function can calculate on all variables within a table or timetable without indexing to access those variables. All variables must have data types that support the calculation. For more information, see Direct Calculations on Tables and Timetables.