output.hpp

//*****************************************************************************
// Copyright 2017-2021 Intel Corporation
//
// 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.
//*****************************************************************************
 
#pragma once
 
#include <memory>
#include <string>
#include <unordered_set>
#include <vector>
 
#include "ngraph/descriptor/input.hpp"
#include "ngraph/descriptor/tensor.hpp"
#include "ngraph/node_output.hpp"
 
namespace ngraph
{
    // The forward declaration of Node is needed here because Node has a deque of
    // Outputs, and Output is an incomplete type at this point. STL containers of
    // incomplete type have undefined behavior according to the C++11 standard, and
    // in practice including node.hpp here was causing compilation errors on some
    // systems (namely macOS).
    class Node;
 
    namespace descriptor
    {
        // Describes an output tensor of an op
        class NGRAPH_API Output
        {
        public:
            Output()
                : m_node(nullptr)
                , m_index(0)
                , m_tensor(nullptr)
                , m_inputs()
            {
            }
 
            /// \param node Node that owns this output.
            /// \param index Position of the output tensor in all output tensors
            /// \param tensor The tensor where the value will be written
            Output(Node* node, size_t index, const std::shared_ptr<Tensor>& tensor);
 
            std::shared_ptr<Node> get_node() const;
            size_t get_index() const { return m_index; }
            ngraph::Output<Node> get_output() const;
            std::shared_ptr<Tensor> get_tensor_ptr() const { return m_tensor; }
            void set_tensor_ptr(const std::shared_ptr<Tensor>& tensor) { m_tensor = tensor; }
            void add_input(Input* input);
            void remove_input(Input* input);
            const std::vector<Input*>& get_inputs() const { return m_inputs; }
            Tensor& get_tensor() const;
 
            /// \return the shape of the output
            const Shape& get_shape() const;
 
            /// \return the partial shape of the output
            const PartialShape& get_partial_shape() const;
 
            /// \return the element type of the output
            const element::Type& get_element_type() const;
 
            Output(const Output&) = default;
            Output(Output&&) = default;
            Output& operator=(const Output&) = default;
 
        protected:
            Node* m_node;
            size_t m_index;
            std::shared_ptr<Tensor> m_tensor;
            std::vector<Input*> m_inputs;
        };
    }
}