summaryrefslogtreecommitdiffstats
path: root/document/src/vespa/document/select/orderingspecification.h
blob: 370197dd8e9392984ef05237dffb905386373de8 (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
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once

#include <vespa/fastos/types.h>
#include <vespa/vespalib/stllike/string.h>

namespace document {

class OrderingSpecification {
public:
    typedef std::unique_ptr<OrderingSpecification> UP;

    enum Order { ASCENDING = 0, DESCENDING };

    OrderingSpecification()
        : _order(ASCENDING), _orderingStart(0), _widthBits(0), _divisionBits(0) {};

    OrderingSpecification(Order order)
        : _order(order), _orderingStart(0), _widthBits(0), _divisionBits(0) {};

    OrderingSpecification(Order order, uint64_t orderingStart, uint16_t widthBits, uint16_t divisionBits)
        : _order(order), _orderingStart(orderingStart), _widthBits(widthBits), _divisionBits(divisionBits) {}

    Order getOrder() const { return _order; }
    uint64_t getOrderingStart() const { return _orderingStart; }
    uint16_t getWidthBits() const { return _widthBits; }
    uint16_t getDivisionBits() const { return _divisionBits; }

    bool operator==(const OrderingSpecification& other) const;

    vespalib::string toString() const;

private:
    Order _order;
    uint64_t _orderingStart;
    uint16_t _widthBits;
    uint16_t _divisionBits;
};

std::ostream&
operator<<(std::ostream& out, const OrderingSpecification& o);

}