Puppet Function: floor

Defined in:
vendor_modules/stdlib/lib/puppet/parser/functions/floor.rb
Function type:
Ruby 3.x API

Summary

Returns the largest integer less or equal to the argument.

Overview

floor() ⇒ Any

Takes a single numeric value as an argument.

> *Note:* *Deprecated* from Puppet 6.0.0, this function has been replaced with a built-in [`floor`](puppet.com/docs/puppet/latest/function.html#floor) function.

Returns:

  • (Any) —

    the largest integer less or equal to the argument.



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/floor.rb', line 7

newfunction(:floor, type: :rvalue, doc: <<-DOC
  @summary
    Returns the largest integer less or equal to the argument.

  @return
    the largest integer less or equal to the argument.
  Takes a single numeric value as an argument.

  > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with
  a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function.
  DOC
) do |arguments|
  raise(Puppet::ParseError, "floor(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1

  begin
    arg = Float(arguments[0])
  rescue TypeError, ArgumentError => _e
    raise(Puppet::ParseError, "floor(): Wrong argument type given (#{arguments[0]} for Numeric)")
  end

  raise(Puppet::ParseError, "floor(): Wrong argument type given (#{arg.class} for Numeric)") if arg.is_a?(Numeric) == false

  arg.floor
end