Back to FabImage Library websiteYou are here:
Start »
Function Reference »
All Functions »
Math »
Logarithm
This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.
| Header: |
STD.h
|
| Namespace: |
fil |
| Module: |
FoundationLite |
Computes the logarithm of a number in a given base.
Syntax
void fil::Logarithm
(
const float inBase,
const float inValue,
float& outLogarithm
)
Parameters
|
Name |
Type |
Range |
Default |
Description |
 |
inBase |
const float |
0.0 -  |
2.0f |
|
|
inValue |
const float |
0.0 - |
1.0f |
|
 |
outLogarithm |
float& |
|
|
|
Errors
List of possible exceptions:
| Error type |
Description |
| DomainError |
Base equal 1 in RealLogarithm |
| DomainError |
Nonpositive base in RealLogarithm |
| DomainError |
Nonpositive number in RealLogarithm |
