PoolProjection.h

/* Copyright (c) 2016 Baidu, Inc. All Rights Reserve.

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. */

#pragma once

#include "Projection.h"
#include "paddle/math/MathUtils.h"

namespace paddle {

class PoolProjection : public Projection {
protected:
  size_t imgSizeY_, imgSize_;
  size_t outputY_, outputX_;
  size_t strideY_, stride_;
  size_t sizeY_, sizeX_;
  int confPaddingY_, confPadding_;
  size_t channels_;
  std::string poolType_;

public:
  PoolProjection(const ProjectionConfig& config, ParameterPtr parameter,
                 bool useGpu)
      : Projection(config, parameter, useGpu) {
    const PoolConfig& conf = config_.pool_conf();
    poolType_ = conf.pool_type();
    channels_ = conf.channels();
    sizeX_ = conf.size_x();
    stride_ = conf.stride();
    outputX_ = conf.output_x();
    imgSize_ = conf.img_size();
    confPadding_ = conf.padding();

    sizeY_ = conf.has_size_y() ? conf.size_y() : conf.size_x();
    imgSizeY_ = conf.has_img_size_y() ? conf.img_size_y() : conf.img_size();
    strideY_ = conf.has_stride_y() ? conf.stride_y() : conf.stride();
    confPaddingY_ = conf.has_padding_y() ? conf.padding_y() : conf.padding();
    outputY_ = conf.has_output_y() ? conf.output_y() : conf.output_x();
  }
  static PoolProjection* create(const ProjectionConfig& config,
                                ParameterPtr parameter, bool useGpu);
  const std::string& getPoolType() const { return poolType_; }
  size_t getSize() {
    imgSizeY_ = in_->getFrameHeight();
    imgSize_ = in_->getFrameWidth();
    const PoolConfig& conf = config_.pool_conf();
    if (imgSizeY_ == 0) {
      imgSizeY_ = conf.has_img_size_y() ? conf.img_size_y() : conf.img_size();
    }
    if (imgSize_ == 0) {
      imgSize_ = conf.img_size();
    }
    outputY_ = outputSize(imgSizeY_, sizeY_, confPaddingY_, strideY_,
                          /* caffeMode */ false);
    outputX_ = outputSize(imgSize_, sizeX_, confPadding_, stride_,
                          /* caffeMode */ false);

    const_cast<Argument*>(out_)->setFrameHeight(outputY_);
    const_cast<Argument*>(out_)->setFrameWidth(outputX_);

    return outputY_ * outputX_ * channels_;
  }
};

class MaxPoolProjection : public PoolProjection {
public:
  MaxPoolProjection(const ProjectionConfig& config, ParameterPtr parameter,
                    bool useGpu)
      : PoolProjection(config, parameter, useGpu) {}
  virtual void forward();
  virtual void backward(const UpdateCallback& callback = nullptr);
};

class AvgPoolProjection : public PoolProjection {
public:
  AvgPoolProjection(const ProjectionConfig& config, ParameterPtr parameter,
                    bool useGpu)
      : PoolProjection(config, parameter, useGpu) {}
  virtual void forward();
  virtual void backward(const UpdateCallback& callback = nullptr);
};
}  // namespace paddle