Compute Library
 20.11
IDistribution.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2019 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_IDISTRIBUTION_H
25 #define ARM_COMPUTE_IDISTRIBUTION_H
26 
27 #include <cstddef>
28 #include <cstdint>
29 
30 namespace arm_compute
31 {
32 /** Interface for distribution objects */
34 {
35 public:
36  /** Default virtual destructor */
37  virtual ~IDistribution() = default;
38  /** Returns the dimensions of the distribution.
39  *
40  * @note This is fixed to 1-dimensional distribution for now.
41  * @return Dimensions of the distribution.
42  */
43  virtual size_t dimensions() const = 0;
44  /** Returns the total size in bytes of the distribution.
45  *
46  * @return Total size of the distribution in bytes.
47  */
48  virtual size_t size() const = 0;
49  /** Returns a pointer to the start of the distribution.
50  * Other elements of the array can be accessed using buffer()[idx] for 0 <= idx < num_bins()
51  *
52  * @return Pointer to the start of the distribution.
53  */
54  virtual uint32_t *buffer() const = 0;
55  /** Clears the distribution by setting every element to zero. */
56  void clear() const;
57 };
58 }
59 #endif /* ARM_COMPUTE_IDISTRIBUTION_H */
Copyright (c) 2017-2020 Arm Limited.
virtual uint32_t * buffer() const =0
Returns a pointer to the start of the distribution.
virtual size_t dimensions() const =0
Returns the dimensions of the distribution.
virtual size_t size() const =0
Returns the total size in bytes of the distribution.
Interface for distribution objects.
Definition: IDistribution.h:33
virtual ~IDistribution()=default
Default virtual destructor.
void clear() const
Clears the distribution by setting every element to zero.