[enco.caffe] Introduce Padding-related utilities (#2139)

This commit introduces the following helper functions for Padding
variables:
 - build_raw_padding
 - build_spatial_padding

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

diff --git a/contrib/enco/frontend/caffe/src/PaddingUtils.cpp b/contrib/enco/frontend/caffe/src/PaddingUtils.cpp
new file mode 100644 (file)
index 0000000..ffb4bfb
--- /dev/null
+++ b/contrib/enco/frontend/caffe/src/PaddingUtils.cpp
@@ -0,0 +1,131 @@
+/*
+ * Copyright (c) 2018 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 "PaddingUtils.h"
+
+#include <cassert>
+
+//
+// Section: Raw Padding Builder
+//
+RawPadding RawPaddingBuilder::with(const ::caffe::ConvolutionParameter &param) const
+{
+  RawPadding res;
+
+  if (param.has_pad_h() || param.has_pad_w())
+  {
+    assert(param.pad().size() == 0);
+    assert(param.has_pad_h() && param.has_pad_w());
+
+    res.resize(2);
+    res.value(0) = param.pad_h();
+    res.value(1) = param.pad_w();
+  }
+  else
+  {
+    // NOTE pad and pad_h/pad_w cannot be specified at the same time
+    //
+    // Reference: BaseConvolutionLayer<Dtype>::LayerSetUp in base_conv_layer.cpp
+    assert(!param.has_pad_h() && !param.has_pad_w());
+
+    uint32_t rank = param.pad().size();
+
+    res.resize(rank);
+    for (uint32_t axis = 0; axis < rank; ++axis)
+    {
+      res.value(axis) = param.pad(axis);
+    }
+  }
+
+  return res;
+}
+
+RawPadding RawPaddingBuilder::with(const ::caffe::PoolingParameter &param) const
+{
+  RawPadding res;
+
+  if (param.has_pad_h() || param.has_pad_w())
+  {
+    assert(!param.has_pad());
+    assert(param.has_pad_h() && param.has_pad_w());
+
+    res.resize(2);
+    res.value(0) = param.pad_h();
+    res.value(1) = param.pad_w();
+  }
+  else
+  {
+    // NOTE pad and pad_h/pad_w cannot be specified at the same time
+    //
+    // Reference: PoolingLayer<Dtype>::LayerSetUp in pooling_layer.cpp
+    assert(!param.has_pad_h() && !param.has_pad_w());
+
+    if (param.has_pad())
+    {
+      res.resize(1);
+      res.value(0) = param.pad();
+    }
+  }
+
+  return res;
+}
+
+RawPaddingBuilder build_raw_padding(void) { return RawPaddingBuilder{}; }
+
+//
+// Section: Spatial Padding Builder
+//
+SpatialPadding SpatialPaddingBuilder::with(const RawPadding &raw) const
+{
+  const auto spatial_rank = _spatial_rank;
+
+  SpatialPadding res;
+
+  res.resize(spatial_rank);
+
+  if (raw.count() == 0)
+  {
+    // NOTE default padding is 0
+    for (uint32_t spatial_axis = 0; spatial_axis < spatial_rank; ++spatial_axis)
+    {
+      res.value(spatial_axis) = 0;
+    }
+  }
+  else if (raw.count() == 1)
+  {
+    // NOTE One-for-all scheme
+    for (uint32_t spatial_axis = 0; spatial_axis < spatial_rank; ++spatial_axis)
+    {
+      res.value(spatial_axis) = raw.value(0);
+    }
+  }
+  else
+  {
+    // NOTE One-to-one scheme
+    assert(raw.count() == spatial_rank);
+    for (uint32_t spatial_axis = 0; spatial_axis < spatial_rank; ++spatial_axis)
+    {
+      res.value(spatial_axis) = raw.value(spatial_axis);
+    }
+  }
+
+  return res;
+}
+
+SpatialPaddingBuilder build_spatial_padding(uint32_t spatial_rank)
+{
+  return SpatialPaddingBuilder{spatial_rank};
+}

diff --git a/contrib/enco/frontend/caffe/src/PaddingUtils.h b/contrib/enco/frontend/caffe/src/PaddingUtils.h
new file mode 100644 (file)
index 0000000..81f32aa
--- /dev/null
+++ b/contrib/enco/frontend/caffe/src/PaddingUtils.h
@@ -0,0 +1,81 @@
+/*
+ * Copyright (c) 2018 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 __PADDING_UTILS_H__
+#define __PADDING_UTILS_H__
+
+#include "Padding.h"
+
+#include <caffe/proto/caffe.pb.h>
+
+/**
+ * @brief Construct a raw padding from each Layer parameter
+ *
+ * @note This class is an auxiliary class for build_raw_padding function below
+ */
+class RawPaddingBuilder
+{
+public:
+  friend RawPaddingBuilder build_raw_padding(void);
+
+private:
+  RawPaddingBuilder() = default;
+
+public:
+  RawPadding with(const ::caffe::ConvolutionParameter &) const;
+  RawPadding with(const ::caffe::PoolingParameter &) const;
+};
+
+/**
+ * RawPaddingBuilder is introduced to support the following code pattern:
+ *
+ *   auto raw_padding = build_raw_padding().with(conv_param);
+ *   ...
+ */
+RawPaddingBuilder build_raw_padding(void);
+
+/**
+ * @brief Convert a raw padding to a spatial padding of a given spatial rank
+ *
+ * @note This class is an auxiliary class for build_raw_padding function below
+ */
+class SpatialPaddingBuilder
+{
+public:
+  friend SpatialPaddingBuilder build_spatial_padding(uint32_t spatial_rank);
+
+private:
+  SpatialPaddingBuilder(uint32_t spatial_rank) : _spatial_rank{spatial_rank}
+  {
+    // DO NOTHING
+  }
+
+public:
+  SpatialPadding with(const RawPadding &raw) const;
+
+private:
+  uint32_t _spatial_rank = 0;
+};
+
+/**
+ * SpatialPaddingBuilder is introduced to support the following code pattern:
+ *
+ *   auto raw_padding = build_raw_padding().with(conv_param);
+ *   auto spatial_padding = build_spatial_padding(4).with(raw_padding);
+ */
+SpatialPaddingBuilder build_spatial_padding(uint32_t spatial_rank);
+
+#endif // __PADDING_UTILS_H__