summaryrefslogtreecommitdiff
path: root/compiler/coco/generic/include/coco/ADT/Span.h
blob: 240e6afec28e54f48915d5c2dac2e05659c8b5bb (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
/*
 * Copyright (c) 2018 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __COCO_ADT_SPAN_H__
#define __COCO_ADT_SPAN_H__

#include <cstdint>
#include <cassert>

namespace coco
{

/**
 * @brief A Span is a non-owing reference to a memory chunk
 *
 * @note A Span DOES NOT OWN a memory chunk.
 */
template <typename T> class Span
{
public:
  Span(T *data, uint32_t size) : _data{data}, _size{size}
  {
    // DO NOTHING
  }

public:
  T *data(void) { return _data; }
  const T *data(void) const { return _data; }

public:
  uint32_t size(void) const { return _size; }

public:
  T &operator[](uint32_t n)
  {
    assert(n < _size);
    return *(_data + n);
  }

public:
  const T &operator[](uint32_t n) const
  {
    assert(n < _size);
    return *(_data + n);
  }

private:
  T *_data;
  uint32_t _size;
};

} // namespace coco

#endif // __COCO_ADT_SPAN_H__