apple.metalperformanceshaders

Class MPSMatrixSum

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.metalperformanceshaders.MPSKernel

apple.metalperformanceshaders.MPSMatrixSum

All Implemented Interfaces:

NSCoding, NSCopying, NSSecureCoding, NSObject

public class MPSMatrixSum
extends MPSKernel

MPSMatrixSum [@dependency] This depends on Metal.framework

MPSMatrixSum performs a pointwise summation of N MPSMatrix objects and applies an optional bias term and neuron activation function.

MPSMatrix A = empty matrix; for (i = 0; i < N; ++i) A += alpha[i]*B[i];

if (bias) A += broadcast(bias);

if (neuron) A = applyNeuron(A);

Where B is the array of MPSMatrix objects, A is the destination MPSMatrix, alpha is an array of scalar values, bias is a vector which is broadcast and accumulated across each row of the intermediate result, and applyNeuron is a neuron activation function.

Each matrix in the array may have an independent origin.

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MPSMatrixSum(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
boolean	_supportsSecureCoding() This property must return YES on all classes that allow secure coding.
static boolean	accessInstanceVariablesDirectly()
static MPSMatrixSum	alloc()
static MPSMatrixSum	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
static void	cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)
static NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static org.moe.natj.objc.Class	classForKeyedUnarchiver()
long	columns() The number of columns to sum.
long	count() The number of matrices to sum.
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
void	encodeToCommandBufferSourceMatricesResultMatrixScaleVectorOffsetVectorBiasVectorStartIndex(MTLCommandBuffer buffer, NSArray<? extends MPSMatrix> sourceMatrices, MPSMatrix resultMatrix, MPSVector scaleVector, MPSVector offsetVector, MPSVector biasVector, long startIndex) Encode the operations to the command buffer
static long	hash_static()
MPSMatrixSum	init()
MPSMatrixSum	initWithCoder(NSCoder aDecoder) NS_DESIGNATED_INITIALIZER
MPSMatrixSum	initWithCoderDevice(NSCoder aDecoder, java.lang.Object device) NSSecureCoding compatability
MPSMatrixSum	initWithDevice(java.lang.Object device) Standard init with default properties per filter type
MPSMatrixSum	initWithDeviceCountRowsColumnsTranspose(MTLDevice device, long count, long rows, long columns, boolean transpose) Initialize a MPSMatrixSum kernel.
static NSObject.Function_instanceMethodForSelector_ret	instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
static NSMethodSignature	instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
static boolean	instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
static NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
float	neuronParameterA() Neuron parameter A.
float	neuronParameterB() Neuron parameter B.
float	neuronParameterC() Neuron parameter C.
int	neuronType() Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method
static MPSMatrixSum	new_objc()
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
MTLOrigin	resultMatrixOrigin() [@property] resultMatrixOrigin
long	rows() The number of rows to sum.
void	setNeuronTypeParameterAParameterBParameterC(int neuronType, float parameterA, float parameterB, float parameterC) Specifies a neuron activation function to be used.
void	setResultMatrixOrigin(MTLOrigin value) [@property] resultMatrixOrigin
static void	setVersion_static(long aVersion)
static org.moe.natj.objc.Class	superclass_static()
static boolean	supportsSecureCoding()
boolean	transpose() The transposition used to initialize the kernel.
static long	version_static()

Methods inherited from class apple.metalperformanceshaders.MPSKernel

copyWithZone, copyWithZoneDevice, device, encodeWithCoder, label, options, setLabel, setOptions

Methods inherited from class apple.NSObject

accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject

equals, toString

Methods inherited from class org.moe.natj.general.NativeObject

finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MPSMatrixSum

protected MPSMatrixSum(org.moe.natj.general.Pointer peer)

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static MPSMatrixSum alloc()

allocWithZone

public static MPSMatrixSum 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()

columns

public long columns()

The number of columns to sum.

count

public long count()

The number of matrices to sum.

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

encodeToCommandBufferSourceMatricesResultMatrixScaleVectorOffsetVectorBiasVectorStartIndex

public void encodeToCommandBufferSourceMatricesResultMatrixScaleVectorOffsetVectorBiasVectorStartIndex(MTLCommandBuffer buffer,
                                                                                                       NSArray<? extends MPSMatrix> sourceMatrices,
                                                                                                       MPSMatrix resultMatrix,
                                                                                                       MPSVector scaleVector,
                                                                                                       MPSVector offsetVector,
                                                                                                       MPSVector biasVector,
                                                                                                       long startIndex)

Encode the operations to the command buffer

Parameters:

buffer - The command buffer in which to encode the operation.

sourceMatrices - A list of matrices from which the matrix data is read.

resultMatrix - The result matrix.

scaleVector - A MPSVector of type MPSDataTypeFloat32 containing the list of scale factors, specified in single precision.

offsetVector - A MPSVector of type MPSDataTypeUInt32 containing the list of offsets, stored as a packed array of MPSMatrixOffset values.

biasVector - A MPSVector containing the bias terms to add to the result prior to applying the neuron function, if any. May be nil.

startIndex - The starting index into the scale and offset vectors.

hash_static

public static long hash_static()

init

public MPSMatrixSum init()

Overrides:

init in class MPSKernel

initWithCoder

public MPSMatrixSum initWithCoder(NSCoder aDecoder)

Description copied from interface: NSCoding

NS_DESIGNATED_INITIALIZER

Specified by:

initWithCoder in interface NSCoding

Overrides:

initWithCoder in class MPSKernel

initWithCoderDevice

public MPSMatrixSum initWithCoderDevice(NSCoder aDecoder,
                                        java.lang.Object device)

NSSecureCoding compatability

See @ref MPSKernel#initWithCoder.

Overrides:

initWithCoderDevice in class MPSKernel

Parameters:

aDecoder - The NSCoder subclass with your serialized MPSMatrixSum kernel.

device - The MTLDevice on which to make the MPSMatrixSum object.

Returns:

A new MPSMatrixSum object, or nil if failure.

initWithDevice

public MPSMatrixSum initWithDevice(java.lang.Object device)

Description copied from class: MPSKernel

Standard init with default properties per filter type

Overrides:

initWithDevice in class MPSKernel

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.

initWithDeviceCountRowsColumnsTranspose

public MPSMatrixSum initWithDeviceCountRowsColumnsTranspose(MTLDevice device,
                                                            long count,
                                                            long rows,
                                                            long columns,
                                                            boolean transpose)

Initialize a MPSMatrixSum kernel.

Parameters:

device - The device on which to initialize the kernel.

count - The number of matrices to be summed.

rows - The number of rows to use in the input matrices.

columns - The number of columns to use in the input matrices.

transpose - If YES the result of the summation is to be transposed prior to applying the bias and activation.

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

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

Neuron parameter A.

neuronParameterB

public float neuronParameterB()

Neuron parameter B.

neuronParameterC

public float neuronParameterC()

Neuron parameter C.

neuronType

public int neuronType()

Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method

new_objc

public static MPSMatrixSum new_objc()

resolveClassMethod

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

resolveInstanceMethod

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

resultMatrixOrigin

public MTLOrigin resultMatrixOrigin()

[@property] resultMatrixOrigin

The origin, relative to [0, 0] in the result matrix, at which to start writing results. This property is modifiable and defaults to [0, 0] at initialization time. If a different origin is desired then this should be modified prior to encoding the kernel.

rows

public long rows()

The number of rows to sum.

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. An MPSMatrixSum 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.

setResultMatrixOrigin

public void setResultMatrixOrigin(MTLOrigin value)

[@property] resultMatrixOrigin

The origin, relative to [0, 0] in the result matrix, at which to start writing results. This property is modifiable and defaults to [0, 0] at initialization time. If a different origin is desired then this should be modified prior to encoding the kernel.

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 MPSKernel

transpose

public boolean transpose()

The transposition used to initialize the kernel.

version_static

public static long version_static()