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 const *__nonnull) sourceMatrix(MPSMatrix const
       *__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-Thu2Jul 13 2017      MPSMatrixSolveCholesky(3)


Mac OS X 10.12.6 - Generated Mon Oct 30 19:22:19 CDT 2017