Back to Adaptive Vision Library website
You are here: Start » Function Reference » Math » Logarithm
Logarithm
This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.
Computes the logarithm of a number in a given base.
Syntax
void avl::Logarithm ( const atl::real inBase, const atl::real inValue, atl::real& outLogarithm )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 |
inBase | const real | 0.0 -  |
2.0f | |
|
inValue | const real | 0.0 - |
1.0f | |
 |
outLogarithm | real& |
Hints
- This is a primitive mathematical filter. It is recommended to use Formula Blocks instead.
Errors
| Error type | Description |
|---|---|
| DomainError | Nonpositive number in RealLogarithm |
| DomainError | Nonpositive base in RealLogarithm |
| DomainError | Base equal 1 in RealLogarithm |
