/* Copyright 2021 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_CC_EXPERIMENTAL_LIBTF_IMPL_TENSOR_SPEC_H_
#define TENSORFLOW_CC_EXPERIMENTAL_LIBTF_IMPL_TENSOR_SPEC_H_

#include <iosfwd>

#include "tensorflow/core/framework/tensor_shape.h"
#include "tensorflow/core/framework/types.pb.h"

namespace tf {
namespace libtf {
namespace impl {
/// @brief The TensorSpec struct.
///
/// The TensorSpec describes the shape and dtype of a Tensor.

struct TensorSpec {
  tensorflow::PartialTensorShape shape;
  tensorflow::DataType dtype;

  bool operator==(const TensorSpec& o) const {
    return dtype == o.dtype && shape.IsIdenticalTo(o.shape);
  }

  /// Overload AbslHashValue to make TensorSpec hashable.
  template <typename H>
  friend H AbslHashValue(H h, const TensorSpec& t) {
    return H::combine(std::move(h), t.shape.DebugString(), t.dtype);
  }
};

// Defined in `iostream.cc`.
std::ostream& operator<<(std::ostream& o, const TensorSpec& x);

}  // namespace impl
}  // namespace libtf
}  // namespace tf

#endif  // TENSORFLOW_CC_EXPERIMENTAL_LIBTF_IMPL_TENSOR_SPEC_H_
