| /- | |
| Copyright (c) 2025 Lean FRO, LLC. All rights reserved. | |
| Released under Apache 2.0 license as described in the file LICENSE. | |
| Authors: Markus Himmel | |
| -/ | |
| prelude | |
| import Init.Data.Float | |
| import Init.Data.SInt.Basic | |
| set_option linter.missingDocs true | |
| /-- | |
| Truncates a floating-point number to the nearest 8-bit signed integer, rounding towards zero. | |
| If the `Float` is larger than the maximum value for `Int8` (including `Inf`), returns the maximum value of | |
| `Int8` (i.e. `Int8.maxValue`). If it is smaller than the minimum value for `Int8` (including `-Inf`), | |
| returns the minimum value of `Int8` (i.e. `Int8.minValue`). If it is `NaN`, returns `0`. | |
| This function does not reduce in the kernel. | |
| -/ | |
| @[extern "lean_float_to_int8"] opaque Float.toInt8 : Float → Int8 | |
| /-- | |
| Truncates a floating-point number to the nearest 16-bit signed integer, rounding towards zero. | |
| If the `Float` is larger than the maximum value for `Int16` (including `Inf`), returns the maximum | |
| value of `Int16` (i.e. `Int16.maxValue`). If it is smaller than the minimum value for `Int16` | |
| (including `-Inf`), returns the minimum value of `Int16` (i.e. `Int16.minValue`). If it is `NaN`, | |
| returns `0`. | |
| This function does not reduce in the kernel. | |
| -/ | |
| @[extern "lean_float_to_int16"] opaque Float.toInt16 : Float → Int16 | |
| /-- | |
| Truncates a floating-point number to the nearest 32-bit signed integer, rounding towards zero. | |
| If the `Float` is larger than the maximum value for `Int32` (including `Inf`), returns the maximum | |
| value of `Int32` (i.e. `Int32.maxValue`). If it is smaller than the minimum value for `Int32` | |
| (including `-Inf`), returns the minimum value of `Int32` (i.e. `Int32.minValue`). If it is `NaN`, | |
| returns `0`. | |
| This function does not reduce in the kernel. | |
| -/ | |
| @[extern "lean_float_to_int32"] opaque Float.toInt32 : Float → Int32 | |
| /-- | |
| Truncates a floating-point number to the nearest 64-bit signed integer, rounding towards zero. | |
| If the `Float` is larger than the maximum value for `Int64` (including `Inf`), returns the maximum | |
| value of `Int64` (i.e. `Int64.maxValue`). If it is smaller than the minimum value for `Int64` | |
| (including `-Inf`), returns the minimum value of `Int64` (i.e. `Int64.minValue`). If it is `NaN`, | |
| returns `0`. | |
| This function does not reduce in the kernel. | |
| -/ | |
| @[extern "lean_float_to_int64"] opaque Float.toInt64 : Float → Int64 | |
| /-- | |
| Truncates a floating-point number to the nearest word-sized signed integer, rounding towards zero. | |
| If the `Float` is larger than the maximum value for `ISize` (including `Inf`), returns the maximum | |
| value of `ISize` (i.e. `ISize.maxValue`). If it is smaller than the minimum value for `ISize` | |
| (including `-Inf`), returns the minimum value of `ISize` (i.e. `ISize.minValue`). If it is `NaN`, | |
| returns `0`. | |
| This function does not reduce in the kernel. | |
| -/ | |
| @[extern "lean_float_to_isize"] opaque Float.toISize : Float → ISize | |
| /-- | |
| Obtains the `Float` whose value is the same as the given `Int8`. | |
| This function does not reduce in the kernel. | |
| -/ | |
| @[extern "lean_int8_to_float"] opaque Int8.toFloat (n : Int8) : Float | |
| /-- | |
| Obtains the `Float` whose value is the same as the given `Int16`. | |
| This function does not reduce in the kernel. | |
| -/ | |
| @[extern "lean_int16_to_float"] opaque Int16.toFloat (n : Int16) : Float | |
| /-- | |
| Obtains the `Float` whose value is the same as the given `Int32`. | |
| This function does not reduce in the kernel. | |
| -/ | |
| @[extern "lean_int32_to_float"] opaque Int32.toFloat (n : Int32) : Float | |
| /-- | |
| Obtains a `Float` whose value is near the given `Int64`. | |
| It will be exactly the value of the given `Int64` if such a `Float` exists. If no such `Float` | |
| exists, the returned value will either be the smallest `Float` that is larger than the given value, | |
| or the largest `Float` that is smaller than the given value. | |
| This function does not reduce in the kernel. | |
| -/ | |
| @[extern "lean_int64_to_float"] opaque Int64.toFloat (n : Int64) : Float | |
| /-- | |
| Obtains a `Float` whose value is near the given `ISize`. | |
| It will be exactly the value of the given `ISize` if such a `Float` exists. If no such `Float` | |
| exists, the returned value will either be the smallest `Float` that is larger than the given value, | |
| or the largest `Float` that is smaller than the given value. | |
| This function does not reduce in the kernel. | |
| -/ | |
| @[extern "lean_isize_to_float"] opaque ISize.toFloat (n : ISize) : Float |