Package org.robovm.apple.metalps

Class MPSCNNConvolution

java.lang.Object

org.robovm.rt.bro.NativeObject

org.robovm.objc.ObjCObject

org.robovm.apple.foundation.NSObject

org.robovm.apple.metalps.MPSKernel

org.robovm.apple.metalps.MPSCNNKernel

org.robovm.apple.metalps.MPSCNNConvolution

All Implemented Interfaces:

NSCoding, NSObjectProtocol, NSSecureCoding, ObjCProtocol

Direct Known Subclasses:

MPSCNNFullyConnected

public class MPSCNNConvolution
extends MPSCNNKernel

Since:

Available in iOS 10.0 and later.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MPSCNNConvolution.MPSCNNConvolutionPtr

Nested classes/interfaces inherited from class org.robovm.apple.metalps.MPSCNNKernel

MPSCNNKernel.MPSCNNKernelPtr

Nested classes/interfaces inherited from class org.robovm.apple.metalps.MPSKernel

MPSKernel.MPSKernelPtr

Nested classes/interfaces inherited from class org.robovm.apple.foundation.NSObject

NSObject.Handle, NSObject.Marshaler, NSObject.NoRetainMarshaler, NSObject.NSKeyValueObserver, NSObject.NSObjectPtr, NSObject.SkipInit

Nested classes/interfaces inherited from class org.robovm.objc.ObjCObject

ObjCObject.ObjCObjectPtr, ObjCObject.Super

Field Summary

Fields inherited from class org.robovm.apple.foundation.NSObject

FLAG_NO_RETAIN

Fields inherited from class org.robovm.objc.ObjCObject

customClass

Constructor Summary

Constructors

Modifier	Constructor	Description
	MPSCNNConvolution()
	MPSCNNConvolution(NSCoder coder)
	MPSCNNConvolution(NSCoder decoder, MTLDevice device)
protected	MPSCNNConvolution(NSObject.Handle h, long handle)
protected	MPSCNNConvolution(NSObject.SkipInit skipInit)
	MPSCNNConvolution(MTLDevice device, MPSCNNConvolutionDataSource weights)
	MPSCNNConvolution(MTLDevice device, MPSCNNConvolutionDescriptor convolutionDescriptor, FloatPtr kernelWeights, FloatPtr biasTerms, MPSCNNConvolutionFlags flags)	Deprecated. Deprecated in iOS 11.0.

Method Summary

Modifier and Type	Method	Description
MPSCNNConvolutionWeightsAndBiasesState	exportWeightsAndBiases(MTLCommandBuffer commandBuffer, boolean resultStateCanBeTemporary)
MPSNNConvolutionAccumulatorPrecisionOption	getAccumulatorPrecisionOption()
long	getChannelMultiplier()
MPSCNNConvolutionDataSource	getDataSource()
MPSNNNeuronDescriptor	getFusedNeuronDescriptor()
long	getGroups()
long	getInputFeatureChannels()
MPSCNNNeuron	getNeuron()	Deprecated. Deprecated in iOS 11.0.
float	getNeuronParameterA()	Deprecated. Deprecated in iOS 12.0.
float	getNeuronParameterB()	Deprecated. Deprecated in iOS 12.0.
float	getNeuronParameterC()	Deprecated. Deprecated in iOS 12.0.
MPSCNNNeuronType	getNeuronType()	Deprecated. Deprecated in iOS 12.0.
long	getOutputFeatureChannels()
MPSCNNConvolutionGradientState	getResultState(MTLCommandBuffer commandBuffer, MPSImage sourceImage, NSArray<MPSState> sourceStates, MPSImage destinationImage)
MPSCNNConvolutionGradientState	getResultState(MPSImage sourceImage, NSArray<MPSState> sourceStates, MPSImage destinationImage)
NSArray<MPSCNNConvolutionGradientState>	getResultStateBatch(NSArray<MPSImage> sourceImage, NSArray<NSArray<? extends MPSState>> sourceStates, NSArray<MPSImage> destinationImage)
long	getSubPixelScaleFactor()
NSArray<MPSCNNConvolutionGradientState>	getTemporaryResultStateBatch(MTLCommandBuffer commandBuffer, NSArray<MPSImage> sourceImage, NSArray<NSArray<? extends MPSState>> sourceStates, NSArray<MPSImage> destinationImage)
protected long	init(NSCoder decoder, MTLDevice device)
protected long	init(MTLDevice device, MPSCNNConvolutionDataSource weights)
protected long	init(MTLDevice device, MPSCNNConvolutionDescriptor convolutionDescriptor, FloatPtr kernelWeights, FloatPtr biasTerms, MPSCNNConvolutionFlags flags)	Deprecated. Deprecated in iOS 11.0.
void	reloadWeightsAndBiases(MTLCommandBuffer commandBuffer, MPSCNNConvolutionWeightsAndBiasesState state)
void	reloadWeightsAndBiases(MPSCNNConvolutionDataSource dataSource)	Deprecated. Deprecated in iOS 12.0.
void	reloadWeightsAndBiasesFromDataSource()
void	setAccumulatorPrecisionOption(MPSNNConvolutionAccumulatorPrecisionOption v)
static boolean	supportsSecureCoding()

Methods inherited from class org.robovm.apple.metalps.MPSCNNKernel

appendBatchBarrier, encode, encode, encode, encode, encodeBatch, encodeBatch, encodeBatch0, encodeBatch0, getBatchEncodingStorageSize, getClipRect, getDestinationFeatureChannelOffset, getDestinationImageAllocator, getDestinationImageDescriptor, getDilationRateX, getDilationRateY, getEdgeMode, getEncodingStorageSize, getKernelHeight, getKernelWidth, getOffset, getPadding, getSourceFeatureChannelMaxCount, getSourceFeatureChannelOffset, getStrideInPixelsX, getStrideInPixelsY, getTemporaryResult, init, isBackwards, isResultStateReusedAcrossBatch, isStateModified, setClipRect, setDestinationFeatureChannelOffset, setDestinationImageAllocator, setEdgeMode, setOffset, setPadding, setSourceFeatureChannelMaxCount, setSourceFeatureChannelOffset

Methods inherited from class org.robovm.apple.metalps.MPSKernel

copy, encode, getDevice, getLabel, getOptions, init, setLabel, setOptions

Methods inherited from class org.robovm.apple.foundation.NSObject

addKeyValueObserver, addKeyValueObserver, afterMarshaled, alloc, autorelease, autorelease, awakeFromNib, conformsToProtocol, copy, description, didChangeValue, didChangeValue, didChangeValues, doDispose, equals, forceSkipInit, getAutoContentAccessingProxy, getClassForCoder, getClassForKeyedArchiver, getKeyValueCoder, getObservationInfo, hash, hashCode, init, isEqual, isKindOfClass, isMemberOfClass, mutableCopy, performSelector, performSelector, performSelector, performSelector, performSelector, performSelector, performSelector, performSelectorInBackground, performSelectorOnMainThread, performSelectorOnMainThread, performSelectorV, performSelectorV, performSelectorV, release, release, removeKeyValueObserver, removeKeyValueObservers, respondsToSelector, retain, retain, retainCount, setObservationInfo, toString, willChangeValue, willChangeValue, willChangeValues

Methods inherited from class org.robovm.objc.ObjCObject

addStrongRef, dispose, dispose, finalize, getAssociatedObject, getObjCClass, getPeerObject, getSuper, initObject, logRetainRelease, removeStrongRef, retainCustomObjectFromCb, setAssociatedObject, toObjCObject, toObjCObject, updateStrongRef

Methods inherited from class org.robovm.rt.bro.NativeObject

as, getHandle, setHandle

Methods inherited from class java.lang.Object

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

Constructor Details

MPSCNNConvolution

public MPSCNNConvolution()

MPSCNNConvolution

protected MPSCNNConvolution(NSObject.Handle h,
long handle)

MPSCNNConvolution

protected MPSCNNConvolution(NSObject.SkipInit skipInit)

MPSCNNConvolution

public MPSCNNConvolution(MTLDevice device,
MPSCNNConvolutionDataSource weights)

Since:

Available in iOS 11.0 and later.

MPSCNNConvolution

@Deprecated
public MPSCNNConvolution(MTLDevice device,
MPSCNNConvolutionDescriptor convolutionDescriptor,
FloatPtr kernelWeights,
FloatPtr biasTerms,
MPSCNNConvolutionFlags flags)

Deprecated.

Deprecated in iOS 11.0. Use Please use -initWithDevice:convolutionDescriptor:weights: instead.

Since:

Available in iOS 10.0 and later.

MPSCNNConvolution

public MPSCNNConvolution(NSCoder decoder,
MTLDevice device)

Since:

Available in iOS 11.0 and later.

MPSCNNConvolution

public MPSCNNConvolution(NSCoder coder)

Method Details

getInputFeatureChannels

public long getInputFeatureChannels()

getOutputFeatureChannels

public long getOutputFeatureChannels()

getGroups

public long getGroups()

getDataSource

public MPSCNNConvolutionDataSource getDataSource()

getSubPixelScaleFactor

public long getSubPixelScaleFactor()

getNeuron

@Deprecated
public MPSCNNNeuron getNeuron()

Deprecated.

Deprecated in iOS 11.0. Use A MPSCNNNeuron is much too heavy for this purpose. Please set fusedNeuronDescriptor property of convolution descriptor instead.

Since:

Available in iOS 10.0 and later.

getNeuronType

@Deprecated
public MPSCNNNeuronType getNeuronType()

Deprecated.

Deprecated in iOS 12.0. Use fusedNeuronDesciptor instead.

Since:

Available in iOS 10.0 and later.

getNeuronParameterA

@Deprecated
public float getNeuronParameterA()

Deprecated.

Deprecated in iOS 12.0. Use fusedNeuronDesciptor instead.

Since:

Available in iOS 10.0 and later.

getNeuronParameterB

@Deprecated
public float getNeuronParameterB()

Deprecated.

Deprecated in iOS 12.0. Use fusedNeuronDesciptor instead.

Since:

Available in iOS 10.0 and later.

getNeuronParameterC

@Deprecated
public float getNeuronParameterC()

Deprecated.

Deprecated in iOS 12.0. Use fusedNeuronDesciptor instead.

Since:

Available in iOS 10.0 and later.

getFusedNeuronDescriptor

public MPSNNNeuronDescriptor getFusedNeuronDescriptor()

Since:

Available in iOS 12.0 and later.

getChannelMultiplier

public long getChannelMultiplier()

getAccumulatorPrecisionOption

public MPSNNConvolutionAccumulatorPrecisionOption getAccumulatorPrecisionOption()

Since:

Available in iOS 11.3 and later.

setAccumulatorPrecisionOption

public void setAccumulatorPrecisionOption(MPSNNConvolutionAccumulatorPrecisionOption v)

Since:

Available in iOS 11.3 and later.

supportsSecureCoding

public static boolean supportsSecureCoding()

init

protected long init(MTLDevice device,
MPSCNNConvolutionDataSource weights)

Since:

Available in iOS 11.0 and later.

init

@Deprecated
protected long init(MTLDevice device,
MPSCNNConvolutionDescriptor convolutionDescriptor,
FloatPtr kernelWeights,
FloatPtr biasTerms,
MPSCNNConvolutionFlags flags)

Deprecated.

Deprecated in iOS 11.0. Use Please use -initWithDevice:convolutionDescriptor:weights: instead.

Since:

Available in iOS 10.0 and later.

init

protected long init(NSCoder decoder,
MTLDevice device)

Overrides:

init in class MPSCNNKernel

Since:

Available in iOS 11.0 and later.

getResultState

public MPSCNNConvolutionGradientState getResultState(MPSImage sourceImage,
NSArray<MPSState> sourceStates,
MPSImage destinationImage)

Overrides:

getResultState in class MPSCNNKernel

Since:

Available in iOS 11.3 and later.

getResultStateBatch

public NSArray<MPSCNNConvolutionGradientState> getResultStateBatch(NSArray<MPSImage> sourceImage,
NSArray<NSArray<? extends MPSState>> sourceStates,
NSArray<MPSImage> destinationImage)

Overrides:

getResultStateBatch in class MPSCNNKernel

Since:

Available in iOS 11.3 and later.

getResultState

public MPSCNNConvolutionGradientState getResultState(MTLCommandBuffer commandBuffer,
MPSImage sourceImage,
NSArray<MPSState> sourceStates,
MPSImage destinationImage)

Since:

Available in iOS 11.3 and later.

getTemporaryResultStateBatch

public NSArray<MPSCNNConvolutionGradientState> getTemporaryResultStateBatch(MTLCommandBuffer commandBuffer,
NSArray<MPSImage> sourceImage,
NSArray<NSArray<? extends MPSState>> sourceStates,
NSArray<MPSImage> destinationImage)

Overrides:

getTemporaryResultStateBatch in class MPSCNNKernel

Since:

Available in iOS 11.3 and later.

reloadWeightsAndBiasesFromDataSource

public void reloadWeightsAndBiasesFromDataSource()

Since:

Available in iOS 12.0 and later.

reloadWeightsAndBiases

@Deprecated
public void reloadWeightsAndBiases(MPSCNNConvolutionDataSource dataSource)

Deprecated.

Deprecated in iOS 12.0. Use Please use -reloadWeightsAndBiasesFromDataSource instead.

Since:

Available in iOS 11.3 and later.

reloadWeightsAndBiases

public void reloadWeightsAndBiases(MTLCommandBuffer commandBuffer,
MPSCNNConvolutionWeightsAndBiasesState state)

Since:

Available in iOS 11.3 and later.

exportWeightsAndBiases

public MPSCNNConvolutionWeightsAndBiasesState exportWeightsAndBiases(MTLCommandBuffer commandBuffer,
boolean resultStateCanBeTemporary)

Since:

Available in iOS 11.3 and later.