MPSNNBinaryArithmeticNode(3)

NAME
MPSNNBinaryArithmeticNode

SYNOPSIS

#import <MPSNNGraphNodes.h>

Inherits MPSNNFilterNode.

Inherited by MPSNNAdditionNode, MPSNNDivisionNode, MPSNNMultiplicationNode, and MPSNNSubtractionNode.

  Instance Methods
(nonnull instancetype) - initWithSources:
(nonnull instancetype) - initWithLeftSource:rightSource:
(nonnull Class) - gradientClass
(MPSNNGradientFilterNode *__nonnull) - gradientFilterWithSources:
(NSArray< MPSNNGradientFilterNode * > *__nonnull) - gradientFiltersWithSources:

  Class Methods
(nonnull instancetype) + nodeWithSources:
(nonnull instancetype) + nodeWithLeftSource:rightSource:

  Properties
float primaryScale
float secondaryScale
float bias
NSUInteger primaryStrideInPixelsX
NSUInteger primaryStrideInPixelsY
NSUInteger primaryStrideInFeatureChannels
NSUInteger secondaryStrideInPixelsX
NSUInteger secondaryStrideInPixelsY
NSUInteger secondaryStrideInFeatureChannels
float minimumValue
float maximumValue

Detailed Description

virtual base class for basic arithmetic nodes

Method Documentation

  - (nonnull Class) gradientClass

  - (NSArray <MPSNNGradientFilterNode*> * __nonnull) gradientFiltersWithSources: (NSArray< MPSNNImageNode * > *__nonnull) gradientImages
create new arithmetic gradient nodes Create two new arithmetic gradient nodes - one that computes the gradient for the primary source image and one that computes the gradient for the secondary sourcefrom the inference pass.

Reimplemented from MPSNNFilterNode.

  - (MPSNNGradientFilterNode*__nonnull) gradientFilterWithSources: (NSArray< MPSNNImageNode * > *__nonnull) gradientImages
Return the gradient (backwards) version of this filter. The backwards training version of the filter will be returned. The non-gradient image and state arguments for the filter are automatically obtained from the target.

Parameters:
    gradientImages The gradient images corresponding with the resultImage of the target

Reimplemented from MPSNNFilterNode.

  - (nonnull instancetype) initWithLeftSource: (MPSNNImageNode *__nonnull) left(MPSNNImageNode *__nonnull) right
init an arithemtic node with two sources

Parameters:
    left the left operand
    right the right operand

  - (nonnull instancetype) initWithSources: (NSArray< MPSNNImageNode * > *__nonnull) sourceNodes
init an arithemtic node with an array of sources

Parameters:
    sourceNodes A valid NSArray containing two sources

  + (nonnull instancetype) nodeWithLeftSource: (MPSNNImageNode *__nonnull) left(MPSNNImageNode *__nonnull) right
create an autoreleased arithemtic node with two sources

Parameters:
    left the left operand
    right the right operand

  + (nonnull instancetype) nodeWithSources: (NSArray< MPSNNImageNode * > *__nonnull) sourceNodes
create an autoreleased arithemtic node with an array of sources

Parameters:
    sourceNodes A valid NSArray containing two sources

Property Documentation

  - (float) bias [read], [write], [nonatomic], [assign]

  - (float) maximumValue [read], [write], [nonatomic], [assign]

  - (float) minimumValue [read], [write], [nonatomic], [assign]

  - (float) primaryScale [read], [write], [nonatomic], [assign]

  - (NSUInteger) primaryStrideInFeatureChannels [read], [write], [nonatomic], [assign]

  - (NSUInteger) primaryStrideInPixelsX [read], [write], [nonatomic], [assign]

  - (NSUInteger) primaryStrideInPixelsY [read], [write], [nonatomic], [assign]

  - (float) secondaryScale [read], [write], [nonatomic], [assign]

  - (NSUInteger) secondaryStrideInFeatureChannels [read], [write], [nonatomic], [assign]

  - (NSUInteger) secondaryStrideInPixelsX [read], [write], [nonatomic], [assign]

  - (NSUInteger) secondaryStrideInPixelsY [read], [write], [nonatomic], [assign]

Author

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