Quaternion.Ln Method

Language:

Calculates the natural logarithm.

Definition

Visual Basic Public Shared Function Ln( _
    ByVal q As Quaternion _
) As Quaternion

C# public static Quaternion Ln(
    Quaternion q
);

C++ public:
static Quaternion Ln(
    Quaternion q
);

JScript public static function Ln(
    q : Quaternion
) : Quaternion;

Visual Basic	Public Shared Function Ln( _ ByVal q As Quaternion _ ) As Quaternion
C#	public static Quaternion Ln( Quaternion q );
C++	public: static Quaternion Ln( Quaternion q );
JScript	public static function Ln( q : Quaternion ) : Quaternion;

Parameters

q Microsoft.DirectX.Quaternion
Source Quaternion structure.

Return Value

Microsoft.DirectX.Quaternion
A Quaternion structure that is the natural logarithm of the quaternion passed into the q parameter.

Remarks

The Ln method works only for unit quaternions.

A unit quaternion is defined by the following example.
Q == (cos(theta), sin(theta) * v) where |v| = 1
The natural logarithm of Q is ln(Q) = (0, theta * v)