Calculates the natural logarithm.
Namespace: DigitalRune.Mathematics.AlgebraAssembly: DigitalRune.Mathematics (in DigitalRune.Mathematics.dll) Version: 1.7.0.0 (1.7.0.9486)
Syntax
| C# |
|---|
public static QuaternionD Ln( QuaternionD quaternion ) |
| Visual Basic |
|---|
Public Shared Function Ln ( _ quaternion As QuaternionD _ ) As QuaternionD |
| Visual C++ |
|---|
public: static QuaternionD Ln( QuaternionD quaternion ) |
Parameters
- quaternion
- Type: DigitalRune.Mathematics.Algebra..::..QuaternionD
The quaternion.
Return Value
The natural logarithm ln(q).
Remarks
Important: This method requires that the quaternion is a unit quaternion.
The natural logarithm of a quaternion q is defines as:
ln(q) = ln(cos(θ) + usin(θ)) = ln(euθ) = uθ
The result is returned as a quaternion with the form: (0, uθ)
Exceptions
| Exception | Condition |
|---|---|
| DigitalRune.Mathematics..::..MathematicsException | The given quaternion is not a unit quaternion. |