Index.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Samsung Electronics Co., Ltd. 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 __ONERT_IR_TRAIN_INDEX_H__
#define __ONERT_IR_TRAIN_INDEX_H__
 
#include "ir/Index.h"
 
#include <cassert>
#include <cstdint>
#include <utility>
 
namespace onert
{
namespace ir
{
namespace train
{
 
template <typename T> class TrainingIndex
{
public:
  TrainingIndex() : _index{T{}}, _is_forward{true}
  {
    // DO NOTHING
  }
 
  TrainingIndex(const T &index, bool is_forward) : _index{index}, _is_forward{is_forward}
  {
    // DO NOTHING
  }
 
public:
  const T &index() const { return _index; }
  bool is_forward() const { return _is_forward; }
 
public:
  bool valid() const { return _index.valid(); }
 
public:
  bool operator==(const TrainingIndex &other) const
  {
    return (!_index.valid() && !other.index().valid()) ||
           (_index == other.index() && _is_forward == other.is_forward());
  }
  bool operator!=(const TrainingIndex &other) const { return !(*this == other); }
 
  bool operator<(const TrainingIndex &other) const
  {
    return std::hash<TrainingIndex<T>>{}(*this) < std::hash<TrainingIndex<T>>{}(other);
  }
 
private:
  T _index;
  bool _is_forward;
};
 
using TrainingOperationIndex = TrainingIndex<OperationIndex>;
 
using TrainingOperandIndex = TrainingIndex<OperandIndex>;
 
inline std::ostream &operator<<(std::ostream &o, const TrainingOperationIndex &i)
{
  return operator<<(o, i.index());
}
 
inline std::ostream &operator<<(std::ostream &o, const TrainingOperandIndex &i)
{
  return operator<<(o, i.index());
}
 
} // namespace train
} // namespace ir
} // namespace onert
 
namespace std
{
 
template <> struct hash<onert::ir::train::TrainingOperationIndex>
{
  size_t operator()(const onert::ir::train::TrainingOperationIndex &index) const noexcept
  {
    const auto &op_index = index.index();
    const bool is_forward = index.is_forward();
 
    assert(sizeof(op_index) <= 4);
    assert((op_index.undefined() || op_index.value() < (1 << 16)) &&
           "TrainingOperationIndex's hash creation error, operand_index is too big");
    static_assert(
      sizeof(size_t) >= sizeof(uint32_t),
      "TrainingOperationIndex's hash creation error, size_t size is less than uint32_t");
 
    return (static_cast<size_t>(op_index.value())) << 16 | static_cast<size_t>(is_forward);
  }
};
 
} // namespace std
 
namespace std
{
 
template <> struct hash<onert::ir::train::TrainingOperandIndex>
{
  size_t operator()(const onert::ir::train::TrainingOperandIndex &index) const noexcept
  {
    const auto &operand_index = index.index();
    const bool &is_forward = index.is_forward();
 
    assert(sizeof(operand_index) <= 4);
    assert((operand_index.undefined() || operand_index.value() < (1 << 16)) &&
           "TrainingOperandIndex's hash creation error, operand_index is too big");
    static_assert(sizeof(size_t) >= sizeof(uint32_t),
                  "TrainingOperandIndex's hash creation error, size_t size is less than uint32_t");
 
    return (static_cast<size_t>(operand_index.value())) << 16 | static_cast<size_t>(is_forward);
  }
};
 
} // namespace std
 
#endif // __ONERT_IR_TRAIN_INDEX_H__