Add XLOOKUP without support for non standard match_mode and search_mode - and returning values/arrays instead of ranges #1414

selimyoussry · 2024-06-15T14:27:56Z

Context

Per this discussion it seems like XLOOKUP is useful to a bunch of people. It is to for me at the very least :) and so I am happy to contribute to its implementation!

How did you test your changes?

I have tested the XLOOKUP implementation against the examples from Microsoft's official doc

Example 1: should find value in simple column range
Example 2: should find row range in table
Example 2 transposed: should find column range in table (official example 2, transposed). This makes sure both column and row search work.
Example 3: should find use if_not_found argument if not found
Example 4: current limitation of this implementation, the approximate match and non standard search are not supported. I added these limitations to the documentation. Hence, this example is not tested against.
Example 5: nested xlookup function to perform both a vertical and horizontal match (official example 5)
Example 6: two nested xlookup + sum (official example 6). I wrote the code but then realized that (based on my shallow understanding of Hyperformula, please correct me if I am wrong), Hyperformula does not support functions returning ranges, only functions returning values.

Types of changes

Breaking change (a fix or a feature because of which an existing functionality doesn't work as expected anymore)
New feature or improvement (a non-breaking change that adds functionality)
Bug fix (a non-breaking change that fixes an issue)
Additional language file, or a change to an existing language file (translations)
Change to the documentation

Related issues:

Related to this discussion XLOOKUP Support #1064

Checklist:

I have reviewed the guidelines about Contributing to HyperFormula and I confirm that my code follows the code style of this project.
I have signed the Contributor License Agreement.
My change is compliant with the OpenDocument standard. This does not apply as XLOOKUP is not part of this standard
My change is compatible with Microsoft Excel.
My change is compatible with Google Sheets. Should be if the XLOOKUP implementation in Sheets is the same as Excel
I described my changes in the CHANGELOG.md file. That feels like it's up to you guys to see if that's releasable :)
My changes require a documentation update.
My changes require a migration guide.

…ional parameters

… test

…OKUP

AMBudnik · 2024-06-18T06:49:29Z

Thank you for signing the CLA and sharing the pull request.

sequba

Very solid implementation. Thanks a lot, @selimyoussry. We appreciate that you invested your time to contribute to the HyperFormula.

It requires polishing and probably some of the limitations you described can be addressed to make the function more robust, but it's a good starting point and certainly the right direction to go about implementing the XLOOKUP function.

sequba · 2024-06-20T10:06:26Z

docs/guide/built-in-functions.md

@@ -227,6 +227,7 @@ Total number of functions: **{{ $page.functionsCount }}**
 | ROW         | Returns row number of a given reference or formula reference if argument not provided.                                                   | ROW([Reference])                                                       |
 | ROWS        | Returns the number of rows in the given reference.                                                                                       | ROWS(Array)                                                            |
 | VLOOKUP     | Searches vertically with reference to adjacent cells to the right.                                                                       | VLOOKUP(Search_Criterion, Array, Index, Sort_Order)                    |
+| XLOOKUP     | The XLOOKUP function searches a range or an array, and then returns the item corresponding to the first match it finds. If no match exists, then XLOOKUP can return the closest (approximate) match. Current limitations: only default match_mode and search_mode are supported, a range of value is returned, not a range, so having XLOOKUP(...):XLOOKUP(...) will not work.                                                                      | XLOOKUP(lookup_value, lookup_array, return_array, [if_not_found], [match_mode], [search_mode])                    |


I can understand why you put it here, but the current convention in HyperFormula is to describe the limitations of the built-in functions in pages https://hyperformula.handsontable.com/guide/list-of-differences.html (difference in results from other spreadsheets) and https://hyperformula.handsontable.com/guide/known-limitations.html#nuances-of-the-implemented-functions (general limitations).

sequba · 2024-06-20T10:06:59Z

src/i18n/languages/trTR.ts

@@ -232,6 +232,7 @@ const dictionary: RawTranslationPackage = {
    WEEKNUM: 'HAFTASAY',
    WORKDAY: 'İŞGÜNÜ',
    'WORKDAY.INTL': 'İŞGÜNÜ.ULUSL',
+    XLOOKUP: 'ÇAPRAZARA',


Thank you for providing the translations. We really appreciate it.

sequba · 2024-06-20T10:07:58Z

src/interpreter/plugin/LookupPlugin.ts

+   * @param ast
+   * @param state
+   */
+  public xlookup(ast: ProcedureAst, state: InterpreterState): InterpreterValue {


Very solid implementation 💪

sequba · 2024-12-05T13:16:22Z

Merging this PR into a local branch to fine-tune the implementation. Thank you, @selimyoussry, for the contribution.

AMBudnik · 2025-01-14T12:09:31Z

Thank you again for your input, @selimyoussry, and for spending your time improving HyperFormula. I'm glad to see the new function added in HF v3. Thank you!

selimyoussry added 3 commits June 15, 2024 13:39

ISS-1 sapiologie/hyperformula XLOOKUP in built-in-functions.md

932e8c0

ISS-1 sapiologie/hyperformula add translations

f0f9545

ISS-1 sapiologie/hyperformula placeholder function and test

384bcb8

selimyoussry force-pushed the iss-1-xlookup branch from 43b3afa to 384bcb8 Compare June 15, 2024 14:34

selimyoussry changed the title ~~Add XLOOKUP~~ Add XLOOKUP (WIP) Jun 15, 2024

selimyoussry added 4 commits June 16, 2024 15:39

ISS-1 sapiologie/hyperformula progress on Xlookup logic

eecce3a

ISS-1 sapiologie/hyperformula Working XLOOKUP without support for opt…

e9cabd6

…ional parameters

ISS-1 sapiologie/hyperformula override default if_not_found

83be86c

ISS-1 sapiologie/hyperformula add commented out range function return…

5101a90

… test

selimyoussry changed the title ~~Add XLOOKUP (WIP)~~ Add XLOOKUP without support for non standard match_mode and search_mode - and returning values/arrays instead of ranges Jun 16, 2024

selimyoussry marked this pull request as ready for review June 16, 2024 18:04

selimyoussry mentioned this pull request Jun 16, 2024

Iss 1 xlookup sapiologie/hyperformula#2

Open

ISS-1 sapiologie/hyperformula update the doc to reflect limitations

08445d1

selimyoussry force-pushed the iss-1-xlookup branch from b001b7b to 08445d1 Compare June 16, 2024 18:17

ISS-1 sapiologie/hyperformula Set vectorizationForbidden: true on XLO…

9ece67c

…OKUP

AMBudnik added the CLA signed Required for PR label Jun 18, 2024

sequba reviewed Jun 20, 2024

View reviewed changes

sequba mentioned this pull request Nov 13, 2024

Add XLOOKUP function #1458

Closed

sequba changed the base branch from develop to feature/issue-1458 December 5, 2024 13:09

sequba merged commit 1f9d091 into handsontable:feature/issue-1458 Dec 5, 2024
2 checks passed

AMBudnik added the Released label Jan 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add XLOOKUP without support for non standard match_mode and search_mode - and returning values/arrays instead of ranges #1414

Add XLOOKUP without support for non standard match_mode and search_mode - and returning values/arrays instead of ranges #1414

selimyoussry commented Jun 15, 2024 •

edited

Loading

AMBudnik commented Jun 18, 2024

sequba left a comment •

edited

Loading

sequba Jun 20, 2024

sequba Jun 20, 2024

sequba Jun 20, 2024

sequba commented Dec 5, 2024

AMBudnik commented Jan 14, 2025

Add XLOOKUP without support for non standard match_mode and search_mode - and returning values/arrays instead of ranges #1414

Add XLOOKUP without support for non standard match_mode and search_mode - and returning values/arrays instead of ranges #1414

Conversation

selimyoussry commented Jun 15, 2024 • edited Loading

Context

How did you test your changes?

Types of changes

Related issues:

Checklist:

AMBudnik commented Jun 18, 2024

sequba left a comment • edited Loading

Choose a reason for hiding this comment

sequba Jun 20, 2024

Choose a reason for hiding this comment

sequba Jun 20, 2024

Choose a reason for hiding this comment

sequba Jun 20, 2024

Choose a reason for hiding this comment

sequba commented Dec 5, 2024

AMBudnik commented Jan 14, 2025

selimyoussry commented Jun 15, 2024 •

edited

Loading

sequba left a comment •

edited

Loading