mpsmatrixdecompositionlu(3) [mojave man page]
MPSMatrixDecompositionLU(3) MetalPerformanceShaders.framework MPSMatrixDecompositionLU(3) NAME
MPSMatrixDecompositionLU SYNOPSIS
#import <MPSMatrixDecomposition.h> Inherits MPSMatrixUnaryKernel. Instance Methods (nonnull instancetype) - initWithDevice:rows:columns: (void) - encodeToCommandBuffer:sourceMatrix:resultMatrix:pivotIndices:status: Additional Inherited Members Detailed Description This depends on Metal.framework. A kernel for computing the LU factorization of a matrix using partial pivoting with row interchanges. A MPSMatrixDecompositionLU object computes an LU factorization: P * A = L * U A is a matrix for which the LU factorization is to be computed. L is a unit lower triangular matrix and U is an upper triangular matrix. P is a permutation matrix. Method Documentation - (void) encodeToCommandBuffer: (nonnull id< MTLCommandBuffer >) commandBuffer(MPSMatrix *__nonnull) sourceMatrix(MPSMatrix *__nonnull) resultMatrix(MPSMatrix *__nonnull) pivotIndices(__nullable id< MTLBuffer >) status Encode a MPSMatrixDecompositionLU kernel into a command Buffer. Parameters: commandBuffer A valid MTLCommandBuffer to receive the encoded filter sourceMatrix A valid MPSMatrix containing the source data. Must have enough space to hold a rows x columns matrix. resultMatrix A valid MPSMatrix to contain the result. Must have enough space to hold a rows x columns matrix. pivotIndices A valid MPSMatrix to contain the pivot indices. Must have enough space to hold an array of size 1xmin(rows, columns) values. Element type must be MPSDataTypeUInt32. status A MTLBuffer which indicates the resulting MPSMatrixDecompositionStatus value. This function encodes the MPSMatrixDecompositionLU object to a valid command buffer. Upon completion the array pivotIndices contains, for each index i, the row interchanged with row i. If during the computation U[k, k], for some k, is determined to be exactly zero MPSMatrixDecompositionStatusSingular will be returned in the provided status buffer. The data referenced by the MTLBuffer is not valid until the command buffer has completed execution. If the matrix return status is not desired NULL may be provided. Upon successful factorization, resultMatrix contains the resulting lower triangular factor (without the unit diagonal elements) in its strictly lower triangular region and the upper triangular factor in its upper triangular region. This kernel functions either in-place, if the result matrix completely aliases the source matrix, or out-of-place. If there is any partial overlap between input and output data the results are undefined. - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device(NSUInteger) rows(NSUInteger) columns Initialize an MPSMatrixDecompositionLU object on a device Parameters: device The device on which the kernel will execute. rows The number of rows in the source matrix. columns The number of columns in the source matrix. Returns: A valid MPSMatrixDecompositionLU object or nil, if failure. Author Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code. Version MetalPerformanceShaders-100 Thu Feb 8 2018 MPSMatrixDecompositionLU(3)
Check Out this Related Man Page
MPSMatrixSoftMax(3) MetalPerformanceShaders.framework MPSMatrixSoftMax(3) NAME
MPSMatrixSoftMax SYNOPSIS
#import <MPSMatrixSoftMax.h> Inherits MPSMatrixUnaryKernel. Inherited by MPSMatrixLogSoftMax. Instance Methods (nonnull instancetype) - initWithDevice: (void) - encodeToCommandBuffer:inputMatrix:resultMatrix: (nullable instancetype) - initWithCoder:device: (nonnull instancetype) - copyWithZone:device: Properties NSUInteger sourceRows NSUInteger sourceColumns Additional Inherited Members Detailed Description This depends on Metal.framework. A softmax kernel that operates on matrices. A MPSMatrixSoftMax object computes: B_ij = Exp { A_ij } / ( Sum_k Exp { A_ik } ) A and B are matrices which are represented by MPSMatrix objects. This filter computes the same result for MPSMatrices as MPSCNNSoftMax filter does for MPSImages by interpreting the columns of the matrix as feature channels, that is the sum runs over column indices. Method Documentation - (nonnull instancetype) copyWithZone: (nullable NSZone *) zone(nullable id< MTLDevice >) device Make a copy of this kernel for a new device - See also: MPSKernel Parameters: zone The NSZone in which to allocate the object device The device for the new MPSKernel. If nil, then use self.device. Returns: a pointer to a copy of this MPSKernel. This will fail, returning nil if the device is not supported. Devices must be MTLFeatureSet_iOS_GPUFamily2_v1 or later. Reimplemented from MPSKernel. - (void) encodeToCommandBuffer: (nonnull id< MTLCommandBuffer >) commandBuffer(MPSMatrix *__nonnull) inputMatrix(MPSMatrix *__nonnull) resultMatrix Encode a MPSMatrixSoftMax object to a command buffer. Parameters: commandBuffer A valid MTLCommandBuffer to receive the encoded kernel. inputMatrix A valid MPSMatrix object which specifies the input matrix. resultMatrix A valid MPSMatrix object which specifies the matrix which will be overwritten by the result. Certain constraints apply to the sizes of the matrices depending on the sizes requested at initialization time as well as the origins at the time this routine is called: The result matrix must be large enough to hold a two dimensional array of 'sourceRows' rows and 'sourceColumns' columns beginning at resultMatrixOrigin. Each matrix within the range specified by batchStart and batchSize, which also specifies a valid set of matrices within inputMatrix and resultMatrix, will be processed. The datatypes of the matrices inputMatrix and resultMatrix must match and be either MPSDataTypeFloat32 or MPSDataTypeFloat16. - (nullable instancetype) initWithCoder: (NSCoder *__nonnull) aDecoder(nonnull id< MTLDevice >) device NSSecureCoding compatability See MPSKernel::initWithCoder. Parameters: aDecoder The NSCoder subclass with your serialized MPSMatrixSoftMax device The MTLDevice on which to make the MPSMatrixSoftMax Returns: A new MPSMatrixSoftMax object, or nil if failure. Reimplemented from MPSKernel. - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device Initialize an MPSMatrixSoftMax object on a device for a given size. Parameters: device The device on which the kernel will execute. Returns: A valid MPSMatrixSoftMax object or nil, if failure. Reimplemented from MPSKernel. Property Documentation - sourceColumns [read], [write], [nonatomic], [assign] The number of columns to consider from the source in the operation. This property is modifiable and defaults to NSUIntegerMax and the number is adjusted dynamically at kernel encode time (see encodeToCommandBuffer) to fit into the source matrix available starting from sourceMatrixOrigin.y, indicating that by default the whole source matrix is used. If a different size is desired then this should be modified prior to encoding the kernel. It is the user's responsibility to ensure that the resultMatrix parameter in encodeToCommandBuffer is large enough to accommodate the results of this operation, otherwise the results of the encode call are undefined. NOTE: sourceMatrixOrigin and resultMatrixOrigin from MPSMatrixUnaryKernel can be used to control the starting points in the source and destination at kernel encode time (see encodeToCommandBuffer). - sourceRows [read], [write], [nonatomic], [assign] The number of rows to consider from the source in the operation. This property is modifiable and defaults to NSUIntegerMax and the number is adjusted dynamically at kernel encode time (see encodeToCommandBuffer) to fit into the source matrix available starting from sourceMatrixOrigin.x, indicating that by default the whole source matrix is used. If a different size is desired then this should be modified prior to encoding the kernel. It is the user's responsibility to ensure that the resultMatrix parameter in encodeToCommandBuffer is large enough to accommodate the results of this operation, otherwise the results of the encode call are undefined. NOTE: sourceMatrixOrigin and resultMatrixOrigin from MPSMatrixUnaryKernel can be used to control the starting points in the source and destination at kernel encode time (see encodeToCommandBuffer). Author Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code. Version MetalPerformanceShaders-100 Thu Feb 8 2018 MPSMatrixSoftMax(3)