GenericExtensions..::..Log1PlusX<(Of <(<'T>)>)> Method

GenericExtensions Class See Also

Returns the logarithm of 1 plus the argument.

Namespace: Extreme.Mathematics.Generic
Assembly: Extreme.Numerics.Net40 (in Extreme.Numerics.Net40.dll) Version: 4.2.11333.0 (4.2.12253.0)

Syntax

C#
public static T Log1PlusX<T>( this IRealOperations<T> ops, T value )

Visual Basic (Declaration)
<ExtensionAttribute> _ Public Shared Function Log1PlusX(Of T) ( _ ops As IRealOperations(Of T), _ value As T _ ) As T

Visual C++
[ExtensionAttribute] public: generic<typename T> static T Log1PlusX( IRealOperations<T>^ ops, T value )

F#
static member Log1PlusX : ops:IRealOperations<'T> * value:'T -> 'T

Parameters

ops: Type: Extreme.Mathematics.Generic..::..IRealOperations<(Of <(<'T>)>)>
A IRealOperations<(Of <(<'T>)>)> instance that performs basic arithmetic operations.

value: Type: T
A real number greater than -1.

Type Parameters

T

Return Value

The logarithm of 1 plus value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IRealOperations<(Of <(<'T>)>)>. When you use instance method syntax to call this method, omit the first parameter.

Remarks

For small values of value, the logarithm of 1 + value is close to zero. When the logarithm is evaluated directly, this can cause significant round-off error. This function resolves this problem by using a direct approvalueimations for value close to 1.

Exceptions

Exception	Condition
System..::..ArgumentOutOfRangeException	value is less than or equal to -1.