aboutsummaryrefslogtreecommitdiff
path: root/tests/UserConfiguration.h
blob: dad0960bdbe874fbe340bad0ae3ce80b65188249 (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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
 * Copyright (c) 2017 ARM Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef __ARM_COMPUTE_TEST_USER_CONFIGURATION_H__
#define __ARM_COMPUTE_TEST_USER_CONFIGURATION_H__

#include "arm_compute/core/Error.h"
#include "arm_compute/core/Types.h"

#include <random>
#include <string>

namespace arm_compute
{
namespace test
{
class ProgramOptions;

/** Container providing easy access to runtime options provided by the user. */
struct UserConfiguration
{
protected:
    /** Wrapper around options to store if an option has been set. */
    template <typename T>
    class Option
    {
    public:
        /** Initialise the option to its default (C++) value and mark it as 'not set'. */
        Option();

        /** Initialise the option to the given @p value and mark it as 'set'. */
        Option(const T &value);

        /** Assign the given @p value and mark it as 'set'. */
        Option<T> &operator=(const T &value);

        /** Query if the option has been set. */
        constexpr bool is_set() const;

        /** Return the underlying value as constant. */
        T get() const;

        /** Return the underlying value. */
        T &get();

        /** Implicitly return the underlying value. */
        operator T() const;

    private:
        T    _value;
        bool _is_set;
    };

public:
    UserConfiguration() = default;

    /** Initialise the configuration according to the program options.
     *
     * @param[in] options Parsed command line options.
     */
    UserConfiguration(const ProgramOptions &options);

    Option<std::string>                     path{};
    Option<std::random_device::result_type> seed{};
    Option<unsigned int>                    threads{};
};

template <typename T>
UserConfiguration::Option<T>::Option()
    : _value{}, _is_set{ false }
{
}

template <typename T>
UserConfiguration::Option<T>::Option(const T &value)
    : _value{ value }, _is_set{ true }
{
}

template <typename T>
UserConfiguration::Option<T> &UserConfiguration::Option<T>::operator=(const T &value)
{
    _value  = value;
    _is_set = true;

    return *this;
}

template <typename T>
constexpr bool UserConfiguration::Option<T>::is_set() const
{
    return _is_set;
}

template <typename T>
T UserConfiguration::Option<T>::get() const
{
    ARM_COMPUTE_ERROR_ON(!is_set());
    return _value;
}

template <typename T>
T &UserConfiguration::Option<T>::get()
{
    return _value;
}

template <typename T>
UserConfiguration::Option<T>::operator T() const
{
    ARM_COMPUTE_ERROR_ON(!is_set());
    return _value;
}
} // namespace test
} // namespace arm_compute
#endif