CartesianNormalize Method (Double) |
Forms a set of
UnitCartesian coordinates from this instance
and returns the
Magnitude of the original instance in the provided parameter.
Namespace:
AGI.Foundation.Coordinates
Assembly:
AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 25.2.423.0 (25.2.423.0)
Syntaxpublic UnitCartesian Normalize(
out double magnitude
)
Public Function Normalize (
<OutAttribute> ByRef magnitude As Double
) As UnitCartesian
public:
UnitCartesian Normalize(
[OutAttribute] double% magnitude
)
member Normalize :
magnitude : float byref -> UnitCartesian
Parameters
- magnitude
- Type: SystemDouble
On return,
the magnitude of the original set of Cartesian coordinates.
Return Value
Type:
UnitCartesianThe resulting set of
UnitCartesian coordinates.
Exceptions| Exception | Condition |
|---|
| DivideByZeroException |
The magnitude of the provided coordinates must not be zero.
|
| NotFiniteNumberException |
The magnitude of the provided coordinates must not be infinite.
|
Remarks
The normalization of the cartesian components is accomplished in the usual way.
It should be noted that this does not guarantee a result whose magnitude will be 1.0 in cases where an individual component underflows upon squaring.
See Also