KGy SOFT Core Libraries Help
Float
Gets the floor of the specified value using a specific tolerance.
That is the closest integral number to value if the difference from that is not larger than tolerance;
otherwise, the largest integral value that is less than value.
Definition
Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 8.0.0
The floor of the specified value using the specified tolerance.
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 8.0.0
C#
public static float TolerantFloor(
this float value,
float tolerance = 1E-06f
)VB
<ExtensionAttribute>
Public Shared Function TolerantFloor (
value As Single,
Optional tolerance As Single = 1E-06F
) As SingleC++
public:
[ExtensionAttribute]
static float TolerantFloor(
float value,
float tolerance = 1E-06f
)F#
[<ExtensionAttribute>]
static member TolerantFloor :
value : float32 *
?tolerance : float32
(* Defaults:
let _tolerance = defaultArg tolerance 1E-06f
*)
-> float32 Parameters
- value Single
- The value, whose floor is abut to be retrieved.
- tolerance Single (Optional)
- The tolerance to be used. For the best performance its value is not checked but the reasonable value is between 0 and 0.5. This parameter is optional.
Default value: 0.000001 (10-6).
Return Value
SingleThe floor of the specified value using the specified tolerance.