NVIDIA NvNeural SDK  2021.1
GPU inference framework for NVIDIA Nsight Deep Learning Designer
IConvolutionLayer.h
Go to the documentation of this file.
1 /*
2 * SPDX-FileCopyrightText: Copyright (c) 2020-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3 * SPDX-License-Identifier: MIT
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 */
23 
25 
26 #ifndef NVNEURAL_ICONVOLUTIONLAYER_H
27 #define NVNEURAL_ICONVOLUTIONLAYER_H
28 
29 #include <nvneural/CoreTypes.h>
30 
31 namespace nvneural {
37  {
38  public:
40  static const IRefObject::TypeId typeID = 0x835aee64db0d45baul;
41 
43  virtual bool zeroPadding() const noexcept = 0;
44 
48  virtual NeuralResult setStride(std::size_t strideW, std::size_t strideH) noexcept = 0;
49 
52  virtual NeuralResult setFeatureCount(std::size_t numFeatures) noexcept = 0;
53 
57  virtual NeuralResult setKernelSize(std::size_t kernelSizeW, std::size_t kernelSizeH) noexcept = 0;
58 
61  virtual NeuralResult setZeroPadding(bool enablePadding) noexcept = 0;
62 
65  virtual NeuralResult applyBias(bool enableBias) noexcept = 0;
66  };
67 } // namespace nvneural
68 #endif // NVNEURAL_ICONVOLUTIONLAYER_H
Fundamental NvNeural data types are declared here.
NeuralResult
NeuralResult is a generic success/failure result type similar to COM HRESULT.
Definition: CoreTypes.h:273
IConvolutionLayer is an optional interface that marks a layer as a convolution layer.
Definition: IConvolutionLayer.h:37
virtual NeuralResult setKernelSize(std::size_t kernelSizeW, std::size_t kernelSizeH) noexcept=0
Sets the kernel size of the convolution operation.
virtual bool zeroPadding() const noexcept=0
Returns true if zero padding is enabled.
virtual NeuralResult setStride(std::size_t strideW, std::size_t strideH) noexcept=0
Sets the stride of the convolution operation.
virtual NeuralResult setFeatureCount(std::size_t numFeatures) noexcept=0
Sets the feature count of the convolution operation.
static const IRefObject::TypeId typeID
Interface TypeId for InterfaceOf purposes.
Definition: IConvolutionLayer.h:40
virtual NeuralResult applyBias(bool enableBias) noexcept=0
Turns bias on or off.
virtual NeuralResult setZeroPadding(bool enablePadding) noexcept=0
Turns zero padding on or off.
Base class for all objects, similar to COM's IUnknown.
Definition: CoreTypes.h:341
std::uint64_t TypeId
Every interface must define a unique TypeId. This should be randomized.
Definition: CoreTypes.h:347