MPSCNNPooling(3)       MetalPerformanceShaders.framework      MPSCNNPooling(3)

NAME

       MPSCNNPooling

SYNOPSIS

       #import <MPSCNNPooling.h>

       Inherits MPSCNNKernel.

       Inherited by MPSCNNDilatedPoolingMax, MPSCNNPoolingAverage,
       MPSCNNPoolingL2Norm, and MPSCNNPoolingMax.

   Instance Methods
       (nonnull instancetype) - initWithDevice:kernelWidth:kernelHeight:
       (nonnull instancetype) -
           initWithDevice:kernelWidth:kernelHeight:strideInPixelsX:strideInPixelsY:
       (nullable instancetype) - initWithCoder:device:
       (nonnull instancetype) - initWithDevice:

   Additional Inherited Members

Detailed Description

       This depends on Metal.framework  Pooling is a form of non-linear sub-
       sampling. Pooling partitions the input image into a set of rectangles
       (overlapping or non-overlapping) and, for each such sub-region, outputs
       a value. The pooling operation is used in computer vision to reduce the
       dimensionality of intermediate representations.

Method Documentation

   - (nullable instancetype) initWithCoder: (NSCoder *__nonnull)
       aDecoder(nonnull id< MTLDevice >) device
       NSSecureCoding compatability  See MPSKernel::initWithCoder.

       Parameters:
           aDecoder The NSCoder subclass with your serialized MPSCNNPooling
           device The MTLDevice on which to make the MPSCNNPooling

       Returns:
           A new MPSCNNPooling object, or nil if failure.



       Reimplemented from MPSCNNKernel.

       Reimplemented in MPSCNNDilatedPoolingMax, MPSCNNPoolingAverage,
       MPSCNNPoolingL2Norm, and MPSCNNPoolingMax.

   - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device
       Standard init with default properties per filter type

       Parameters:
           device The device that the filter will be used on. May not be NULL.

       Returns:
           A pointer to the newly initialized object. This will fail,
           returning nil if the device is not supported. Devices must be
           MTLFeatureSet_iOS_GPUFamily2_v1 or later.



       Reimplemented from MPSCNNKernel.

   - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >)
       device(NSUInteger) kernelWidth(NSUInteger) kernelHeight
       Initialize a pooling filter

       Parameters:
           device The device the filter will run on
           kernelWidth The width of the kernel. Can be an odd or even value.
           kernelHeight The height of the kernel. Can be an odd or even value.

       Returns:
           A valid MPSCNNPooling object or nil, if failure.



   - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >)
       device(NSUInteger) kernelWidth(NSUInteger) kernelHeight(NSUInteger)
       strideInPixelsX(NSUInteger) strideInPixelsY
       Initialize a pooling filter

       Parameters:
           device The device the filter will run on
           kernelWidth The width of the kernel. Can be an odd or even value.
           kernelHeight The height of the kernel. Can be an odd or even value.
           strideInPixelsX The output stride (downsampling factor) in the x
           dimension.
           strideInPixelsY The output stride (downsampling factor) in the y
           dimension.

       Returns:
           A valid MPSCNNPooling object or nil, if failure.



       Reimplemented in MPSCNNPoolingAverage, MPSCNNPoolingL2Norm, and
       MPSCNNPoolingMax.

Author

       Generated automatically by Doxygen for
       MetalPerformanceShaders.framework from the source code.





Version MetalPerformanceShaders-Thu2Jul 13 2017               MPSCNNPooling(3)


Mac OS X 10.13.1 - Generated Mon Nov  6 18:51:14 CST 2017