src/paimon/common/predicate/null_false_leaf_binary_function.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <vector>

#include "arrow/array/array_nested.h"
#include "arrow/c/bridge.h"
#include "arrow/util/checked_cast.h"
#include "fmt/format.h"
#include "paimon/common/predicate/leaf_function.h"
#include "paimon/common/predicate/literal_converter.h"
#include "paimon/common/utils/arrow/status_utils.h"
#include "paimon/status.h"

namespace paimon {
class NullFalseLeafBinaryFunction : public LeafFunction {
 public:
    Result<std::vector<char>> Test(const arrow::Array& array,
                                   const std::vector<Literal>& literals) const override {
        if (literals.size() < LITERAL_LIMIT) {
            return Status::Invalid("NullFalseLeafBinaryFunction needs single literal for field");
        }
        std::vector<char> is_valid(array.length(), false);
        if (literals[0].IsNull()) {
            return is_valid;
        }
        PAIMON_ASSIGN_OR_RAISE(
            std::vector<Literal> array_values,
            LiteralConverter::ConvertLiteralsFromArray(array, /*own_data=*/false));
        for (int64_t i = 0; i < array.length(); i++) {
            if (!array.IsNull(i)) {
                PAIMON_ASSIGN_OR_RAISE(is_valid[i], Test(array_values[i], literals[0]));
            }
        }
        return is_valid;
    }

    Result<bool> Test(const Literal& value, const std::vector<Literal>& literals) const override {
        if (literals.size() < LITERAL_LIMIT) {
            return Status::Invalid("NullFalseLeafBinaryFunction needs single literal for field");
        }
        if (literals[0].IsNull() || value.IsNull()) {
            return false;
        }
        return Test(value, literals[0]);
    }

    Result<bool> Test(int64_t row_count, const Literal& min_value, const Literal& max_value,
                      const std::optional<int64_t>& null_count,
                      const std::vector<Literal>& literals) const override {
        if (literals.size() < LITERAL_LIMIT) {
            return Status::Invalid("NullFalseLeafBinaryFunction needs single literal for field");
        }
        if (null_count != std::nullopt) {
            if (row_count == null_count.value() || literals[0].IsNull()) {
                return false;
            }
        }
        return Test(row_count, min_value, max_value, null_count, literals[0]);
    }

    // Precondition: field and literals are not empty
    virtual Result<bool> Test(const Literal& field, const Literal& literal) const = 0;
    virtual Result<bool> Test(int64_t row_count, const Literal& min_value, const Literal& max_value,
                              const std::optional<int64_t>& null_count,
                              const Literal& literal) const = 0;

 private:
    static constexpr size_t LITERAL_LIMIT = 1;
};
}  // namespace paimon