summaryrefslogtreecommitdiff
path: root/number.h
blob: d93ed70879493b0b89ce88a7020087d6cc516285 (plain)
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
#pragma once

#include <list>
#include <ostream>

#include <cstdint>

class number {
public:
    number() = default;
    number(const number &) = default;
    number(number &&) = default;

    number &operator=(const number &) = default;

    number(std::uint32_t);

    /**
     * \brief Return a hexadecimal string representation of this number.
     */
    std::string to_hex_string() const;

    /**
     * \brief Return a decimal string representation of this number.
     */
    std::string to_dec_string() const;

    /**
     * \brief Return a 32-bits-wide integer that corresponds to this number.
     *
     * \throws std::out_of_range The number cannot be represented by a single
     * 32-bits-wide integer.
     */
    std::uint32_t to_uint32() const;

    /**
     * \brief Return the result of the addition of a number and this number.
     *
     * \param n The number to add to this number.
     */
    number operator+(const number &n) const;

    /**
     * \brief Return the result of the multiplication of a number and this
     * number.
     *
     * \param n The number to multiply with this number.
     */
    number operator*(const number &) const;

    /**
     * \brief Tells whether the number passed as parameter is strictly less
     * than this number.
     *
     * \param n The number to compare with this number.
     */
    bool operator<(const number &n) const;

    /**
     * \brief Tells whether the number passed as parameter is strictly greater
     * than this number.
     *
     * \param n The number to compare with this number.
     */
    bool operator>(const number &n) const;

    /**
     * \brief Tells whether the number passed as parameter is less than or
     * equal to this number.
     *
     * \param n The number to compare with this number.
     */
    bool operator<=(const number &n) const;

    /**
     * \brief Tells whether the number passed as parameter is greater than or
     * equal to this number.
     *
     * \param n The number to compare with this number.
     */
    bool operator>=(const number &n) const;

    /**
     * \brief Tells whether the number passed as parameter is equal to this
     * number.
     *
     * \param n The number to compare with this number.
     */
    bool operator==(const number &n) const;

    /**
     * \brief Tells whether the number passed as parameter is not equal to this
     * number.
     *
     * \param n The number to compare with this number.
     */
    bool operator!=(const number &n) const;

    /**
     * \brief Add a number to this number.
     *
     * \param n Number to add to this number.
     */
    number &operator+=(const number &n);

    /**
     * \brief Increment this number.
     */
    number &operator++();

private:
     /* First item is the least significant. */
    std::list<std::uint32_t> _operands;
};

std::ostream &operator<<(std::ostream &, const number &);