milvus/internal/core/unittest/test_bool_index.cpp

// Copyright (C) 2019-2020 Zilliz. All rights reserved.
//
// Licensed 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

#include <gtest/gtest.h>
#include <knowhere/index/vector_index/helpers/IndexParameter.h>
#include <pb/schema.pb.h>
#include <index/BoolIndex.h>
#include "test_utils/indexbuilder_test_utils.h"

class BoolIndexTest : public ::testing::Test {
 protected:
    void
    SetUp() override {
        n = 8;
        for (size_t i = 0; i < n; i++) {
            *(all_true.mutable_data()->Add()) = true;
            *(all_false.mutable_data()->Add()) = false;
            *(half.mutable_data()->Add()) = (i % 2) == 0;
        }

        all_true_ds = GenDsFromPB(all_true);
        all_false_ds = GenDsFromPB(all_false);
        half_ds = GenDsFromPB(half);
    }

    void
    TearDown() override {
        delete[](char*)(knowhere::GetDatasetTensor(all_true_ds));
        delete[](char*)(knowhere::GetDatasetTensor(all_false_ds));
        delete[](char*)(knowhere::GetDatasetTensor(half_ds));
    }

 protected:
    schemapb::BoolArray all_true;
    schemapb::BoolArray all_false;
    schemapb::BoolArray half;
    knowhere::DatasetPtr all_true_ds;
    knowhere::DatasetPtr all_false_ds;
    knowhere::DatasetPtr half_ds;
    size_t n;
    std::vector<ScalarTestParams> params;
};

TEST_F(BoolIndexTest, Constructor) {
    auto index = milvus::scalar::CreateBoolIndex();
}

TEST_F(BoolIndexTest, Count) {
    {
        auto index = milvus::scalar::CreateBoolIndex();
        index->BuildWithDataset(all_true_ds);
        ASSERT_EQ(n, index->Count());
    }

    {
        auto index = milvus::scalar::CreateBoolIndex();
        index->BuildWithDataset(all_false_ds);
        ASSERT_EQ(n, index->Count());
    }

    {
        auto index = milvus::scalar::CreateBoolIndex();
        index->BuildWithDataset(half_ds);
        ASSERT_EQ(n, index->Count());
    }
}

TEST_F(BoolIndexTest, In) {
    auto true_test = std::make_unique<bool>(true);
    auto false_test = std::make_unique<bool>(false);

    {
        auto index = milvus::scalar::CreateBoolIndex();
        index->BuildWithDataset(all_true_ds);

        auto bitset1 = index->In(1, true_test.get());
        ASSERT_TRUE(bitset1->any());

        auto bitset2 = index->In(1, false_test.get());
        ASSERT_TRUE(bitset2->none());
    }

    {
        auto index = milvus::scalar::CreateBoolIndex();
        index->BuildWithDataset(all_false_ds);

        auto bitset1 = index->In(1, true_test.get());
        ASSERT_TRUE(bitset1->none());

        auto bitset2 = index->In(1, false_test.get());
        ASSERT_TRUE(bitset2->any());
    }

    {
        auto index = milvus::scalar::CreateBoolIndex();
        index->BuildWithDataset(half_ds);

        auto bitset1 = index->In(1, true_test.get());
        for (size_t i = 0; i < n; i++) {
            ASSERT_EQ(bitset1->test(i), (i % 2) == 0);
        }

        auto bitset2 = index->In(1, false_test.get());
        for (size_t i = 0; i < n; i++) {
            ASSERT_EQ(bitset2->test(i), (i % 2) != 0);
        }
    }
}

TEST_F(BoolIndexTest, NotIn) {
    auto true_test = std::make_unique<bool>(true);
    auto false_test = std::make_unique<bool>(false);

    {
        auto index = milvus::scalar::CreateBoolIndex();
        index->BuildWithDataset(all_true_ds);

        auto bitset1 = index->NotIn(1, true_test.get());
        ASSERT_TRUE(bitset1->none());

        auto bitset2 = index->NotIn(1, false_test.get());
        ASSERT_TRUE(bitset2->any());
    }

    {
        auto index = milvus::scalar::CreateBoolIndex();
        index->BuildWithDataset(all_false_ds);

        auto bitset1 = index->NotIn(1, true_test.get());
        ASSERT_TRUE(bitset1->any());

        auto bitset2 = index->NotIn(1, false_test.get());
        ASSERT_TRUE(bitset2->none());
    }

    {
        auto index = milvus::scalar::CreateBoolIndex();
        index->BuildWithDataset(half_ds);

        auto bitset1 = index->NotIn(1, true_test.get());
        for (size_t i = 0; i < n; i++) {
            ASSERT_EQ(bitset1->test(i), (i % 2) != 0);
        }

        auto bitset2 = index->NotIn(1, false_test.get());
        for (size_t i = 0; i < n; i++) {
            ASSERT_EQ(bitset2->test(i), (i % 2) == 0);
        }
    }
}

TEST_F(BoolIndexTest, Codec) {
    auto true_test = std::make_unique<bool>(true);
    auto false_test = std::make_unique<bool>(false);

    {
        auto index = milvus::scalar::CreateBoolIndex();
        index->BuildWithDataset(all_true_ds);

        auto copy_index = milvus::scalar::CreateBoolIndex();
        copy_index->Load(index->Serialize(nullptr));

        auto bitset1 = copy_index->NotIn(1, true_test.get());
        ASSERT_TRUE(bitset1->none());

        auto bitset2 = copy_index->NotIn(1, false_test.get());
        ASSERT_TRUE(bitset2->any());
    }

    {
        auto index = milvus::scalar::CreateBoolIndex();
        index->BuildWithDataset(all_false_ds);

        auto copy_index = milvus::scalar::CreateBoolIndex();
        copy_index->Load(index->Serialize(nullptr));

        auto bitset1 = copy_index->NotIn(1, true_test.get());
        ASSERT_TRUE(bitset1->any());

        auto bitset2 = copy_index->NotIn(1, false_test.get());
        ASSERT_TRUE(bitset2->none());
    }

    {
        auto index = milvus::scalar::CreateBoolIndex();
        index->BuildWithDataset(half_ds);

        auto copy_index = milvus::scalar::CreateBoolIndex();
        copy_index->Load(index->Serialize(nullptr));

        auto bitset1 = copy_index->NotIn(1, true_test.get());
        for (size_t i = 0; i < n; i++) {
            ASSERT_EQ(bitset1->test(i), (i % 2) != 0);
        }

        auto bitset2 = copy_index->NotIn(1, false_test.get());
        for (size_t i = 0; i < n; i++) {
            ASSERT_EQ(bitset2->test(i), (i % 2) == 0);
        }
    }
}