Implementation for the MATCH() Excel function.

Syntax:
MATCH(lookup_value, lookup_array, match_type)

Returns a 1-based index specifying at what position in the lookup_array the specified lookup_value is found.

Specific matching behaviour can be modified with the optional match_type parameter.

match_type parameter description
Value	Matching Behaviour
1	(default) find the largest value that is less than or equal to lookup_value. The lookup_array must be in ascending order*.
0	find the first value that is exactly equal to lookup_value. The lookup_array can be in any order.
-1	find the smallest value that is greater than or equal to lookup_value. The lookup_array must be in descending order*.

* Note regarding order - For the match_type cases that require the lookup_array to be ordered, MATCH() can produce incorrect results if this requirement is not met. Observed behaviour in Excel is to return the lowest index value for which every item after that index breaks the match rule.
The (ascending) sort order expected by MATCH() is:
numbers (low to high), strings (A to Z), boolean (FALSE to TRUE)
MATCH() ignores all elements in the lookup_array with a different type to the lookup_value. Type conversion of the lookup_array elements is never performed.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Match.SingleValueVector

Constructor Summary

Access	Constructor and Description
public	Match()

Method Summary

Modifier and Type	Method and Description
private static LookupUtils.LookupValueComparer	createLookupComparer(ValueEval lookupValue, boolean matchExact)
private static ValueEval	eval(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, double match_type)
public ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1) Implements org.apache.poi.ss.formula.functions.Function2Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)`
public ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, ValueEval arg2) Implements org.apache.poi.ss.formula.functions.Function3Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)`
private static LookupUtils.ValueVector	evaluateLookupRange(ValueEval eval)
private static double	evaluateMatchTypeArg(ValueEval arg, int srcCellRow, int srcCellCol)
private static int	Returns: zero based index findIndexOfValue(ValueEval lookupValue, LookupUtils.ValueVector lookupRange, boolean matchExact, boolean findLargestLessThanOrEqual)

Inherited from org.apache.poi.ss.formula.functions.Var2or3ArgFunction:: evaluate

Constructor Detail

Match	back to summary
public Match()

Method Detail

createLookupComparer	back to summary
private static LookupUtils.LookupValueComparer createLookupComparer(ValueEval lookupValue, boolean matchExact)

eval	back to summary
private static ValueEval eval(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, double match_type)

evaluate back to summary

evaluate	back to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1) Implements org.apache.poi.ss.formula.functions.Function2Arg.evaluate. Doc from org.apache.poi.ss.formula.functions.Function2Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)` Annotations @Override

public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1)

Implements org.apache.poi.ss.formula.functions.Function2Arg.evaluate.

Doc from org.apache.poi.ss.formula.functions.Function2Arg.evaluate.

see Function#evaluate(ValueEval[], int, int)

Annotations

@Override

evaluate back to summary

evaluate	back to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, ValueEval arg2) Implements org.apache.poi.ss.formula.functions.Function3Arg.evaluate. Doc from org.apache.poi.ss.formula.functions.Function3Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)` Annotations @Override

public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, ValueEval arg2)

Implements org.apache.poi.ss.formula.functions.Function3Arg.evaluate.

Doc from org.apache.poi.ss.formula.functions.Function3Arg.evaluate.

see Function#evaluate(ValueEval[], int, int)

Annotations

@Override

evaluateLookupRange	back to summary
private static LookupUtils.ValueVector evaluateLookupRange(ValueEval eval) throws EvaluationException

evaluateMatchTypeArg	back to summary
private static double evaluateMatchTypeArg(ValueEval arg, int srcCellRow, int srcCellCol) throws EvaluationException

findIndexOfValue	back to summary
private static int findIndexOfValue(ValueEval lookupValue, LookupUtils.ValueVector lookupRange, boolean matchExact, boolean findLargestLessThanOrEqual) throws EvaluationException Returns:int zero based index

org.apache.poi.ss.formula.functions back to summary

private final Class Match.SingleValueVector

Class Inheritance

extends Object
implements ValueVector

java.lang.Object
org.apache.poi.ss.formula.functions.Match.SingleValueVector

All Implemented Interfaces

org.apache.poi.ss.formula.functions.LookupUtils.ValueVector

Field Summary

Modifier and Type	Field and Description
private final ValueEval	_value

Constructor Summary

Access	Constructor and Description
public	SingleValueVector(ValueEval value)

Method Summary

Modifier and Type	Method and Description
public ValueEval	getItem(int index) Implements org.apache.poi.ss.formula.functions.LookupUtils.ValueVector.getItem.
public int	getSize() Implements org.apache.poi.ss.formula.functions.LookupUtils.ValueVector.getSize.