summaryrefslogtreecommitdiff
path: root/arm_compute/graph/Tensor.h
blob: dbe2ba595911917e380c9cfcc04e37d0d8e13408 (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
137
/*
 * 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_GRAPH_TENSOR_H__
#define __ARM_COMPUTE_GRAPH_TENSOR_H__

#include "arm_compute/graph/ITensorAccessor.h"
#include "arm_compute/graph/Types.h"
#include "support/ToolchainSupport.h"

#include <memory>

namespace arm_compute
{
namespace graph
{
/** Tensor class */
class Tensor
{
public:
    /** Constructor
     *
     * @param[in] info Tensor info to use
     */
    Tensor(TensorInfo &&info);
    /** Constructor
     *
     * @param[in] accessor Tensor accessor
     */
    template <typename AccessorType>
    Tensor(std::unique_ptr<AccessorType> accessor)
        : _target(TargetHint::DONT_CARE), _info(), _accessor(std::move(accessor)), _tensor(nullptr)
    {
    }
    /** Constructor
     *
     * @param[in] accessor Tensor accessor
     */
    template <typename AccessorType>
    Tensor(AccessorType &&accessor)
        : _target(TargetHint::DONT_CARE), _info(), _accessor(arm_compute::support::cpp14::make_unique<AccessorType>(std::forward<AccessorType>(accessor))), _tensor(nullptr)
    {
    }
    /** Constructor
     *
     * @param[in] info     Tensor info to use
     * @param[in] accessor Tensor accessor
     */
    template <typename AccessorType>
    Tensor(TensorInfo &&info, std::unique_ptr<AccessorType> &&accessor)
        : _target(TargetHint::DONT_CARE), _info(info), _accessor(std::move(accessor)), _tensor(nullptr)
    {
    }
    /** Constructor
     *
     * @param[in] info     Tensor info to use
     * @param[in] accessor Tensor accessor
     */
    template <typename AccessorType>
    Tensor(TensorInfo &&info, AccessorType &&accessor)
        : _target(TargetHint::DONT_CARE), _info(info), _accessor(arm_compute::support::cpp14::make_unique<AccessorType>(std::forward<AccessorType>(accessor))), _tensor(nullptr)
    {
    }
    /** Default Destructor */
    ~Tensor() = default;
    /** Move Constructor
     *
     * @param[in] src Tensor to move
     */
    Tensor(Tensor &&src) noexcept;

    /** Sets the given TensorInfo to the tensor
     *
     * @param[in] info TensorInfo to set
     */
    void set_info(TensorInfo &&info);
    /** Calls accessor on tensor
     *
     * @return True if succeeds else false
     */
    bool call_accessor();
    /** Sets target of the tensor
     *
     * @param[in] target Target where the tensor should be pinned in
     *
     * @return
     */
    ITensor *set_target(TargetHint target);
    /** Returns tensor's TensorInfo
     *
     * @return TensorInfo of the tensor
     */
    const TensorInfo &info() const;
    /** Returns a pointer to the internal tensor
     *
     * @return Tensor
     */
    ITensor *tensor();
    /** Allocates and fills the tensor if needed */
    void allocate_and_fill_if_needed();
    /** Allocates the tensor */
    void allocate();
    /** Return the target that this tensor is pinned on
     *
     * @return Target of the tensor
     */
    TargetHint target() const;

private:
    TargetHint                       _target;   /**< Target that this tensor is pinned on */
    TensorInfo                       _info;     /**< Tensor metadata */
    std::unique_ptr<ITensorAccessor> _accessor; /**< Tensor Accessor */
    std::unique_ptr<ITensor>         _tensor;   /**< Tensor */
};
} // namespace graph
} // namespace arm_compute
#endif /* __ARM_COMPUTE_GRAPH_TENSOR_H__ */