ai.djl.nn.pooling.PoolingConvention Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

Deep Java Library - api

There is a newer version: 0.30.0

/*
 * Copyright 2019 Amazon.com, Inc. or its affiliates. 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. A copy of the License is located at
 *
 * http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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.
 */
package ai.djl.nn.pooling;

/** An enum that enumerates the different pooling conventions. */
public enum PoolingConvention {
    VALID,
    FULL;

    /**
     * Computes the size of the output in the given input dimension for this {@code
     * PoolingConvention}.
     *
     * @param input the input size in the dimension
     * @param kernel the kernel size in the dimension
     * @param stride the stride size in the dimension
     * @param pad the pad size in the dimension
     * @return the output size in the given input dimension
     */
    public long getOutput(long input, long kernel, long stride, long pad) {
        double output = input + 2 * pad - kernel / stride;
        switch (this) {
            case VALID:
                return (long) Math.floor(output) + 1;
            case FULL:
                return (long) Math.ceil(output) + 1;
            default:
                throw new IllegalStateException();
        }
    }
}