Share via

2.5.4.40 Floor

  • Article

The Floor function performs a floor calculation.

ABNF:

 Floor = val [val] sp ("1" / "2") ";FLOOR():129"

Required Arguments:

Name: Number

Type: vDouble

An argument that specifies the value to be rounded.

Optional Arguments:

Name: Multiple

Type: vDouble

An argument that specifies the rounding increment.

Return Value:

Type: vNum, PtgErr

If Multiple is not specified, the function returns a vNum containing the largest integer less than or equal to Number. If Multiple is greater than zero, the function returns a vNum containing the largest multiple of Multiple less than or equal to Number. If Multiple is less than zero, the function returns a vNum containing the smallest multiple of Multiple greater than or equal to Number. If Number is equal to zero or Multiple is equal to zero, the value is zero. The unit of the return value is equal to the unit of Number. If Number and Multiple do not have the same sign, the function returns a PtgErr with an error code of #NUM!.