reshape_test_common.h

/* Copyright 2020 The TensorFlow Authors. 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 TENSORFLOW_LITE_KERNELS_RESHAPE_TEST_COMMON_H_
#define TENSORFLOW_LITE_KERNELS_RESHAPE_TEST_COMMON_H_

#include <stdint.h>

#include <initializer_list>
#include <string>
#include <vector>

#include "tensorflow/lite/kernels/test_util.h"
#include "tensorflow/lite/schema/schema_generated.h"
#include "tensorflow/lite/string_type.h"

namespace tflite {
// There are three ways to specify the output shape of a Reshape
// op.
enum class ShapeSpecificationType {
  // The output shape is hardcoded in the ReshapeOptions object.
  kAsReshapeOption,
  // The output shape is specified as an input tensor, which is connected to a
  // Const node, which is guaranteed not to change once inference starts. The
  // shape is also hardcoded as in kAsReshapeOption.
  kAsConstantTensor,
  // The output shape is specified as an input tensor that can change based on
  // external input. That is, the shape is not know before the inference
  // starts. The shape is also hardcoded as in kAsReshapeOption.
  kAsTensor,
};

template <typename T, typename BASE = SingleOpModel>
class ReshapeOpModel : public BASE {
 public:
  ReshapeOpModel(std::initializer_list<int> input_shape,
                 std::initializer_list<int> shape_shape,
                 std::initializer_list<int> shape_data,
                 ShapeSpecificationType shape_type,
                 const std::vector<T>* input_data = nullptr) {
    this->SetBypassDefaultDelegates();
    switch (shape_type) {
      case ShapeSpecificationType::kAsTensor:
        this->BuildWithTensorShape(input_shape, shape_shape, shape_data,
                                   input_data);
        break;
      case ShapeSpecificationType::kAsConstantTensor:
        this->BuildWithConstantTensorShape(input_shape, shape_shape, shape_data,
                                           input_data);
        break;
      case ShapeSpecificationType::kAsReshapeOption:
        // In this case the shape of the new shape doesn't matter. It is
        // always hardcoded as a flat vector.
        this->BuildWithHardcodedShape(input_shape, shape_data, input_data);
        break;
    }
  }

  void SetInput(std::vector<T> data) {
    this->template PopulateTensor<T>(input_, data);
  }

  void SetStringInput(std::initializer_list<string> data) {
    this->PopulateStringTensor(input_, data);
  }

  std::vector<T> GetOutput() {
    return this->template ExtractVector<T>(output_);
  }
  std::vector<int> GetOutputShape() { return this->GetTensorShape(output_); }

 private:
  void BuildWithHardcodedShape(std::initializer_list<int> input_shape,
                               std::initializer_list<int> shape_data,
                               const std::vector<T>* input_data = nullptr) {
    if (input_data != nullptr) {
      input_ =
          this->AddConstInput(GetTensorType<T>(), *input_data, input_shape);
    } else {
      input_ = this->AddInput({GetTensorType<T>(), input_shape});
    }
    output_ = this->AddOutput(GetTensorType<T>());
    this->SetBuiltinOp(
        BuiltinOperator_RESHAPE, BuiltinOptions_ReshapeOptions,
        CreateReshapeOptions(
            this->builder_,
            this->builder_.template CreateVector<int>(shape_data))
            .Union());
    this->BuildInterpreter({this->GetShape(input_)});
  }

  void BuildWithTensorShape(std::initializer_list<int> input_shape,
                            std::initializer_list<int> shape_shape,
                            std::initializer_list<int> shape_data,
                            const std::vector<T>* input_data = nullptr) {
    if (input_data != nullptr) {
      input_ =
          this->AddConstInput(GetTensorType<T>(), *input_data, input_shape);
    } else {
      input_ = this->AddInput({GetTensorType<T>(), input_shape});
    }
    output_ = this->AddOutput(GetTensorType<T>());
    int shape_input_tensor = this->AddInput({TensorType_INT32, shape_shape});
    // Note how shape also appears in ReshapeOptions
    this->SetBuiltinOp(
        BuiltinOperator_RESHAPE, BuiltinOptions_ReshapeOptions,
        CreateReshapeOptions(
            this->builder_,
            this->builder_.template CreateVector<int>(shape_data))
            .Union());
    this->BuildInterpreter(
        {this->GetShape(input_), this->GetShape(shape_input_tensor)});
    if (shape_data.size() != 0) {
      this->template PopulateTensor<int32_t>(shape_input_tensor, shape_data);
    }
  }

  void BuildWithConstantTensorShape(
      std::initializer_list<int> input_shape,
      std::initializer_list<int> shape_shape,
      std::initializer_list<int> shape_data,
      const std::vector<T>* input_data = nullptr) {
    if (input_data != nullptr) {
      input_ =
          this->AddConstInput(GetTensorType<T>(), *input_data, input_shape);
    } else {
      input_ = this->AddInput({GetTensorType<T>(), input_shape});
    }
    output_ = this->AddOutput(GetTensorType<T>());
    this->AddConstInput(TensorType_INT32, shape_data, shape_shape);
    // Note how the shape also appears in the ReshapeOptions.
    this->SetBuiltinOp(
        BuiltinOperator_RESHAPE, BuiltinOptions_ReshapeOptions,
        CreateReshapeOptions(
            this->builder_,
            this->builder_.template CreateVector<int>(shape_data))
            .Union());
    this->BuildInterpreter({this->GetShape(input_)});
  }

  int input_;
  int output_;
};

}  // namespace tflite

#endif  // TENSORFLOW_LITE_KERNELS_RESHAPE_TEST_COMMON_H_