Package apple.metalperformanceshaders

Class MPSMatrixFindTopK

  • All Implemented Interfaces:
    NSCoding, NSCopying, NSSecureCoding, NSObject
    public class MPSMatrixFindTopK
extends MPSMatrixUnaryKernel
    MPSMatrixFindTopK [@dependency] This depends on Metal.framework. A kernel that find top-K values and their corresponding indices withing a row of a matrix A MPSMatrixFindTopK object computes finds the 'k' largest values within a row of a matrix and returns the value found and the index of the entry in the source matrix. This operation is performed independently on the rows and matrices in batch of the source matrix.

    • Constructor Detail

      • MPSMatrixFindTopK

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static java.lang.Object allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

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

      • cancelPreviousPerformRequestsWithTarget

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

      • cancelPreviousPerformRequestsWithTargetSelectorObject

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

      • classFallbacksForKeyedArchiver

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

      • classForKeyedUnarchiver

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

      • copyWithZoneDevice

        public java.lang.Object copyWithZoneDevice​(org.moe.natj.general.ptr.VoidPtr zone,
                                           MTLDevice device)
        Make a copy of this kernel for a new device - @see MPSKernel
        Overrides:
        copyWithZoneDevice in class 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.

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • encodeToCommandBufferInputMatrixResultIndexMatrixResultValueMatrix

        public void encodeToCommandBufferInputMatrixResultIndexMatrixResultValueMatrix​(MTLCommandBuffer commandBuffer,
                                                                               MPSMatrix inputMatrix,
                                                                               MPSMatrix resultIndexMatrix,
                                                                               MPSMatrix resultValueMatrix)
        Encode a MPSMatrixFindTopK object to a command buffer. 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: Both result matrices must be large enough to hold a two dimensional array of 'sourceRows' rows and 'numberOfTopKValues' columns beginning at resultMatrixOrigin. The source matrix must be large enough to contain at least 'numberOfTopKValues' values starting from sourceMatrixOrigin.y. Each matrix within the range specified by batchStart and batchSize, which also specifies a valid set of matrices within inputMatrix, resultIndexMatrix and resultValueMatrix, will be processed. The datatypes of the matrices inputMatrix and resultValueMatrix must match and be either MPSDataTypeFloat32 or MPSDataTypeFloat16.
        Parameters:
        commandBuffer - A valid MTLCommandBuffer to receive the encoded kernel.
        inputMatrix - A valid MPSMatrix object which specifies the input matrix.
        resultIndexMatrix - A valid MPSMatrix object which specifies the matrix which will be overwritten by the result indices. This matrix must have datatype MPSDataTypeUInt32.
        resultValueMatrix - A valid MPSMatrix object which specifies the matrix which will be overwritten by the result values.

      • hash_static

        public static long hash_static()

      • indexOffset

        public long indexOffset()
        [@property] indexOffset Specifies a number that will be added to all the indices written to resultIndexMatrix in encodeToCommandBuffer. This value can be used to offset later computations for example by adding the value for the source matrix column offset sourceMatrixOrigin.y. Example: Let numberOfTopKValues be 3, let the source be the following: source = [ 6.0, 3.0, 8.0, 1.0, 9.0, 4.0, 5.0 ] and let the sourceMatrixOrigin.y = 2. Then if indexOffset = 2 then the result value and result index matrices will be: result values = [ 9.0, 8.0, 5.0 ] result indices = [ 4 , 2 , 6 ], which gives the user indices into the original source matrix. On the other hand if the indexOffset = 0 then the results are as follows: result values = [ 9.0, 8.0, 5.0 ] result indices = [ 2 , 0 , 4 ], which on the other hand gives the user indices into the submatrix starting from sourceMatrixOrigin.y == 2. This property is modifiable and defaults to 0. If a different behavior is desired then this should be modified prior to encoding the kernel.

      • initWithCoderDevice

        public MPSMatrixFindTopK initWithCoderDevice​(NSCoder aDecoder,
                                             java.lang.Object device)
        FIXME: Fix availability macros to 10.14 and 12.0 once we get there
        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.

      • initWithDevice

        public MPSMatrixFindTopK initWithDevice​(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.

      • initWithDeviceNumberOfTopKValues

        public MPSMatrixFindTopK initWithDeviceNumberOfTopKValues​(MTLDevice device,
                                                          long numberOfTopKValues)
        FIXME: Fix availability macros to 10.14 and 12.0 once we get there

      • 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

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

      • new_objc

        public static java.lang.Object new_objc()

      • numberOfTopKValues

        public long numberOfTopKValues()
        [@property] numberOfTopKValues The number of highest values (and their indices) to be found in each row by the kernel. This property is initialized in the kernel initialization call initWithDevice, but can be modified before encoding the kernel. Must be less or equal to 16 and requesting more values results in undefined behavior. It is the user's responsibility to ensure that the resultIndexMatrix and resultValueMatrix parameters in encodeToCommandBuffer are large enough to accommodate the results of this operation, otherwise the results of the encode call are undefined.

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • setIndexOffset

        public void setIndexOffset​(long value)
        [@property] indexOffset Specifies a number that will be added to all the indices written to resultIndexMatrix in encodeToCommandBuffer. This value can be used to offset later computations for example by adding the value for the source matrix column offset sourceMatrixOrigin.y. Example: Let numberOfTopKValues be 3, let the source be the following: source = [ 6.0, 3.0, 8.0, 1.0, 9.0, 4.0, 5.0 ] and let the sourceMatrixOrigin.y = 2. Then if indexOffset = 2 then the result value and result index matrices will be: result values = [ 9.0, 8.0, 5.0 ] result indices = [ 4 , 2 , 6 ], which gives the user indices into the original source matrix. On the other hand if the indexOffset = 0 then the results are as follows: result values = [ 9.0, 8.0, 5.0 ] result indices = [ 2 , 0 , 4 ], which on the other hand gives the user indices into the submatrix starting from sourceMatrixOrigin.y == 2. This property is modifiable and defaults to 0. If a different behavior is desired then this should be modified prior to encoding the kernel.

      • setNumberOfTopKValues

        public void setNumberOfTopKValues​(long value)
        [@property] numberOfTopKValues The number of highest values (and their indices) to be found in each row by the kernel. This property is initialized in the kernel initialization call initWithDevice, but can be modified before encoding the kernel. Must be less or equal to 16 and requesting more values results in undefined behavior. It is the user's responsibility to ensure that the resultIndexMatrix and resultValueMatrix parameters in encodeToCommandBuffer are large enough to accommodate the results of this operation, otherwise the results of the encode call are undefined.

      • setSourceColumns

        public void setSourceColumns​(long value)
        [@property] sourceColumns 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 resultIndexMatrix and resultValueMatrix parameters in encodeToCommandBuffer are 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).

      • setSourceRows

        public void setSourceRows​(long value)
        [@property] sourceRows 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 resultIndexMatrix and resultValueMatrix parameters in encodeToCommandBuffer are 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).

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • sourceColumns

        public long sourceColumns()
        [@property] sourceColumns 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 resultIndexMatrix and resultValueMatrix parameters in encodeToCommandBuffer are 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

        public long sourceRows()
        [@property] sourceRows 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 resultIndexMatrix and resultValueMatrix parameters in encodeToCommandBuffer are 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).

      • 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()