GH-20339: [C++] Add residual filter support to swiss join

[zanmato1984]

Rationale for this change

Add residual filter support to swiss join.

What changes are included in this PR?

1. Added class JoinResidualFilter as a centralized structure to evaluate residual filter in swiss join. It has various flavors of filtering for various join types. Zero-overhead is guaranteed for trivial filters (literal true and sometimes literal false/null). More detailed explanation in code comments.
2. Tuned the structure of swiss join main body (JoinProbeProcessor::OnNextBatch) to better cope with JoinResidualFilter calls.

Are these changes tested?

Legacy UTs (HashJoin.Random, HashJoin.ResidualFilter and HashJoin.TrivialResidualFilter) cover part of this change. New fine-grained residual filter cases added as well.

Are there any user-facing changes?

No.

• Closes: [C++][Compute] Add residual predicate support to new (Swiss) hash join #20339

[github-actions]

⚠️ GitHub issue #20339has been automatically assigned in GitHub to PR creator.

[zanmato1984]

Deleted because used nowhere in existing code base.

[vibhatha]

@zanmato1984 would it be possible to add some test cases?

[zanmato1984]

@zanmato1984 would it be possible to add some test cases?

Yes, I am working on that.

[vibhatha]

@zanmato1984 I will completely review once the test cases are there.

[zanmato1984]

I tried to rebase and get things messy. Let me fix my branch first. Sorry for the trouble, guys :(

[zanmato1984]

Hi @westonpace , I've addressed the comments you previously left except one thing I'm uncertain about in my last post. Would you please take a look again? Thanks!

[conbench-apache-arrow]

After merging your PR, Conbench analyzed the 7 benchmarking runs that have been run so far on merge-commit 0ce7267.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 11 possible false positives for unstable benchmarks that are known to sometimes produce them.