org.apache.solr.analytics.function.mapping

Class LogFunction

java.lang.Object

org.apache.solr.analytics.function.mapping.LogFunction

public class LogFunction
extends Object

A logarithm mapping function.

Uses:

• If one numeric Value or ValueStream is passed in, a DoubleValue or DoubleValueStream representing the natural logarithm is returned.
• If two numeric Values are passed in, a DoubleValue representing the logarithm of the first with the second as the base is returned.
• If a numeric ValueStream and a numeric Value are passed in, a DoubleValueStream representing the logarithm of the Value with each of the values of the ValueStream for a document as the base is returned. (Or the other way, since the Value and ValueStream can be used in either order)

Field Summary

Fields

Modifier and Type	Field and Description
static ExpressionFactory.CreatorFunction	creatorFunction
static String	name

Constructor Summary

Constructors

Constructor and Description
LogFunction()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

public static final String name

See Also:

Constant Field Values

creatorFunction

public static final ExpressionFactory.CreatorFunction creatorFunction

Constructor Detail

LogFunction

public LogFunction()