Package apple.metalperformanceshaders

Class MPSMatrixDecompositionLU

  • All Implemented Interfaces:
    NSCoding, NSCopying, NSSecureCoding, NSObject
    public class MPSMatrixDecompositionLU
extends MPSMatrixUnaryKernel
    MPSMatrixDecompositionLU [@dependency] 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. API-Since: 11.0

    • Constructor Detail

      • MPSMatrixDecompositionLU

        protected MPSMatrixDecompositionLU​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • encodeToCommandBufferSourceMatrixResultMatrixPivotIndicesStatus

        public void encodeToCommandBufferSourceMatrixResultMatrixPivotIndicesStatus​(@NotNull
                                                                            @NotNull MTLCommandBuffer commandBuffer,
                                                                            @NotNull
                                                                            @NotNull MPSMatrix sourceMatrix,
                                                                            @NotNull
                                                                            @NotNull MPSMatrix resultMatrix,
                                                                            @NotNull
                                                                            @NotNull MPSMatrix pivotIndices,
                                                                            @Nullable
                                                                            @Nullable MTLBuffer status)
        Encode a MPSMatrixDecompositionLU kernel into a command Buffer. 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.
        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.

      • hash_static

        public static long hash_static()

      • initWithCoderDevice

        public MPSMatrixDecompositionLU initWithCoderDevice​(@NotNull
                                                    @NotNull NSCoder aDecoder,
                                                    @NotNull
                                                    @NotNull java.lang.Object device)
        Description copied from class: MPSKernel
        NSSecureCoding compatability While the standard NSSecureCoding/NSCoding method -initWithCoder: should work, since the file can't know which device your data is allocated on, we have to guess and may guess incorrectly. To avoid that problem, use initWithCoder:device instead.
        Overrides:
        initWithCoderDevice in class MPSMatrixUnaryKernel
        Parameters:
        aDecoder - The NSCoder subclass with your serialized MPSKernel
        device - The MTLDevice on which to make the MPSKernel
        Returns:
        A new MPSKernel object, or nil if failure. API-Since: 11.0

      • initWithDevice

        public MPSMatrixDecompositionLU initWithDevice​(@NotNull
                                               @NotNull java.lang.Object device)
        Description copied from class: MPSKernel
        Standard init with default properties per filter type
        Overrides:
        initWithDevice in class MPSMatrixUnaryKernel
        Parameters:
        device - The device that the filter will be used on. May not be NULL.
        Returns:
        a pointer to the newly initialized object. This will fail, returning nil if the device is not supported. Devices must be MTLFeatureSet_iOS_GPUFamily2_v1 or later.

      • initWithDeviceRowsColumns

        public MPSMatrixDecompositionLU initWithDeviceRowsColumns​(@NotNull
                                                          @NotNull MTLDevice device,
                                                          long rows,
                                                          long 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.

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • supportsSecureCoding

        public static boolean supportsSecureCoding()

      • _supportsSecureCoding

        public boolean _supportsSecureCoding()
        Description copied from interface: NSSecureCoding
        This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.
        Specified by:
        _supportsSecureCoding in interface NSSecureCoding
        Overrides:
        _supportsSecureCoding in class MPSMatrixUnaryKernel

      • version_static

        public static long version_static()

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.