mpsmatrixcopydescriptor(3) [mojave man page]
MPSMatrixCopyDescriptor(3) MetalPerformanceShaders.framework MPSMatrixCopyDescriptor(3) NAME
MPSMatrixCopyDescriptor SYNOPSIS
#import <MPSMatrixCombination.h> Inherits NSObject. Instance Methods (nonnull instancetype) - initWithDevice:count: (void) - setCopyOperationAtIndex:sourceMatrix:destinationMatrix:offsets: (nonnull instancetype) - initWithSourceMatrices:destinationMatrices:offsetVector:offset: (nonnull instancetype) - init Class Methods (nonnull instancetype) + descriptorWithSourceMatrix:destinationMatrix:offsets: Method Documentation + (nonnull instancetype) descriptorWithSourceMatrix: (MPSMatrix *__nonnull) sourceMatrix(MPSMatrix *__nonnull) destinationMatrix(MPSMatrixCopyOffsets) offsets convenience allocator for single copies - (nonnull instancetype) init - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device(NSUInteger) count initialize a MPSMatrixCopyDescriptor with default values. Use -setCopyOperationAtIndex:sourceMatrix:destinationMatrix:copyOffsets to initialize. All indices must be initialized before use. Parameters: device The device on which the copy will be performed count The number of copy operations the object will encode Returns: A MPSMatrixCopyDescriptor. It still needs to be initialized with -setCopyOperationAtIndex:sourceMatrix:destinationMatrix:copyOffsets - (nonnull instancetype) initWithSourceMatrices: (NSArray< MPSMatrix * > *__nonnull) sourceMatrices(NSArray< MPSMatrix * > *__nonnull) destinationMatrices(MPSVector *__nullable) offsets(NSUInteger) byteOffset Initialize a MPSMatrixCopyDescriptor using offsets generated on the GPU Use this method when the offsets needed are coming from GPU based computation. Parameters: sourceMatrices A list of matrices from which the matrix data is read destinationMatrices A list of matrices to which to write the data. The count must match the number of source matrices. offsets A MPSVector of type MPSDataTypeUInt32 containing the list of offsets, stored as a packed array of MPSMatrixCopyOffsets. byteOffset A byte offset into the offsets vector where the data starts in 'offsets'. This value must be a multiple of 16. Returns: A valid MPSMatrixCopyDescriptor to represent the list of copy operations - (void) setCopyOperationAtIndex: (NSUInteger) index(MPSMatrix *__nonnull) sourceMatrix(MPSMatrix *__nonnull) destinationMatrix(MPSMatrixCopyOffsets) offsets Initialize a MPSMatrixCopyDescriptor using offsets generated on the CPU This is for one at a time intialization of the copy operations Parameters: index The index of the copy operation sourceMatrix The source matrix for this copy operation destinationMatrix The destination matrix for this copy operation offsets The offsets to use for the copy operation Author Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code. Version MetalPerformanceShaders-100 Thu Feb 8 2018 MPSMatrixCopyDescriptor(3)
Check Out this Related Man Page
MPSMatrixSolveCholesky(3) MetalPerformanceShaders.framework MPSMatrixSolveCholesky(3) NAME
MPSMatrixSolveCholesky SYNOPSIS
#import <MPSMatrixSolve.h> Inherits MPSMatrixBinaryKernel. Instance Methods (nonnull instancetype) - initWithDevice:upper:order:numberOfRightHandSides: (void) - encodeToCommandBuffer:sourceMatrix:rightHandSideMatrix:solutionMatrix: Additional Inherited Members Detailed Description This depends on Metal.framework. A kernel for computing the solution of a linear system of equations using the Cholesky factorization resulting from a MPSMatrixDecompositionCholesky kernel. A MPSMatrixSolveCholesky finds the solution matrix to the system: A * X = B Where A is symmetric positive definite. B is the array of right hand sides for which the equations are to be solved. X is the resulting matrix of solutions. Method Documentation - (void) encodeToCommandBuffer: (nonnull id< MTLCommandBuffer >) commandBuffer(MPSMatrix *__nonnull) sourceMatrix(MPSMatrix *__nonnull) rightHandSideMatrix(MPSMatrix *__nonnull) solutionMatrix Encode a MPSMatrixSolveCholesky kernel into a command Buffer. Parameters: commandBuffer A valid MTLCommandBuffer to receive the encoded filter sourceMatrix A valid MPSMatrix containing the source matrix in factored form as returned by a previous successful execution of a MPSMatrixDecompositionCholesky kernel. rightHandSideMatrix A valid MPSMatrix containing the right hand side values. solutionMatrix A valid MPSMatrix to contain the result. This function encodes the MPSMatrixSolveCholesky object to a valid command buffer. sourceMatrix should contain either the lower or upper triangular factors corresponding to the factorization returned by a previous execution of MPSMatrixDecompositionCholesky. rightHandSideMatrix and solutionMatrix must be large enough to hold a matrix of size order x numberOfRightHandSides starting at secondarySourceMatrixOrigin and resultMatrixOrigin respectively. sourceMatrix must be at least size order x order starting at primarySourceMatrixOrigin. - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device(BOOL) upper(NSUInteger) order(NSUInteger) numberOfRightHandSides Initialize an MPSMatrixSolveCholesky object on a device Parameters: device The device on which the kernel will execute. upper A boolean value which indicates if the source matrix stores the lower or upper triangular factors. order The order of the source matrix and the number of rows in the solution and right hand side matrices. numberOfRightHandSides The number of columns in the solution and right hand side matrices. Returns: A valid MPSMatrixSolveCholesky object or nil, if failure. Author Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code. Version MetalPerformanceShaders-100 Thu Feb 8 2018 MPSMatrixSolveCholesky(3)