path: root/searchlib/src/vespa/searchlib/expression/resultvector.h

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once

#include "enumresultnode.h"
#include "integerresultnode.h"
#include "floatresultnode.h"
#include "stringresultnode.h"
#include "rawresultnode.h"
#include "integerbucketresultnode.h"
#include "floatbucketresultnode.h"
#include "stringbucketresultnode.h"
#include "rawbucketresultnode.h"
#include <vespa/vespalib/objects/visit.hpp>
#include <vespa/vespalib/stllike/identity.h>
#include <algorithm>

namespace search::expression {

class ResultNodeVector : public ResultNode
{
public:
    DECLARE_ABSTRACT_EXPRESSIONNODE(ResultNodeVector);
    DECLARE_RESULTNODE_SERIALIZE;
    using UP = std::unique_ptr<ResultNodeVector>;
    using CP = vespalib::IdentifiablePtr<ResultNodeVector>;
    virtual const ResultNode * find(const ResultNode & key) const = 0;
    virtual ResultNodeVector & push_back(const ResultNode & node) = 0;
    virtual ResultNodeVector & push_back_safe(const ResultNode & node) = 0;
    virtual const ResultNode & get(size_t index) const = 0;
    virtual ResultNodeVector & set(size_t index, const ResultNode & node) = 0;
    virtual ResultNode & get(size_t index) = 0;
    virtual void clear() = 0;
    virtual void resize(size_t sz) = 0;
    virtual void reserve(size_t sz) = 0;
    size_t size() const { return onSize(); }
    bool  empty() const { return size() == 0; }
    /**
     * Sum yourself to the argument
     * @param result the argument
     */
    virtual ResultNode & flattenMultiply(ResultNode & r) const { return r; }
    virtual ResultNode & flattenSum(ResultNode & r) const { return r; }
    virtual ResultNode & flattenMax(ResultNode & r) const { return r; }
    virtual ResultNode & flattenMin(ResultNode & r) const { return r; }
    virtual ResultNode & flattenAnd(ResultNode & r) const { return r; }
    virtual ResultNode &  flattenOr(ResultNode & r) const { return r; }
    virtual ResultNode & flattenXor(ResultNode & r) const { return r; }
    virtual ResultNode & flattenSumOfSquared(ResultNode & r) const { return r; }
    virtual void min(const ResultNode & b) { (void) b; }
    virtual void max(const ResultNode & b) { (void) b; }
    virtual void add(const ResultNode & b) { (void) b; }
private:
    virtual size_t onSize() const = 0;
    void set(const ResultNode & rhs) override { (void) rhs; }
    bool isMultiValue() const override { return true; }
};

template <typename B>
struct cmpT {
    struct less {
        bool operator()(const B & a, const B & b) { return a.cmp(b) < 0; }
    };
    struct equal {
        bool operator()(const B & a, const B & b) { return a.cmp(b) == 0; }
    };
};

template <typename B, typename V>
struct contains {
    struct less {
        bool operator()(const B & a, const V & b) { return a.contains(b) < 0; }
    };
    struct equal {
        bool operator()(const B & a, const V & b) { return a.contains(b) == 0; }
    };
};

template <typename B, typename C, typename G>
class ResultNodeVectorT : public ResultNodeVector
{
public:
    DECLARE_NBO_SERIALIZE;
    using Vector = std::vector<B>;
    using BaseType = B;
    ~ResultNodeVectorT() override;
    const Vector & getVector() const noexcept { return _result; }
    Vector & getVector() noexcept { return _result; }
    const ResultNode * find(const ResultNode & key) const override;
    void sort() override;
    void reverse() override;
    ResultNodeVector & push_back(const ResultNode & node) override;
    ResultNodeVector & push_back_safe(const ResultNode & node) override;
    ResultNodeVector & set(size_t index, const ResultNode & node) override;
    const ResultNode & get(size_t index) const override { return _result[index]; }
    ResultNode & get(size_t index) override { return _result[index]; }
    void clear() override { _result.clear(); }
    void resize(size_t sz) override { _result.resize(sz); }
    void reserve(size_t sz) override { _result.reserve(sz); }
    void negate() override;
private:
    void visitMembers(vespalib::ObjectVisitor &visitor) const override { ::visit(visitor, "Vector", _result); }
    size_t onSize() const override { return _result.size(); }
    const vespalib::Identifiable::RuntimeClass & getBaseClass() const override { return B::_RTClass; }
    int64_t onGetInteger(size_t index) const override { return _result[index].getInteger(index); }
    double onGetFloat(size_t index)    const override { return _result[index].getFloat(index); }
    ConstBufferRef onGetString(size_t index, BufferRef buf) const override { return  _result[index].getString(index, buf); }
    size_t hash() const override;
    int onCmp(const Identifiable & b) const override;
    Vector _result;
};

template <typename B, typename C, typename G>
ResultNodeVectorT<B, C, G>::~ResultNodeVectorT() = default;

template <typename B, typename C, typename G>
ResultNodeVector &
ResultNodeVectorT<B, C, G>::set(size_t index, const ResultNode & node)
{
    _result[index].set(node);
    return *this;
}

template <typename B, typename C, typename G>
ResultNodeVector &
ResultNodeVectorT<B, C, G>::push_back_safe(const ResultNode & node)
{
    if (node.inherits(B::classId)) {
        _result.push_back(static_cast<const B &>(node));
    } else {
        B value;
        value.set(node);
        _result.push_back(value);
    }
    return *this;
}

template <typename B, typename C, typename G>
ResultNodeVector &
ResultNodeVectorT<B, C, G>::push_back(const ResultNode & node)
{
    _result.push_back(static_cast<const B &>(node));
    return *this;
}

template <typename B, typename C, typename G>
int
ResultNodeVectorT<B, C, G>::onCmp(const Identifiable & rhs) const
{
    const ResultNodeVectorT & b(static_cast<const ResultNodeVectorT &>(rhs));
    int diff = _result.size() - b._result.size();
    for (size_t i(0), m(_result.size()); (diff == 0) && (i < m); i++) {
        diff = _result[i].cmp(b._result[i]);
    }
    return diff;
}

template <typename B, typename C, typename G>
void
ResultNodeVectorT<B, C, G>::sort()
{
    using LC = cmpT<B>;
    std::sort(_result.begin(), _result.end(), typename LC::less());
}

template <typename B, typename C, typename G>
void
ResultNodeVectorT<B, C, G>::reverse()
{
    std::reverse(_result.begin(), _result.end());
}

template <typename B, typename C, typename G>
size_t
ResultNodeVectorT<B, C, G>::hash() const
{
    size_t h(0);
    for(const auto& elem : _result) {
        h ^= elem.hash();
    }
    return h;
}

template <typename B, typename C, typename G>
void
ResultNodeVectorT<B, C, G>::negate()
{
    for (auto& elem : _result) {
        elem.negate();
    }
}

template <typename B, typename C, typename G>
const ResultNode *
ResultNodeVectorT<B, C, G>::find(const ResultNode & key) const
{
    G getter;
    auto found = std::lower_bound(_result.begin(), _result.end(), getter(key), typename C::less() );
    if (found != _result.end()) {
        typename C::equal equal;
        return equal(*found, getter(key)) ? &(*found) : nullptr;
    }
    return nullptr;
}

template <typename B, typename C, typename G>
vespalib::Serializer &
ResultNodeVectorT<B, C, G>::onSerialize(vespalib::Serializer & os) const
{
    return serialize(_result, os);
}

template <typename B, typename C, typename G>
vespalib::Deserializer &
ResultNodeVectorT<B, C, G>::onDeserialize(vespalib::Deserializer & is)
{
    return deserialize(_result, is);
}

struct GetInteger {
    int64_t operator () (const ResultNode & r) { return r.getInteger(); }
};

struct GetFloat {
    double operator () (const ResultNode & r) { return r.getFloat(); }
};

struct GetString {
    ResultNode::BufferRef _tmp;
    ResultNode::ConstBufferRef operator () (const ResultNode & r) { return r.getString(_tmp); }
};

template <typename B>
class NumericResultNodeVectorT : public ResultNodeVectorT<B, cmpT<ResultNode>, vespalib::Identity>
{
public:
    ResultNode & flattenMultiply(ResultNode & r) const override {
        B v;
        v.set(r);
        const std::vector<B> & vec(this->getVector());
        for (const B & item : vec) {
            v.multiply(item);
        }
        r.set(v);
        return r;
    }
    ResultNode & flattenAnd(ResultNode & r) const override {
        Int64ResultNode v;
        v.set(r);
        const std::vector<B> & vec(this->getVector());
        for (const B & item : vec) {
            v.andOp(item);
        }
        r.set(v);
        return r;
    }
    ResultNode & flattenOr(ResultNode & r) const override {
        Int64ResultNode v;
        v.set(r);
        const std::vector<B> & vec(this->getVector());
        for (const B & item : vec) {
            v.orOp(item);
        }
        r.set(v);
        return r;
    }
    ResultNode & flattenXor(ResultNode & r) const override {
        Int64ResultNode v;
        v.set(r);
        const std::vector<B> & vec(this->getVector());
        for (const B & item : vec) {
            v.xorOp(item);
        }
        r.set(v);
        return r;
    }
    ResultNode & flattenSum(ResultNode & r) const override {
        B v;
        v.set(r);
        const std::vector<B> & vec(this->getVector());
        for (const B & item : vec) {
            v.add(item);
        }
        r.set(v);
        return r;
    }
    ResultNode & flattenMax(ResultNode & r) const override {
        B v;
        v.set(r);
        const std::vector<B> & vec(this->getVector());
        for (const B & item : vec) {
            v.max(item);
        }
        r.set(v);
        return r;
    }
    ResultNode & flattenMin(ResultNode & r) const override {
        B v;
        v.set(r);
        const std::vector<B> & vec(this->getVector());
        for (const B & item : vec) {
            v.min(item);
        }
        r.set(v);
        return r;
    }
    ResultNode & flattenSumOfSquared(ResultNode & r) const override {
        B v;
        v.set(r);
        const std::vector<B> & vec(this->getVector());
        for (const B & item : vec) {
            B squared;
            squared.set(item);
            squared.multiply(item);
            v.add(squared);
        }
        r.set(v);
        return r;
    }

};

class BoolResultNodeVector : public NumericResultNodeVectorT<BoolResultNode>
{
public:
    BoolResultNodeVector() noexcept = default;
    DECLARE_RESULTNODE(BoolResultNodeVector);

    const IntegerBucketResultNode& getNullBucket() const override { return IntegerBucketResultNode::getNull(); }
};

class Int8ResultNodeVector : public NumericResultNodeVectorT<Int8ResultNode>
{
public:
    Int8ResultNodeVector() noexcept = default;
    DECLARE_RESULTNODE(Int8ResultNodeVector);

    const IntegerBucketResultNode& getNullBucket() const override { return IntegerBucketResultNode::getNull(); }
};

class Int16ResultNodeVector : public NumericResultNodeVectorT<Int16ResultNode>
{
public:
    Int16ResultNodeVector() = default;
    DECLARE_RESULTNODE(Int16ResultNodeVector);

    const IntegerBucketResultNode& getNullBucket() const override { return IntegerBucketResultNode::getNull(); }
};

class Int32ResultNodeVector : public NumericResultNodeVectorT<Int32ResultNode>
{
public:
    Int32ResultNodeVector() = default;
    DECLARE_RESULTNODE(Int32ResultNodeVector);

    const IntegerBucketResultNode& getNullBucket() const override { return IntegerBucketResultNode::getNull(); }
};

class Int64ResultNodeVector : public NumericResultNodeVectorT<Int64ResultNode>
{
public:
    Int64ResultNodeVector() = default;
    DECLARE_RESULTNODE(Int64ResultNodeVector);

    const IntegerBucketResultNode& getNullBucket() const override { return IntegerBucketResultNode::getNull(); }
};

using IntegerResultNodeVector = Int64ResultNodeVector;

class EnumResultNodeVector : public NumericResultNodeVectorT<EnumResultNode>
{
public:
    EnumResultNodeVector() = default;
    DECLARE_RESULTNODE(EnumResultNodeVector);
};

class FloatResultNodeVector : public NumericResultNodeVectorT<FloatResultNode>
{
public:
    FloatResultNodeVector() = default;
    DECLARE_RESULTNODE(FloatResultNodeVector);

    const FloatBucketResultNode& getNullBucket() const override { return FloatBucketResultNode::getNull(); }
};

class StringResultNodeVector : public ResultNodeVectorT<StringResultNode, cmpT<ResultNode>, vespalib::Identity>
{
public:
    StringResultNodeVector() = default;
    DECLARE_RESULTNODE(StringResultNodeVector);

    const StringBucketResultNode& getNullBucket() const override { return StringBucketResultNode::getNull(); }
};

class RawResultNodeVector : public ResultNodeVectorT<RawResultNode, cmpT<ResultNode>, vespalib::Identity>
{
public:
    RawResultNodeVector() = default;
    DECLARE_RESULTNODE(RawResultNodeVector);

    const RawBucketResultNode& getNullBucket() const override { return RawBucketResultNode::getNull(); }
};

class IntegerBucketResultNodeVector : public ResultNodeVectorT<IntegerBucketResultNode, contains<IntegerBucketResultNode, int64_t>, GetInteger >
{
public:
    IntegerBucketResultNodeVector() = default;
    DECLARE_RESULTNODE(IntegerBucketResultNodeVector);
};

class FloatBucketResultNodeVector : public ResultNodeVectorT<FloatBucketResultNode, contains<FloatBucketResultNode, double>, GetFloat >
{
public:
    FloatBucketResultNodeVector() = default;
    DECLARE_RESULTNODE(FloatBucketResultNodeVector);
};

class StringBucketResultNodeVector : public ResultNodeVectorT<StringBucketResultNode, contains<StringBucketResultNode, ResultNode::ConstBufferRef>, GetString >
{
public:
    StringBucketResultNodeVector() = default;
    DECLARE_RESULTNODE(StringBucketResultNodeVector);
};

class RawBucketResultNodeVector : public ResultNodeVectorT<RawBucketResultNode, contains<RawBucketResultNode, ResultNode::ConstBufferRef>, GetString >
{
public:
    RawBucketResultNodeVector() = default;
    DECLARE_RESULTNODE(RawBucketResultNodeVector);
};

class GeneralResultNodeVector : public ResultNodeVector
{
public:
    DECLARE_EXPRESSIONNODE(GeneralResultNodeVector);
    const ResultNode * find(const ResultNode & key) const override;
    ResultNodeVector & push_back(const ResultNode & node) override { _v.push_back(node); return *this; }
    ResultNodeVector & push_back_safe(const ResultNode & node) override { _v.push_back(node); return *this; }
    const ResultNode & get(size_t index) const override { return *_v[index]; };
    ResultNodeVector & set(size_t index, const ResultNode & node) override { _v[index] = node; return *this; }
    ResultNode & get(size_t index) override { return *_v[index]; }
    void clear() override { _v.clear(); }
    void resize(size_t sz) override { _v.resize(sz); }
    void reserve(size_t sz) override { _v.reserve(sz); }
private:
    int64_t onGetInteger(size_t index) const override { return _v[index]->getInteger(index); }
    double onGetFloat(size_t index)    const override { return _v[index]->getFloat(index); }
    ConstBufferRef onGetString(size_t index, BufferRef buf) const override { return  _v[index]->getString(index, buf); }
    size_t hash() const override;
    size_t onSize() const override { return _v.size(); }
    std::vector<ResultNode::CP> _v;
};

}