Package apple.metalperformanceshaders

Class MPSMatrixFullyConnected

  • All Implemented Interfaces:
    NSCoding, NSCopying, NSSecureCoding, NSObject
    public class MPSMatrixFullyConnected
extends MPSMatrixBinaryKernel
    MPSMatrixFullyConnected [@dependency] This depends on Metal.framework. Applies a fully connected neural network layer by performing a a matrix multiplication, adding a bias vector, scaling, and applying a neuron activation function. A MPSMatrixFullyConnected object computes: y = neuron(alpha * x * W + bias) y is the output matrix, x and W are input matrices corresponding to a collection of input vectors and weights respectively, and bias is a vector which is broadcast and accumulated to each row of the product. alpha is a scale factor applied to the product. neuron() is a pointwise function applied to the intermediate result.

    • Constructor Detail

      • MPSMatrixFullyConnected

        protected MPSMatrixFullyConnected​(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)

      • alpha

        public double alpha()
        [@property] alpha The scale factor to apply to the product. Specified in double precision. Will be converted to the appropriate precision in the implementation subject to rounding and/or clamping as necessary. Defaults to 1.0 at initialization time.

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

      • encodeToCommandBufferInputMatrixWeightMatrixBiasVectorResultMatrix

        public void encodeToCommandBufferInputMatrixWeightMatrixBiasVectorResultMatrix​(MTLCommandBuffer commandBuffer,
                                                                               MPSMatrix inputMatrix,
                                                                               MPSMatrix weightMatrix,
                                                                               MPSVector biasVector,
                                                                               MPSMatrix resultMatrix)
        Encode a MPSMatrixFullyConnected object to a command buffer. Encodes the operation to the specified command buffer. resultMatrix must be large enough to hold a MIN(sourceNumberOfInputs, inputMatrix.rows - primarySourceMatrixOrigin.x) x MIN(sourceOutputFeatureChannels, weightMatrix.columns - secondarySourceMatrixOrigin.y) array. The bias vector must contain at least MIN(sourceOutputFeatureChannels, weightMatrix.columns - secondarySourceMatrixOrigin.y) elements.
        Parameters:
        commandBuffer - A valid MTLCommandBuffer to receive the encoded kernel.
        inputMatrix - A valid MPSMatrix object which specifies the input array.
        weightMatrix - A valid MPSMatrix object which specifies the weight array.
        biasVector - A valid MPSVector object which specifies the bias values, or a null object to indicate that no bias is to be applied.
        resultMatrix - A valid MPSMatrix object which specifies the output array.

      • hash_static

        public static long hash_static()

      • initWithCoderDevice

        public MPSMatrixFullyConnected initWithCoderDevice​(NSCoder aDecoder,
                                                   java.lang.Object device)
        NSSecureCoding compatability See @ref MPSKernel#initWithCoder.
        Overrides:
        initWithCoderDevice in class MPSMatrixBinaryKernel
        Parameters:
        aDecoder - The NSCoder subclass with your serialized MPSMatrixFullyConnected
        device - The MTLDevice on which to make the MPSMatrixFullyConnected object.
        Returns:
        A new MPSMatrixFullyConnected object, or nil if failure.

      • initWithDevice

        public MPSMatrixFullyConnected initWithDevice​(java.lang.Object device)
        Description copied from class: MPSKernel
        Standard init with default properties per filter type
        Overrides:
        initWithDevice in class MPSMatrixBinaryKernel
        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.

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

      • neuronParameterA

        public float neuronParameterA()
        Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method

      • neuronParameterB

        public float neuronParameterB()
        Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method

      • neuronParameterC

        public float neuronParameterC()
        Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method

      • neuronType

        public int neuronType()
        Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method

      • new_objc

        public static java.lang.Object new_objc()

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • setAlpha

        public void setAlpha​(double value)
        [@property] alpha The scale factor to apply to the product. Specified in double precision. Will be converted to the appropriate precision in the implementation subject to rounding and/or clamping as necessary. Defaults to 1.0 at initialization time.

      • setNeuronTypeParameterAParameterBParameterC

        public void setNeuronTypeParameterAParameterBParameterC​(int neuronType,
                                                        float parameterA,
                                                        float parameterB,
                                                        float parameterC)
        Specifies a neuron activation function to be used. This method can be used to add a neuron activation funtion of given type with associated scalar parameters A, B, and C that are shared across all output values. Note that this method can only be used to specify neurons which are specified by three (or fewer) parameters shared across all output values (or channels, in CNN nomenclature). It is an error to call this method for neuron activation functions like MPSCNNNeuronTypePReLU, which require per-channel parameter values. For those kind of neuron activation functions, use appropriate setter functions. An MPSMatrixFullyConnected kernel is initialized with a default neuron function of MPSCNNNeuronTypeNone.
        Parameters:
        neuronType - Type of neuron activation function. For full list see MPSCNNNeuronType.h
        parameterA - parameterA of neuron activation that is shared across all output values.
        parameterB - parameterB of neuron activation that is shared across all output values.
        parameterC - parameterC of neuron activation that is shared across all output values.

      • setSourceInputFeatureChannels

        public void setSourceInputFeatureChannels​(long value)
        [@property] sourceInputFeatureChannels The input size to to use in the operation. This is equivalent to the number of columns and the number of rows in the primary (input array) and secondary (weight array) source matrices respectively. This property is modifiable and defaults to NSUIntegerMax. At encode time the larger of this property or the available input size is used. The value of NSUIntegerMax thus indicates that all available columns in the input array (beginning at primarySourceMatrixOrigin.y) and all available rows in the weight array (beginning at secondarySourceMatrixOrigin.x) should be considered. Note: The value used in the operation will be MIN(MIN(inputMatrix.columns - primarySourceMatrixOrigin.y, weightMatrix.rows - secondarySourceMatrixOrigin.x), sourceInputFeatureChannels)

      • setSourceNumberOfFeatureVectors

        public void setSourceNumberOfFeatureVectors​(long value)
        [@property] sourceNumberOfFeatureVectors The number of input vectors which make up the input array. This is equivalent to the number of rows to consider from the primary source matrix. This property is modifiable and defaults to NSUIntegerMax. At encode time the larger of this property or the available number of inputs is used. The value of NSUIntegerMax thus indicates that all available input rows (beginning at primarySourceMatrixOrigin.x) should be considered.

      • setSourceOutputFeatureChannels

        public void setSourceOutputFeatureChannels​(long value)
        [@property] sourceOutputFeatureChannels The output size to to use in the operation. This is equivalent to the number of columns to consider in the weight array, or the secondary source matrix. This property is modifiable and defaults to NSUIntegerMax. At encode time the larger of this property or the available output size is used. The value of NSUIntegerMax thus indicates that all available columns in the weight array (beginning at secondarySourceMatrixOrigin.y) should be considered.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • sourceInputFeatureChannels

        public long sourceInputFeatureChannels()
        [@property] sourceInputFeatureChannels The input size to to use in the operation. This is equivalent to the number of columns and the number of rows in the primary (input array) and secondary (weight array) source matrices respectively. This property is modifiable and defaults to NSUIntegerMax. At encode time the larger of this property or the available input size is used. The value of NSUIntegerMax thus indicates that all available columns in the input array (beginning at primarySourceMatrixOrigin.y) and all available rows in the weight array (beginning at secondarySourceMatrixOrigin.x) should be considered. Note: The value used in the operation will be MIN(MIN(inputMatrix.columns - primarySourceMatrixOrigin.y, weightMatrix.rows - secondarySourceMatrixOrigin.x), sourceInputFeatureChannels)

      • sourceNumberOfFeatureVectors

        public long sourceNumberOfFeatureVectors()
        [@property] sourceNumberOfFeatureVectors The number of input vectors which make up the input array. This is equivalent to the number of rows to consider from the primary source matrix. This property is modifiable and defaults to NSUIntegerMax. At encode time the larger of this property or the available number of inputs is used. The value of NSUIntegerMax thus indicates that all available input rows (beginning at primarySourceMatrixOrigin.x) should be considered.

      • sourceOutputFeatureChannels

        public long sourceOutputFeatureChannels()
        [@property] sourceOutputFeatureChannels The output size to to use in the operation. This is equivalent to the number of columns to consider in the weight array, or the secondary source matrix. This property is modifiable and defaults to NSUIntegerMax. At encode time the larger of this property or the available output size is used. The value of NSUIntegerMax thus indicates that all available columns in the weight array (beginning at secondarySourceMatrixOrigin.y) should be considered.

      • 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 MPSMatrixBinaryKernel

      • version_static

        public static long version_static()