mindspore2022/mindspore/lite/include/ms_tensor.h

/**
 * Copyright 2020 Huawei Technologies Co., Ltd
 *
 * 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 MINDSPORE_LITE_INCLUDE_MS_TENSOR_H_
#define MINDSPORE_LITE_INCLUDE_MS_TENSOR_H_

#include <vector>
#include "include/lite_utils.h"
#include "ir/dtype/type_id.h"

namespace mindspore {
enum Format : int64_t;

namespace tensor {
/// \brief MSTensor defined tensor in MindSpore Lite.
class MS_API MSTensor {
 public:
  /// \brief Constructor of MindSpore Lite MSTensor.
  ///
  /// \return Instance of MindSpore Lite MSTensor.
  MSTensor() = default;

  /// \brief Destructor of MindSpore Lite Model.
  virtual ~MSTensor() = default;

  /// \brief Create a MSTensor.
  ///
  /// \return Pointer to an instance of MindSpore Lite MSTensor.
  static MSTensor *CreateTensor(const String &name, TypeId type, const Vector<int> &shape, const void *data,
                                size_t data_len);

  /// \brief Set memory allocator for current MSTensor.
  ///
  /// \param[in] allocator Define memory allocator, which is shown in allocator.h.
  virtual void set_allocator(AllocatorPtr allocator) = 0;

  /// \brief Get memory allocator of current MSTensor.
  ///
  /// \return Pointer of memory allocator class.
  virtual AllocatorPtr allocator() const = 0;

  /// \brief Get data type of the MindSpore Lite MSTensor.
  ///
  /// \note TypeId is defined in mindspore/mindspore/include/api/type_id.h. Only number types in TypeId enum are
  /// suitable for MSTensor.
  ///
  /// \return MindSpore Lite TypeId of the MindSpore Lite MSTensor.
  virtual TypeId data_type() const = 0;

  /// \brief Set data type of current MSTensor.
  ///
  /// \param[in] data_type Define data type, which is shown in type_id.h.
  virtual void set_data_type(TypeId data_type) = 0;

  /// \brief Set format of current MSTensor.
  ///
  /// \param[in] format Define format of data, which is shown in format.h
  virtual void set_format(mindspore::Format format) = 0;

  /// \brief Get format of current MSTensor.
  ///
  /// \return format, which is shown in format.h
  virtual mindspore::Format format() const = 0;

  /// \brief Get shape of the MindSpore Lite MSTensor.
  ///
  /// \return A vector of int as the shape of the MindSpore Lite MSTensor.
  virtual Vector<int> shape() const = 0;

  /// \brief Set the shape of MSTensor.
  virtual void set_shape(const Vector<int> &shape) = 0;

  /// \brief Get number of element in MSTensor.
  ///
  /// \return Number of element in MSTensor.
  virtual int ElementsNum() const = 0;

  /// \brief Get byte size of data in MSTensor.
  ///
  /// \return Byte size of data in MSTensor.
  virtual size_t Size() const = 0;

  /// \brief Get the name of MSTensor.
  ///
  /// \return the name of MSTensor.
  virtual String tensor_name() const = 0;

  /// \brief Set the name of MSTensor.
  virtual void set_tensor_name(const String &name) = 0;

  /// \brief Get the pointer of data in MSTensor.
  ///
  /// \note The data pointer can be used to both write and read data in MSTensor. The memory buffer will be
  /// automatically allocated.
  ///
  /// \return the pointer points to data in MSTensor.
  virtual void *MutableData() = 0;

  /// \brief Get the pointer of data in MSTensor.
  ///
  /// \note The data pointer can be used to both write and read data in MSTensor. No memory buffer will be
  /// allocated.
  ///
  /// \return the pointer points to data in MSTensor.
  virtual void *data() = 0;

  /// \brief Set the data of MSTensor.
  virtual void set_data(void *data) = 0;

  virtual Vector<lite::LiteQuantParam> quant_params() const = 0;

  virtual void set_quant_params(Vector<lite::LiteQuantParam>) = 0;
};
}  // namespace tensor
}  // namespace mindspore
#endif  // MINDSPORE_LITE_INCLUDE_MS_TENSOR_H_