UtilEuclid (Euclid)

UtilEuclid Module

Namespace: Euclid
Assembly: Euclid.dll

A module for math , logic utility functions and default tolerance values for use within Euclid.

Functions and values

Function or value	Description
`!^x` Full Usage: `!^x` Parameters: x : `float` Returns: `float<'measure>` Modifiers: inline Type parameters: 'measure	Adds a Unit Of Measure to a float value. This is a compile time feature of F#. It's erased at runtime. x : `float` Returns: `float<'measure>`
``-1.0+1e-6`` Full Usage: ``-1.0+1e-6`` Returns: `float`	The float literal that is -1.0 + 1e-6 This is literally -0.999999 Returns: `float`
``-1.0-1e-6`` Full Usage: ``-1.0-1e-6`` Returns: `float`	The float literal that is -1.0 - 1e-6 This is literally -1.000001 Returns: `float`
``1.0+1e-6`` Full Usage: ``1.0+1e-6`` Returns: `float`	The float literal that is 1.0 + 1e-6 This is literally 1.000001 Returns: `float`
``1.0-1e-6`` Full Usage: ``1.0-1e-6`` Returns: `float`	The float literal that is 1.0 - 1e-6 This is literally 0.999999 Returns: `float`
`acosSafe a` Full Usage: `acosSafe a` Parameters: a : `float` Returns: `float` Modifiers: inline	A safe arccosine (Inverse Cosine) function. It clamps the input between -1 and 1 a : `float` Returns: `float`
`asinSafe a` Full Usage: `asinSafe a` Parameters: a : `float` Returns: `float` Modifiers: inline	A safe arcsine (Inverse Sine) function. It clamps values between -1 and 1 a : `float` Returns: `float`
`axisAlignmentTolerance` Full Usage: `axisAlignmentTolerance` Returns: `float`	Tolerance for axis alignment: 1e-9 Used in Axis Alignment checks. Returns: `float`
`clamp01 x` Full Usage: `clamp01 x` Parameters: x : `float` Returns: `float` Modifiers: inline	Clamp value between 0.0 and +1.0. Returns NaN for NaN x : `float` Returns: `float`
`clamp01NaN x` Full Usage: `clamp01NaN x` Parameters: x : `float` Returns: `float` Modifiers: inline	Clamp value between 0.0 and +1.0. Returns 0.0 for NaN x : `float` Returns: `float`
`clampBetweenMinusOneAndOne x` Full Usage: `clampBetweenMinusOneAndOne x` Parameters: x : `float` Returns: `float` Modifiers: inline	Clamp value between -1.0 and +1.0. Returns NaN for NaN x : `float` Returns: `float`
`countTooTinyOrNaN x` Full Usage: `countTooTinyOrNaN x` Parameters: x : `float` Returns: `int` Modifiers: inline	Returns 1 for values smaller than 1e-12 and for NaN. Otherwise returns 0 Uses UtilEuclid.zeroLengthTolerance x : `float` Returns: `int`
`countTooTinySqOrNaN x` Full Usage: `countTooTinySqOrNaN x` Parameters: x : `float` Returns: `int` Modifiers: inline	Returns 1 for values smaller than 1e-24 (square of 1e-12) and for NaN. Otherwise returns 0 Uses UtilEuclid.zeroLengthTolSquared x : `float` Returns: `int`
`halfPi` Full Usage: `halfPi` Returns: `float`	Math.PI * 0.5 This is equal to 90 degrees in radians. Returns: `float`
`isBetweenZeroAndOne x` Full Usage: `isBetweenZeroAndOne x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Check if value is between 0.0 and +1.0 inclusive. x : `float` Returns: `bool`
`isBetweenZeroAndOneTolerantExcl x` Full Usage: `isBetweenZeroAndOneTolerantExcl x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Check if value is between 0.0 and +1.0 exclusive a tolerance of 1e-6 . 1e-6 < x < 1.0 - 1e-6 Returns FALSE for NaN. x : `float` Returns: `bool`
`isBetweenZeroAndOneTolerantIncl x` Full Usage: `isBetweenZeroAndOneTolerantIncl x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Check if value is between 0.0 and +1.0 inclusive a tolerance of 1e-6 . -1e-6 < x < 1.0 + 1e-6 Returns FALSE for NaN. x : `float` Returns: `bool`
`isMinusOne x` Full Usage: `isMinusOne x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Tests if a number is close to minus 1.0 by a 1e-6 tolerance. This is a float increment of 6 steps or decrement of 16 steps. x : `float` Returns: `bool`
`isNanInfinity x` Full Usage: `isNanInfinity x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Returns TRUE if the float is NaN or Infinity. x : `float` Returns: `bool`
`isNegative x` Full Usage: `isNegative x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Returns TRUE for negative number and for NaN. 0.0 and -0.0 is not negative. x : `float` Returns: `bool`
`isNotOne x` Full Usage: `isNotOne x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Tests if a number is NOT close to 1.0 by a 1e-6 tolerance. This is a float increment of 6 steps or decrement of 16 steps. Also returns TRUE for NaN. x : `float` Returns: `bool`
`isNotZero x` Full Usage: `isNotZero x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Tests if a number is NOT close to 0.0 by 1e-6 This is approximately the same tolerance that 6 increments of a float are away from 1.0. See Euclid.UtilEuclid.isOne function. Also returns TRUE for NaN. x : `float` Returns: `bool`
`isOne x` Full Usage: `isOne x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Tests if a number is close to 1.0 by a 1e-6 tolerance. This is a float increment of 6 steps or decrement of 16 steps. x : `float` Returns: `bool`
`isTooSmall x` Full Usage: `isTooSmall x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Returns TRUE for values smaller than 1e-6 and for NaN. x : `float` Returns: `bool`
`isTooSmallSq x` Full Usage: `isTooSmallSq x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Returns TRUE for values smaller than 1e-12 (square of 1e-6) and for NaN. x : `float` Returns: `bool`
`isTooTiny x` Full Usage: `isTooTiny x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Returns TRUE for values smaller than 1e-12 and for NaN. Uses UtilEuclid.zeroLengthTolerance x : `float` Returns: `bool`
`isTooTinySq x` Full Usage: `isTooTinySq x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Returns TRUE for values smaller than 1e-24 (square of 1e-12) and for NaN. Uses UtilEuclid.zeroLengthTolSquared x : `float` Returns: `bool`
`isZero x` Full Usage: `isZero x` Parameters: x : `float` Returns: `bool` Modifiers: inline	Tests if a number is close to 0.0 by 1e-6 This is approximately the same tolerance that 6 increments of a float are away from 1.0. See Euclid.UtilEuclid.isOne function. x : `float` Returns: `bool`
`matchSign signedValue numToMatch` Full Usage: `matchSign signedValue numToMatch` Parameters: signedValue : `float` numToMatch : `float` Returns: `float`	Match the sign (+ or -) to a given number. signedValue : `float` numToMatch : `float` Returns: `float`
`safeIdx i length` Full Usage: `safeIdx i length` Parameters: i : `int` length : `int` Returns: `int` Modifiers: inline	Any positive or negative int will give a valid index for given collection size. Converts negative indices to positive ones and loops to start after last index is reached. i : `int` length : `int` Returns: `int`
`toDegrees radians` Full Usage: `toDegrees radians` Parameters: radians : `float` Returns: `float` Modifiers: inline	Converts angles from radians to degrees. By multiplying with 57.29... (180. / PI) radians : `float` Returns: `float`
`toRadians degrees` Full Usage: `toRadians degrees` Parameters: degrees : `float` Returns: `float` Modifiers: inline	Converts angles from degrees to radians. By multiplying with 0.0174... (PI / 180.) degrees : `float` Returns: `float`
`twoPi` Full Usage: `twoPi` Returns: `float`	Math.PI * 2.0 This is equal to 360 degrees in radians. Returns: `float`
`withMeasure x` Full Usage: `withMeasure x` Parameters: x : `float` Returns: `float<'measure>` Modifiers: inline Type parameters: 'measure	Adds a Unit Of Measure to a float value. This is a compile time feature of F#. It's erased at runtime. x : `float` Returns: `float<'measure>`
`zeroLengthTolerance` Full Usage: `zeroLengthTolerance` Returns: `float`	Tolerance for zero length: 1e-12 in divisions and unitizing of vectors. Returns: `float`