.TH "MPSMatrixBinaryKernel" 3 "Mon Jul 9 2018" "Version MetalPerformanceShaders-119.3" "MetalPerformanceShaders.framework" \" -*- nroff -*-
.ad l
.nh
.SH NAME
MPSMatrixBinaryKernel
.SH SYNOPSIS
.br
.PP
.PP
\fC#import <MPSMatrixTypes\&.h>\fP
.PP
Inherits \fBMPSKernel\fP\&.
.PP
Inherited by \fBMPSMatrixBatchNormalizationGradient\fP, \fBMPSMatrixFullyConnected\fP, \fBMPSMatrixFullyConnectedGradient\fP, \fBMPSMatrixNeuronGradient\fP, \fBMPSMatrixSoftMaxGradient\fP, \fBMPSMatrixSolveCholesky\fP, \fBMPSMatrixSolveLU\fP, \fBMPSMatrixSolveTriangular\fP, and \fBMPSMatrixVectorMultiplication\fP\&.
.SS "Properties"

.in +1c
.ti -1c
.RI "MTLOrigin \fBprimarySourceMatrixOrigin\fP"
.br
.ti -1c
.RI "MTLOrigin \fBsecondarySourceMatrixOrigin\fP"
.br
.ti -1c
.RI "MTLOrigin \fBresultMatrixOrigin\fP"
.br
.ti -1c
.RI "NSUInteger \fBbatchStart\fP"
.br
.ti -1c
.RI "NSUInteger \fBbatchSize\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
This depends on Metal\&.framework  \fBA\fP \fBMPSMatrixBinaryKernel\fP consumes two \fBMPSMatrix\fP objects and produces one \fBMPSMatrix\fP object\&. 
.SH "Property Documentation"
.PP 
.SS "\- batchSize\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [assign]\fP"
The number of matrices in the batch to process\&. This property is modifiable and by default allows all matrices available at encoding time to be processed\&. If a single matrix should be processed set this value to 1\&. 
.SS "\- batchStart\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [assign]\fP"
The index of the first matrix in the batch\&. This property is modifiable and defaults to 0 at initialization time\&. If batch processing should begin at a different matrix this value should be modified prior to encoding the kernel\&. 
.SS "\- primarySourceMatrixOrigin\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [assign]\fP"
The origin, relative to [0, 0] in the primary source matrix, at which to start reading values\&. This property is modifiable and defaults to [0, 0] at initialization time\&. If a different origin is desired then this should be modified prior to encoding the kernel\&. The z value must be 0\&. 
.SS "\- resultMatrixOrigin\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [assign]\fP"
The origin, relative to [0, 0] in the result matrix, at which to start writing results\&. This property is modifiable and defaults to [0, 0] at initialization time\&. If a different origin is desired then this should be modified prior to encoding the kernel\&. The z value must be 0\&. 
.SS "\- secondarySourceMatrixOrigin\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [assign]\fP"
The origin, relative to [0, 0] in the secondary source matrix, at which to start reading values\&. This property is modifiable and defaults to [0, 0] at initialization time\&. If a different origin is desired then this should be modified prior to encoding the kernel\&. The z value must be 0\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for MetalPerformanceShaders\&.framework from the source code\&.