167 lines
3.6 KiB
C++
167 lines
3.6 KiB
C++
// Copyright (C) 2018-2021 Intel Corporation
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
|
|
/**
|
|
* @brief This header file defines the main Data representation node.
|
|
*
|
|
* @file ie_data.h
|
|
*/
|
|
#pragma once
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "ie_common.h"
|
|
#include "ie_layouts.h"
|
|
#include "ie_precision.hpp"
|
|
|
|
namespace InferenceEngine {
|
|
|
|
/**
|
|
* @brief This class represents the main Data representation node.
|
|
*
|
|
* The NN graphs are di-graphs consisting of data nodes and layer nodes.
|
|
*/
|
|
class INFERENCE_ENGINE_API_CLASS(Data) {
|
|
class Impl;
|
|
public:
|
|
/**
|
|
* @brief An empty constructor (dimensionless)
|
|
*
|
|
* @param name Name of the data node
|
|
* @param _precision Precision of the data
|
|
* @param layout Data layout
|
|
*/
|
|
Data(const std::string& name, Precision _precision, Layout layout = NCHW);
|
|
|
|
/**
|
|
* @brief A constructor with tensor descriptor
|
|
*
|
|
* @param name Name of the data node
|
|
* @param desc Tensor descriptor
|
|
*/
|
|
Data(const std::string& name, const TensorDesc& desc);
|
|
|
|
/**
|
|
* @brief A copy constructor
|
|
*
|
|
* @param data A data object to copy from
|
|
*/
|
|
Data(const Data& data);
|
|
|
|
/**
|
|
* @brief An assignment operator
|
|
*
|
|
* @param data A data object to copy from
|
|
* @return An assigned object
|
|
*/
|
|
Data & operator = (const Data& data);
|
|
|
|
/**
|
|
* @brief Checks if the current node is resolved
|
|
*
|
|
* @return true if resolved, false otherwise.
|
|
*/
|
|
bool isInitialized() const;
|
|
|
|
/**
|
|
* @brief Sets the data dimensions.
|
|
*
|
|
* After the current node is marked as resolved.
|
|
*
|
|
* @param a_dims Tensor dimensions to set
|
|
*/
|
|
void setDims(const SizeVector& a_dims);
|
|
|
|
/**
|
|
* @brief Sets the layout value for this Data instance
|
|
*
|
|
* @param layout Layout value to set
|
|
*/
|
|
void setLayout(Layout layout);
|
|
|
|
/**
|
|
* @brief changes dims and layout at same time
|
|
*
|
|
* @param dims new dimensions
|
|
* @param layout new layout
|
|
*/
|
|
void reshape(const SizeVector& dims, Layout layout);
|
|
|
|
/**
|
|
* @brief Gets the layout value for this Data instance
|
|
* @return Layout
|
|
*/
|
|
Layout getLayout() const;
|
|
|
|
/**
|
|
* @brief Gets Tensor descriptor reference
|
|
*
|
|
* @return reference to TensorDesc
|
|
*/
|
|
const TensorDesc& getTensorDesc() const;
|
|
|
|
/**
|
|
* @brief Gets a precision type of this Data instance
|
|
*
|
|
* @return Precision type
|
|
*/
|
|
const Precision& getPrecision() const;
|
|
|
|
/**
|
|
* @brief Sets a precision type of this Data instance
|
|
*
|
|
* @param precision Precision of the data
|
|
*/
|
|
void setPrecision(const Precision& precision);
|
|
|
|
/**
|
|
* @return data dimensions
|
|
*/
|
|
const SizeVector& getDims() const;
|
|
|
|
/**
|
|
* @return name of the data object
|
|
*/
|
|
const std::string& getName() const;
|
|
|
|
/**
|
|
* @brief Sets a name the Data object
|
|
*
|
|
* @param newName Name of the data node
|
|
*/
|
|
|
|
void setName(const std::string& newName);
|
|
|
|
/**
|
|
* @return convenient arbitrary user data holder
|
|
*/
|
|
const UserValue& getUserObject() const;
|
|
|
|
/**
|
|
* @private
|
|
* @brief Don't touch this field. An implementation details for Data object.
|
|
*/
|
|
std::shared_ptr<Impl> _impl;
|
|
|
|
private:
|
|
/**
|
|
* @brief A unique name that identifies this data node
|
|
*/
|
|
std::string name;
|
|
|
|
/**
|
|
* @brief A user utility place holder
|
|
*/
|
|
UserValue userObject;
|
|
|
|
/**
|
|
* @brief A tensor descriptor
|
|
*/
|
|
mutable TensorDesc tensorDesc;
|
|
};
|
|
} // namespace InferenceEngine
|