BigFloat.Log Method

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3

Overload List

Log(BigFloat) Returns the natural logarithm of a number with the specified accuracy.
Log(BigFloat, AccuracyGoal) Returns the natural logarithm of a number with the specified accuracy.
Log(BigFloat, BigFloat) Returns the logarithm of a number relative to the specified base with the specified accuracy.
Log(BigFloat, AccuracyGoal, RoundingMode) Returns the natural logarithm of a number with the specified accuracy.
Log(BigFloat, BigFloat, AccuracyGoal) Returns the logarithm of a number relative to the specified base with the specified accuracy.
Log(BigFloat, BigFloat, AccuracyGoal, RoundingMode) Returns the logarithm of a number relative to the specified base with the specified accuracy.

Log(BigFloat)

Returns the natural logarithm of a number with the specified accuracy.
C# 
public static BigFloat Log(
	BigFloat value
)

Parameters

value  BigFloat
A BigFloat value.

Return Value

BigFloat
The natural logarithm of value.

Implements

ILogarithmicFunctions<TSelf>.Log(TSelf)

Remarks

The result has the same relative accuracy as value.

Exceptions

ArgumentNullException

value is null.

Log(BigFloat, AccuracyGoal)

Returns the natural logarithm of a number with the specified accuracy.
C# 
public static BigFloat Log(
	BigFloat value,
	AccuracyGoal accuracyGoal
)

Parameters

value  BigFloat
A BigFloat value.
accuracyGoal  AccuracyGoal
An AccuracyGoal value that specifies the desired accuracy of the result.

Return Value

BigFloat
The natural logarithm of value with an accuracy within accuracyGoal.

Exceptions

ArgumentNullException

value is null.

Log(BigFloat, BigFloat)

Returns the logarithm of a number relative to the specified base with the specified accuracy.
C# 
public static BigFloat Log(
	BigFloat value,
	BigFloat logBase
)

Parameters

value  BigFloat
A BigFloat value.
logBase  BigFloat
A BigFloat value that specifies the base of the logarithm.

Return Value

BigFloat
The logarithm of value in base logBase with a relative accuracy that is the smaller of the relative precisions of value and logBase.

Implements

ILogarithmicFunctions<TSelf>.Log(TSelf, TSelf)

Remarks

The accuracy of the result is the smaller of the relative accuracies of value and logBase.

Exceptions

ArgumentNullException

value is null.

-or-

logBase is null.

Log(BigFloat, AccuracyGoal, RoundingMode)

Returns the natural logarithm of a number with the specified accuracy.
C# 
public static BigFloat Log(
	BigFloat value,
	AccuracyGoal accuracyGoal,
	RoundingMode roundingMode
)

Parameters

value  BigFloat
A BigFloat value.
accuracyGoal  AccuracyGoal
An AccuracyGoal value that specifies the desired accuracy of the result.
roundingMode  RoundingMode
A RoundingMode value that specifies how the result should be rounded.

Return Value

BigFloat
The natural logarithm of value with an accuracy within accuracyGoal.

Exceptions

ArgumentNullException

value is null.

Log(BigFloat, BigFloat, AccuracyGoal)

Returns the logarithm of a number relative to the specified base with the specified accuracy.
C# 
public static BigFloat Log(
	BigFloat value,
	BigFloat logBase,
	AccuracyGoal accuracyGoal
)

Parameters

value  BigFloat
A BigFloat value.
logBase  BigFloat
A BigFloat value that specifies the base of the logarithm.
accuracyGoal  AccuracyGoal
An AccuracyGoal value that specifies the desired accuracy of the result.

Return Value

BigFloat
The logarithm of value in base logBase with an accuracy within accuracyGoal.

Exceptions

ArgumentNullException

value is null.

-or-

logBase is null.

Log(BigFloat, BigFloat, AccuracyGoal, RoundingMode)

Returns the logarithm of a number relative to the specified base with the specified accuracy.
C# 
public static BigFloat Log(
	BigFloat value,
	BigFloat logBase,
	AccuracyGoal accuracyGoal,
	RoundingMode roundingMode
)

Parameters

value  BigFloat
A BigFloat value.
logBase  BigFloat
A BigFloat value that specifies the base of the logarithm.
accuracyGoal  AccuracyGoal
An AccuracyGoal value that specifies the desired accuracy of the result.
roundingMode  RoundingMode
A RoundingMode value that specifies how the result should be rounded.

Return Value

BigFloat
The logarithm of value in base logBase with an accuracy within accuracyGoal.

Exceptions

ArgumentNullException

value is null.

-or-

logBase is null.

See Also