aboutsummaryrefslogtreecommitdiffstats
path: root/document/src/vespa/document/fieldvalue/weightedsetfieldvalue.h
blob: 74a51da616f8515623274e97b20c01931fb21924 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
/**
 * \class document::WeightedSetFieldValue
 * \ingroup fieldvalue
 *
 * \brief A fieldvalue containing fieldvalue <-> weight mappings.
 */
#pragma once

#include "collectionfieldvalue.h"
#include "mapfieldvalue.h"
#include "intfieldvalue.h"
#include <map>

namespace document {

class WeightedSetFieldValue final : public CollectionFieldValue
{
public:
    struct FieldValuePtrOrder {
        template<typename T> bool operator()(const T& s1, const T& s2) const
            { return *s1 < *s2; }
    };
    using WeightedFieldValueMap = MapFieldValue;

private:
    std::shared_ptr<const MapDataType> _map_type;
    WeightedFieldValueMap _map;

    void verifyKey(const FieldValue & key);
    bool addValue(const FieldValue& fval) override { return add(fval, 1); }
    bool containsValue(const FieldValue& val) const override;
    bool removeValue(const FieldValue& val) override;
    fieldvalue::ModificationStatus onIterateNested(PathRange nested, fieldvalue::IteratorHandler& handler) const override;
public:
    using UP = std::unique_ptr<WeightedSetFieldValue>;

    /**
     * @param wsetType Type of the weighted set. Must be a WeightedSetDataType,
     *                 but does not enforce type compile time so it will be
     *                 easier to create instances using field's getDataType().
     */
    WeightedSetFieldValue(const DataType &wsetType);
    WeightedSetFieldValue(const WeightedSetFieldValue &);
    WeightedSetFieldValue & operator = (const WeightedSetFieldValue &);
    WeightedSetFieldValue(WeightedSetFieldValue &&) = default;
    WeightedSetFieldValue & operator = (WeightedSetFieldValue &&) = default;
    ~WeightedSetFieldValue() override;

    void accept(FieldValueVisitor &visitor) override { visitor.visit(*this); }
    void accept(ConstFieldValueVisitor &visitor) const override { visitor.visit(*this); }

    /**
     * Add an item to the weighted set with the given weight. If removeIfZero
     * is set in the data type and weight is zero, the new item will not be
     * added and any existing item for the key will be immediately removed.
     */
    bool add(const FieldValue&, int32_t weight = 1);
    /**
     * Add an item to the weighted set, but do not erase the item if the
     * weight is zero and removeIfZero is set in the weighted set's type.
     */
    bool addIgnoreZeroWeight(const FieldValue&, int32_t weight = 1);
    void push_back(FieldValue::UP, int32_t weight);
    void increment(const FieldValue& fval, int val = 1);
    void decrement(const FieldValue& fval, int val = 1) { increment(fval, -1*val); }
    int32_t get(const FieldValue&, int32_t defaultValue = 0) const;

    bool isEmpty() const override { return _map.isEmpty(); }
    size_t size() const override { return _map.size(); }
    void clear() override { _map.clear(); }
    void reserve(size_t sz) { _map.reserve(sz); }
    void resize(size_t sz) { _map.resize(sz); }

    FieldValue& assign(const FieldValue&) override;
    WeightedSetFieldValue* clone() const override { return new WeightedSetFieldValue(*this); }
    int compare(const FieldValue&) const override;
    void printXml(XmlOutputStream& out) const override;
    void print(std::ostream& out, bool verbose, const std::string& indent) const override;

    // Implements iterating through internal content.
    using const_iterator = WeightedFieldValueMap::const_iterator;
    using iterator = WeightedFieldValueMap::iterator;

    const_iterator begin() const { return _map.begin(); }
    iterator begin() { return _map.begin(); }

    const_iterator end() const { return _map.end(); }
    iterator end() { return _map.end(); }

    const_iterator find(const FieldValue& fv) const;
    iterator find(const FieldValue& fv);
};

} // document