IConvolutionLayer.h

Go to the documentation of this file.

/*
* SPDX-FileCopyrightText: Copyright (c) 2020-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
 
 
#ifndef NVNEURAL_ICONVOLUTIONLAYER_H
#define NVNEURAL_ICONVOLUTIONLAYER_H
 
#include <nvneural/CoreTypes.h>
 
namespace nvneural {
 
    class IConvolutionLayer : public IRefObject
    {
    public:
        static const IRefObject::TypeId typeID = 0x835aee64db0d45baul;
 
        virtual bool zeroPadding() const noexcept = 0;
 
        virtual NeuralResult setStride(std::size_t strideW, std::size_t strideH) noexcept = 0;
 
        virtual NeuralResult setFeatureCount(std::size_t numFeatures) noexcept = 0;
 
        virtual NeuralResult setKernelSize(std::size_t kernelSizeW, std::size_t kernelSizeH) noexcept = 0;
 
        virtual NeuralResult setZeroPadding(bool enablePadding) noexcept = 0;
 
        virtual NeuralResult applyBias(bool enableBias) noexcept = 0;
    };
 
    enum class ConvolutionPaddingMode
    {
        Same,
        Valid,
        Tuple
    };
 
    class IConvolutionLayer2 : public IConvolutionLayer
    {
    public:
        static const IRefObject::TypeId typeID = 0xe0107167331c03e4ul;
 
        virtual ConvolutionPaddingMode getPaddingMode() const noexcept = 0;
 
        virtual TensorDimension getPaddingDimension() const noexcept = 0;
 
        virtual NeuralResult setPaddingDimension(const TensorDimension& paddingDimension) noexcept = 0;
 
        virtual NeuralResult setPaddingMode(ConvolutionPaddingMode mode) noexcept = 0;
    };
} // namespace nvneural
#endif // NVNEURAL_ICONVOLUTIONLAYER_H