[loco] Introduce FeatureIndex class (#3458)

This commit introduces FeatureIndex class which is the offset of an
element in a feature map.

Signed-off-by: Jonghyun Park <jh1302.park@samsung.com>

diff --git a/contrib/loco/include/loco/IR/FeatureIndex.h b/contrib/loco/include/loco/IR/FeatureIndex.h
new file mode 100644 (file)
index 0000000..007f944
--- /dev/null
+++ b/contrib/loco/include/loco/IR/FeatureIndex.h
@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2019 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 __LOCO_IR_FEATURE_INDEX_H__
+#define __LOCO_IR_FEATURE_INDEX_H__
+
+#include <cstdint>
+
+namespace loco
+{
+
+/**
+ * \brief Feature Index
+ *
+ * Feature Index indicates an "element" in a given feature map.
+ *
+ * Let us assume that there is a feature map F and S denotes its shape (of FeatureShape type).
+ *
+ * Then, any valid feature index I satisfies the following invariants:
+ * - 0 <= I.batch()   < S.count()
+ * - 0 <= I.channel() < S.depth()
+ * - 0 <= I.row()     < S.height()
+ * - 0 <= I.column()  < S.width()
+ */
+class FeatureIndex final
+{
+public:
+  FeatureIndex() = default;
+
+public:
+  const uint32_t &batch(void) const { return _batch; }
+  uint32_t &batch(void) { return _batch; }
+
+  const uint32_t &channel(void) const { return _channel; }
+  uint32_t &channel(void) { return _channel; }
+
+  const uint32_t &row(void) const { return _row; }
+  uint32_t &row(void) { return _row; }
+
+  const uint32_t &column(void) const { return _column; }
+  uint32_t &column(void) { return _column; }
+
+private:
+  uint32_t _batch = 0;
+  uint32_t _channel = 0;
+  uint32_t _row = 0;
+  uint32_t _column = 0;
+};
+
+} // namespace loco
+
+#endif // __LOCO_IR_FEATURE_INDEX_H__

diff --git a/contrib/loco/src/IR/FeatureIndex.test.cpp b/contrib/loco/src/IR/FeatureIndex.test.cpp
new file mode 100644 (file)
index 0000000..82b5639
--- /dev/null
+++ b/contrib/loco/src/IR/FeatureIndex.test.cpp
@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2019 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.
+ */
+
+#include "loco/IR/FeatureIndex.h"
+
+#include <gtest/gtest.h>
+
+TEST(FeatureIndexTest, default_constructor)
+{
+  loco::FeatureIndex index;
+
+  // All the values are 0 at the beginning
+  ASSERT_EQ(index.batch(), 0);
+  ASSERT_EQ(index.channel(), 0);
+  ASSERT_EQ(index.row(), 0);
+  ASSERT_EQ(index.column(), 0);
+}
+
+TEST(FeatureIndexTest, settet_and_getter)
+{
+  loco::FeatureIndex index;
+
+  // Set count
+  index.batch() = 2;
+
+  ASSERT_EQ(index.batch(), 2);
+  ASSERT_EQ(index.channel(), 0);
+  ASSERT_EQ(index.row(), 0);
+  ASSERT_EQ(index.column(), 0);
+
+  // Set channel
+  index.channel() = 3;
+
+  ASSERT_EQ(index.batch(), 2);
+  ASSERT_EQ(index.channel(), 3);
+  ASSERT_EQ(index.row(), 0);
+  ASSERT_EQ(index.column(), 0);
+
+  // Set height
+  index.row() = 4;
+
+  ASSERT_EQ(index.batch(), 2);
+  ASSERT_EQ(index.channel(), 3);
+  ASSERT_EQ(index.row(), 4);
+  ASSERT_EQ(index.column(), 0);
+
+  // Set width
+  index.column() = 5;
+
+  ASSERT_EQ(index.batch(), 2);
+  ASSERT_EQ(index.channel(), 3);
+  ASSERT_EQ(index.row(), 4);
+  ASSERT_EQ(index.column(), 5);
+}