mpsmatrix

func (Acl_entry_id_t) String ¶

func (e Acl_entry_id_t) String() string

func (Acl_flag_t) String ¶

func (e Acl_flag_t) String() string

func (Acl_perm_t) String ¶

func (e Acl_perm_t) String() string

func (Acl_tag_t) String ¶

func (e Acl_tag_t) String() string

func (Acl_type_t) String ¶

func (e Acl_type_t) String() string

func (Clockid_t) String ¶

func (e Clockid_t) String() string

func (Dispatch_autorelease_frequency_t) String ¶

func (e Dispatch_autorelease_frequency_t) String() string

func (Dispatch_block_flags_t) String ¶

func (e Dispatch_block_flags_t) String() string

func (Filesec_property_t) String ¶

func (e Filesec_property_t) String() string

func (Idtype_t) String ¶

func (e Idtype_t) String() string

func (Ipc_info_object_type_t) String ¶

func (e Ipc_info_object_type_t) String() string

func (Launch_data_type_t) String ¶

func (e Launch_data_type_t) String() string

func (MDLabelDomain) String ¶

func (e MDLabelDomain) String() string

func (MDQueryOptionFlags) String ¶

func (e MDQueryOptionFlags) String() string

func (MDQuerySortOptionFlags) String ¶

func (e MDQuerySortOptionFlags) String() string

func (MPSCustomKernelIndex) String ¶

func (e MPSCustomKernelIndex) String() string

func (MPSDeviceCapsValues) String ¶

func (e MPSDeviceCapsValues) String() string

func (MPSImageType) String ¶

func (e MPSImageType) String() string

func (*MPSMatrixBinaryKernel) BatchSize ¶

func (o *MPSMatrixBinaryKernel) BatchSize() uint

@property batchSize @discussion The number of matrices in the batch to process. This property is modifiable and by default allows all matrices available at encoding time to be processed. If a single matrix should be processed set this value to 1.

func (*MPSMatrixBinaryKernel) BatchStart ¶

func (o *MPSMatrixBinaryKernel) BatchStart() uint

@property batchStart @discussion The index of the first matrix in the batch. This property is modifiable and defaults to 0 at initialization time. If batch processing should begin at a different matrix this value should be modified prior to encoding the kernel.

func (*MPSMatrixBinaryKernel) PrimarySourceMatrixOrigin ¶

func (o *MPSMatrixBinaryKernel) PrimarySourceMatrixOrigin() metal.MTLOrigin

@property primarySourceMatrixOrigin @discussion The origin, relative to [0, 0] in the primary source matrix, at which to start reading values. 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. The z value must be 0.

func (*MPSMatrixBinaryKernel) ResultMatrixOrigin ¶

func (o *MPSMatrixBinaryKernel) ResultMatrixOrigin() metal.MTLOrigin

@property resultMatrixOrigin @discussion 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. The z value must be 0.

func (*MPSMatrixBinaryKernel) SecondarySourceMatrixOrigin ¶

func (o *MPSMatrixBinaryKernel) SecondarySourceMatrixOrigin() metal.MTLOrigin

@property secondarySourceMatrixOrigin @discussion The origin, relative to [0, 0] in the secondary source matrix, at which to start reading values. 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. The z value must be 0.

func (*MPSMatrixBinaryKernel) SetBatchSize ¶

func (o *MPSMatrixBinaryKernel) SetBatchSize(batchSize uint)

func (*MPSMatrixBinaryKernel) SetBatchStart ¶

func (o *MPSMatrixBinaryKernel) SetBatchStart(batchStart uint)

func (*MPSMatrixBinaryKernel) SetPrimarySourceMatrixOrigin ¶

func (o *MPSMatrixBinaryKernel) SetPrimarySourceMatrixOrigin(primarySourceMatrixOrigin metal.MTLOrigin)

func (*MPSMatrixBinaryKernel) SetResultMatrixOrigin ¶

func (o *MPSMatrixBinaryKernel) SetResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin)

func (*MPSMatrixBinaryKernel) SetSecondarySourceMatrixOrigin ¶

func (o *MPSMatrixBinaryKernel) SetSecondarySourceMatrixOrigin(secondarySourceMatrixOrigin metal.MTLOrigin)

func (*MPSMatrixCopy) CopyColumns ¶

func (o *MPSMatrixCopy) CopyColumns() uint

@abstract The number of columns to copy for each copy operation

func (*MPSMatrixCopy) CopyRows ¶

func (o *MPSMatrixCopy) CopyRows() uint

@abstract The number of rows to copy for each copy operation

func (*MPSMatrixCopy) DestinationsAreTransposed ¶

func (o *MPSMatrixCopy) DestinationsAreTransposed() bool

@abstract If YES, the destinations are in row major storage order

func (*MPSMatrixCopy) EncodeToCommandBufferCopyDescriptor ¶

func (o *MPSMatrixCopy) EncodeToCommandBufferCopyDescriptor(commandBuffer metal.MTLCommandBuffer, copyDescriptor *MPSMatrixCopyDescriptor)

@abstract Encode the copy operations to the command buffer @param commandBuffer A valid MTLCommandBuffer to receive the encoded kernel. @param copyDescriptor The descriptor that defines the copy operator

func (*MPSMatrixCopy) EncodeToCommandBufferCopyDescriptorRowPermuteIndicesRowPermuteOffsetColumnPermuteIndicesColumnPermuteOffset ¶

func (o *MPSMatrixCopy) EncodeToCommandBufferCopyDescriptorRowPermuteIndicesRowPermuteOffsetColumnPermuteIndicesColumnPermuteOffset(commandBuffer metal.MTLCommandBuffer, copyDescriptor *MPSMatrixCopyDescriptor, rowPermuteIndices *mpscore.MPSVector, rowPermuteOffset uint, columnPermuteIndices *mpscore.MPSVector, columnPermuteOffset uint)

@abstract Encode the copy operations to the command buffer. This of the encode version support permuting the outputs with custom vectors of indices. The permutations are defined on the destination indices and are the same for each copy operation. @param commandBuffer A valid MTLCommandBuffer to receive the encoded kernel. @param copyDescriptor The descriptor that defines the copy operator @param rowPermuteIndices If not nil then the output row index is 'rowPermuteIndices[i] + rowOffset' instead of 'i + rowOffset', where 'i' is the local row index of the copy operation. Note: if destinationsAreTransposed is set to YES then the destination transpose is performed before permutations. @param rowPermuteOffset Offset in numbers to apply to the 'rowPermuteIndices' vector. @param columnPermuteIndices If not nil then the output column index is 'columnPermuteIndices[i] + columnOffset' instead of 'i + columnOffset', where 'i' is the local column index of the copy operation. Note: if destinationsAreTransposed is set to YES then the destination transpose is performed before permutations. @param columnPermuteOffset Offset in numbers to apply to the 'columnPermuteIndices' vector.

func (*MPSMatrixCopy) InitWithCoderDevice ¶

func (o *MPSMatrixCopy) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSMatrixCopy

@abstract NSSecureCoding compatability @discussion See @ref MPSKernel#initWithCoder. @param aDecoder The NSCoder subclass with your serialized MPSMatrixLookUpAndCopy @param device The MTLDevice on which to make the MPSMatrixLookUpAndCopy @return A new MPSMatrixLookUpAndCopy object, or nil if failure.

func (*MPSMatrixCopy) InitWithDeviceCopyRowsCopyColumnsSourcesAreTransposedDestinationsAreTransposed ¶

func (o *MPSMatrixCopy) InitWithDeviceCopyRowsCopyColumnsSourcesAreTransposedDestinationsAreTransposed(device metal.MTLDevice, copyRows uint, copyColumns uint, sourcesAreTransposed bool, destinationsAreTransposed bool) *MPSMatrixCopy

@abstract Initialize a copy operator @param copyRows The number of rows to copy for each copy operation @param copyColumns The number of matrix columns to copy in each copy operation @param sourcesAreTransposed If YES, the sources are in column major storage order @param destinationsAreTransposed If YES, the destinations are in column major storage order

func (*MPSMatrixCopy) SourcesAreTransposed ¶

func (o *MPSMatrixCopy) SourcesAreTransposed() bool

@abstract If YES, the sources are in row major storage order

func (*MPSMatrixCopyDescriptor) InitWithDeviceCount ¶

func (o *MPSMatrixCopyDescriptor) InitWithDeviceCount(device metal.MTLDevice, count uint) *MPSMatrixCopyDescriptor

@abstract initialize a MPSMatrixCopyDescriptor with default values. @discussion Use -setCopyOperationAtIndex:sourceMatrix:destinationMatrix:copyOffsets to initialize. All indices must be initialized before use. @param device The device on which the copy will be performed @param count The number of copy operations the object will encode @return A MPSMatrixCopyDescriptor. It still needs to be initialized with -setCopyOperationAtIndex:sourceMatrix:destinationMatrix:copyOffsets

func (*MPSMatrixCopyDescriptor) InitWithSourceMatricesDestinationMatricesOffsetVectorOffset ¶

func (o *MPSMatrixCopyDescriptor) InitWithSourceMatricesDestinationMatricesOffsetVectorOffset(sourceMatrices *foundation.NSArray[*mpscore.MPSMatrix], destinationMatrices *foundation.NSArray[*mpscore.MPSMatrix], offsets *mpscore.MPSVector, byteOffset uint) *MPSMatrixCopyDescriptor

@abstract Initialize a MPSMatrixCopyDescriptor using offsets generated on the GPU @discussion Use this method when the offsets needed are coming from GPU based computation. @param sourceMatrices A list of matrices from which the matrix data is read @param destinationMatrices A list of matrices to which to write the data. The count must match the number of source matrices. @param offsets A MPSVector of type MPSDataTypeUInt32 containing the list of offsets, stored as a packed array of MPSMatrixCopyOffsets. @param byteOffset A byte offset into the offsets vector where the data starts in 'offsets'. This value must be a multiple of 16. @result A valid MPSMatrixCopyDescriptor to represent the list of copy operations

func (*MPSMatrixCopyDescriptor) SetCopyOperationAtIndexSourceMatrixDestinationMatrixOffsets ¶

func (o *MPSMatrixCopyDescriptor) SetCopyOperationAtIndexSourceMatrixDestinationMatrixOffsets(index uint, sourceMatrix *mpscore.MPSMatrix, destinationMatrix *mpscore.MPSMatrix, offsets MPSMatrixCopyOffsets)

@abstract Initialize a MPSMatrixCopyDescriptor using offsets generated on the CPU @discussion This is for one at a time intialization of the copy operations @param index The index of the copy operation @param sourceMatrix The source matrix for this copy operation @param destinationMatrix The destination matrix for this copy operation @param offsets The offsets to use for the copy operation

func (*MPSMatrixDecompositionCholesky) EncodeToCommandBufferSourceMatrixResultMatrixStatus ¶

func (o *MPSMatrixDecompositionCholesky) EncodeToCommandBufferSourceMatrixResultMatrixStatus(commandBuffer metal.MTLCommandBuffer, sourceMatrix *mpscore.MPSMatrix, resultMatrix *mpscore.MPSMatrix, status metal.MTLBuffer)

@abstract Encode a MPSMatrixDecompositionCholesky kernel into a command Buffer. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param sourceMatrix A valid MPSMatrix containing the source data. Must have enough space to hold a order x order matrix. @param resultMatrix A valid MPSMatrix to contain the result. Must have enough space to hold a order x order matrix. @param status A MTLBuffer which indicates the resulting MPSMatrixDecompositionStatus value. @discussion This function encodes the MPSMatrixDecompositionCholesky object to a valid command buffer. If during the factorization a leading minor of the matrix is found to be not positive definite, MPSMatrixDecompositionNonPositiveDefinite will be returned in the provided status buffer. Previously computed pivots and the non positive pivot are written to the result, but the factorization does not complete. 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. If the return status is MPSMatrixDecompositionStatusSuccess, resultMatrix contains the resulting factors in its lower or upper triangular regions respectively. 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.

func (*MPSMatrixDecompositionCholesky) InitWithDeviceLowerOrder ¶

func (o *MPSMatrixDecompositionCholesky) InitWithDeviceLowerOrder(device metal.MTLDevice, lower bool, order uint) *MPSMatrixDecompositionCholesky

@abstract Initialize an MPSMatrixDecompositionCholesky object on a device @param device The device on which the kernel will execute. @param lower A boolean value indicating if the lower triangular part of the source matrix is stored. If lower = YES the lower triangular part will be used and the factor will be written to the lower triangular part of the result, otherwise the upper triangular part will be used and the factor will be written to the upper triangular part. @param order The number of rows and columns in the source matrix. @return A valid MPSMatrixDecompositionCholesky object or nil, if failure.

func (*MPSMatrixDecompositionLU) EncodeToCommandBufferSourceMatrixResultMatrixPivotIndicesStatus ¶

func (o *MPSMatrixDecompositionLU) EncodeToCommandBufferSourceMatrixResultMatrixPivotIndicesStatus(commandBuffer metal.MTLCommandBuffer, sourceMatrix *mpscore.MPSMatrix, resultMatrix *mpscore.MPSMatrix, pivotIndices *mpscore.MPSMatrix, status metal.MTLBuffer)

@abstract Encode a MPSMatrixDecompositionLU kernel into a command Buffer. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param sourceMatrix A valid MPSMatrix containing the source data. Must have enough space to hold a rows x columns matrix. @param resultMatrix A valid MPSMatrix to contain the result. Must have enough space to hold a rows x columns matrix. @param 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. @param status A MTLBuffer which indicates the resulting MPSMatrixDecompositionStatus value. @discussion 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.

func (*MPSMatrixDecompositionLU) InitWithDeviceRowsColumns ¶

func (o *MPSMatrixDecompositionLU) InitWithDeviceRowsColumns(device metal.MTLDevice, rows uint, columns uint) *MPSMatrixDecompositionLU

@abstract Initialize an MPSMatrixDecompositionLU object on a device @param device The device on which the kernel will execute. @param rows The number of rows in the source matrix. @param columns The number of columns in the source matrix. @return A valid MPSMatrixDecompositionLU object or nil, if failure.

func (MPSMatrixDecompositionStatus) String ¶

func (e MPSMatrixDecompositionStatus) String() string

func (*MPSMatrixFindTopK) EncodeToCommandBufferInputMatrixResultIndexMatrixResultValueMatrix ¶

func (o *MPSMatrixFindTopK) EncodeToCommandBufferInputMatrixResultIndexMatrixResultValueMatrix(commandBuffer metal.MTLCommandBuffer, inputMatrix *mpscore.MPSMatrix, resultIndexMatrix *mpscore.MPSMatrix, resultValueMatrix *mpscore.MPSMatrix)

@abstract Encode a MPSMatrixFindTopK object to a command buffer. @param commandBuffer A valid MTLCommandBuffer to receive the encoded kernel. @param inputMatrix A valid MPSMatrix object which specifies the input matrix. @param resultIndexMatrix A valid MPSMatrix object which specifies the matrix which will be overwritten by the result indices. This matrix must have datatype MPSDataTypeUInt32. @param resultValueMatrix A valid MPSMatrix object which specifies the matrix which will be overwritten by the result values. @discussion 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.

func (*MPSMatrixFindTopK) IndexOffset ¶

func (o *MPSMatrixFindTopK) IndexOffset() uint

@property indexOffset @discussion 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.

func (*MPSMatrixFindTopK) InitWithCoderDevice ¶

func (o *MPSMatrixFindTopK) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSMatrixFindTopK

func (*MPSMatrixFindTopK) InitWithDeviceNumberOfTopKValues ¶

func (o *MPSMatrixFindTopK) InitWithDeviceNumberOfTopKValues(device metal.MTLDevice, numberOfTopKValues uint) *MPSMatrixFindTopK

func (*MPSMatrixFindTopK) NumberOfTopKValues ¶

func (o *MPSMatrixFindTopK) NumberOfTopKValues() uint

@property numberOfTopKValues @discussion 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.

func (*MPSMatrixFindTopK) SetIndexOffset ¶

func (o *MPSMatrixFindTopK) SetIndexOffset(indexOffset uint)

func (*MPSMatrixFindTopK) SetNumberOfTopKValues ¶

func (o *MPSMatrixFindTopK) SetNumberOfTopKValues(numberOfTopKValues uint)

func (*MPSMatrixFindTopK) SetSourceColumns ¶

func (o *MPSMatrixFindTopK) SetSourceColumns(sourceColumns uint)

func (*MPSMatrixFindTopK) SetSourceRows ¶

func (o *MPSMatrixFindTopK) SetSourceRows(sourceRows uint)

func (*MPSMatrixFindTopK) SourceColumns ¶

func (o *MPSMatrixFindTopK) SourceColumns() uint

@property sourceColumns @discussion 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).

func (*MPSMatrixFindTopK) SourceRows ¶

func (o *MPSMatrixFindTopK) SourceRows() uint

@property sourceRows @discussion 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).

func (*MPSMatrixMultiplication) BatchSize ¶

func (o *MPSMatrixMultiplication) BatchSize() uint

@property batchSize @discussion The number of matrices in the batch to process. This property is modifiable and by default allows all matrices available at encoding time to be processed.

func (*MPSMatrixMultiplication) BatchStart ¶

func (o *MPSMatrixMultiplication) BatchStart() uint

@property batchStart @discussion The index of the first matrix in the batch. This property is modifiable and defaults to 0 at initialization time. If batch processing should begin at a different matrix this value should be modified prior to encoding the kernel.

func (*MPSMatrixMultiplication) EncodeToCommandBufferLeftMatrixRightMatrixResultMatrix ¶

func (o *MPSMatrixMultiplication) EncodeToCommandBufferLeftMatrixRightMatrixResultMatrix(commandBuffer metal.MTLCommandBuffer, leftMatrix *mpscore.MPSMatrix, rightMatrix *mpscore.MPSMatrix, resultMatrix *mpscore.MPSMatrix)

@abstract Encode a MPSMatrixMultiplication object to a command buffer. @param commandBuffer A valid MTLCommandBuffer to receive the encoded kernel. @param leftMatrix A valid MPSMatrix object which specifies the left input matrix. @param rightMatrix A valid MPSMatrix object which specifies the right input matrix. @param resultMatrix A valid MPSMatrix object which specifies the addend matrix which will also be overwritten by the result. @discussion Certain constraints apply to the sizes of the matrices depending on the transposition operations and sizes requested at initialization time as well as the origins at the time this routine is called: The left input matrix must be large enough to hold an array of size resultRows x interiorColumns elements beginning at leftMatrixOrigin. The right input matrix must be large enough to hold an array of size interiorColumns x resultColumns elements beginning at rightMatrixOrigin. The result matrix must be large enough to hold an array of size resultRows x resultColumns elements beginning at resultMatrixOrigin. Each matrix within the range specified by batchStart and batchSize, which also specifies a valid set of matrices within leftMatrix, rightMatrix, and resultMatrix, will be processed.

func (*MPSMatrixMultiplication) InitWithDeviceResultRowsResultColumnsInteriorColumns ¶

func (o *MPSMatrixMultiplication) InitWithDeviceResultRowsResultColumnsInteriorColumns(device metal.MTLDevice, resultRows uint, resultColumns uint, interiorColumns uint) *MPSMatrixMultiplication

@abstract Convenience initialization for a matrix-matrix multiplication with no transpositions, unit scaling of the product, and no accumulation of the result. The scaling factors alpha and beta are taken to be 1.0 and 0.0 respectively. @param device The device on which the kernel will execute. @param resultRows The number of rows in the result matrix, M in BLAS GEMM description. @param resultColumns The number of columns in the result matrix, N in BLAS GEMM description. @param interiorColumns The number of columns of the left input matrix. K in BLAS GEMM description. @return A valid MPSMatrixMultiplication object or nil, if failure.

func (*MPSMatrixMultiplication) InitWithDeviceTransposeLeftTransposeRightResultRowsResultColumnsInteriorColumnsAlphaBeta ¶

func (o *MPSMatrixMultiplication) InitWithDeviceTransposeLeftTransposeRightResultRowsResultColumnsInteriorColumnsAlphaBeta(device metal.MTLDevice, transposeLeft bool, transposeRight bool, resultRows uint, resultColumns uint, interiorColumns uint, alpha float64, beta float64) *MPSMatrixMultiplication

@abstract Initialize an MPSMatrixMultiplication object on a device for a given size and desired transpose and scale values. @param device The device on which the kernel will execute. @param transposeLeft A boolean value which indicates if the left input matrix should be used in transposed form. If 'YES' then op(A) = A**T, otherwise op(A) = A. @param transposeRight A boolean value which indicates if the right input matrix should be used in transposed form. If 'YES' then op(B) = B**T, otherwise op(B) = B. @param resultRows The number of rows in the result matrix, M in BLAS GEMM description. @param resultColumns The number of columns in the result matrix, N in BLAS GEMM description. @param interiorColumns The number of columns of the left input matrix after the appropriate transpose operation has been applied. K in BLAS GEMM description. @param 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. @param beta The scale factor to apply to the initial values of C. Specified in double precision. Will be converted to the appropriate precision in the implementation subject to rounding and/or clamping as necessary. @return A valid MPSMatrixMultiplication object or nil, if failure.

func (*MPSMatrixMultiplication) LeftMatrixOrigin ¶

func (o *MPSMatrixMultiplication) LeftMatrixOrigin() metal.MTLOrigin

@property leftMatrixOrigin @discussion The origin, relative to [0, 0] in the left input matrix, at which to start reading values. 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. The z value must be 0.

func (*MPSMatrixMultiplication) ResultMatrixOrigin ¶

func (o *MPSMatrixMultiplication) ResultMatrixOrigin() metal.MTLOrigin

@property resultMatrixOrigin @discussion The origin, relative to [0, 0] in the result matrix, at which to start writing (and reading if necessary) 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. The z value must be 0.

func (*MPSMatrixMultiplication) RightMatrixOrigin ¶

func (o *MPSMatrixMultiplication) RightMatrixOrigin() metal.MTLOrigin

@property rightMatrixOrigin @discussion The origin, relative to [0, 0] in the right input matrix, at which to start reading values. 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. The z value must be 0.

func (*MPSMatrixMultiplication) SetBatchSize ¶

func (o *MPSMatrixMultiplication) SetBatchSize(batchSize uint)

func (*MPSMatrixMultiplication) SetBatchStart ¶

func (o *MPSMatrixMultiplication) SetBatchStart(batchStart uint)

func (*MPSMatrixMultiplication) SetLeftMatrixOrigin ¶

func (o *MPSMatrixMultiplication) SetLeftMatrixOrigin(leftMatrixOrigin metal.MTLOrigin)

func (*MPSMatrixMultiplication) SetResultMatrixOrigin ¶

func (o *MPSMatrixMultiplication) SetResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin)

func (*MPSMatrixMultiplication) SetRightMatrixOrigin ¶

func (o *MPSMatrixMultiplication) SetRightMatrixOrigin(rightMatrixOrigin metal.MTLOrigin)

func (*MPSMatrixRandom) BatchSize ¶

func (o *MPSMatrixRandom) BatchSize() uint

@property batchSize @discussion The size of the batch to process.

func (*MPSMatrixRandom) BatchStart ¶

func (o *MPSMatrixRandom) BatchStart() uint

@property batchStart @discussion The starting index in the destination batch.

func (*MPSMatrixRandom) DestinationDataType ¶

func (o *MPSMatrixRandom) DestinationDataType() mpscore.MPSDataType

@property destinationDataType @discussion The type of the data which makes up the values of the result. Supported values are: MPSDataTypeUInt32 MPSDataTypeFloat32 Default is MPSDataTypeUInt32

func (*MPSMatrixRandom) DistributionType ¶

func (o *MPSMatrixRandom) DistributionType() MPSMatrixRandomDistribution

@property distributionType @discussion The distribution from which to generate random values. Default is MPSMatrixRandomDistributionDefault

func (*MPSMatrixRandom) EncodeToCommandBufferDestinationMatrix ¶

func (o *MPSMatrixRandom) EncodeToCommandBufferDestinationMatrix(commandBuffer metal.MTLCommandBuffer, destinationMatrix *mpscore.MPSMatrix)

@abstract Encode a MPSMatrixRandom kernel into a command Buffer. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param destinationMatrix A valid MPSMatrix to contain the result.

func (*MPSMatrixRandom) EncodeToCommandBufferDestinationVector ¶

func (o *MPSMatrixRandom) EncodeToCommandBufferDestinationVector(commandBuffer metal.MTLCommandBuffer, destinationVector *mpscore.MPSVector)

@abstract Encode a MPSMatrixRandom kernel into a command Buffer. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param destinationVector A valid MPSVector to contain the result.

func (*MPSMatrixRandom) SetBatchSize ¶

func (o *MPSMatrixRandom) SetBatchSize(batchSize uint)

func (*MPSMatrixRandom) SetBatchStart ¶

func (o *MPSMatrixRandom) SetBatchStart(batchStart uint)

func (MPSMatrixRandomDistribution) String ¶

func (e MPSMatrixRandomDistribution) String() string

func (*MPSMatrixRandomDistributionDescriptor) DistributionType ¶

func (o *MPSMatrixRandomDistributionDescriptor) DistributionType() MPSMatrixRandomDistribution

@property distributionType @abstract The type of distribution.

func (*MPSMatrixRandomDistributionDescriptor) Maximum ¶

func (o *MPSMatrixRandomDistributionDescriptor) Maximum() float32

@property maximum @abstract For distributions of values bounded above, this value describes the maximum.

func (*MPSMatrixRandomDistributionDescriptor) Mean ¶

func (o *MPSMatrixRandomDistributionDescriptor) Mean() float32

@property mean @abstract The value to use for distributions described by their mean.

func (*MPSMatrixRandomDistributionDescriptor) Minimum ¶

func (o *MPSMatrixRandomDistributionDescriptor) Minimum() float32

@property minimum @abstract For distributions of values bounded below, this value describes the minimum.

func (*MPSMatrixRandomDistributionDescriptor) SetDistributionType ¶

func (o *MPSMatrixRandomDistributionDescriptor) SetDistributionType(distributionType MPSMatrixRandomDistribution)

func (*MPSMatrixRandomDistributionDescriptor) SetMaximum ¶

func (o *MPSMatrixRandomDistributionDescriptor) SetMaximum(maximum float32)

func (*MPSMatrixRandomDistributionDescriptor) SetMean ¶

func (o *MPSMatrixRandomDistributionDescriptor) SetMean(mean float32)

func (*MPSMatrixRandomDistributionDescriptor) SetMinimum ¶

func (o *MPSMatrixRandomDistributionDescriptor) SetMinimum(minimum float32)

func (*MPSMatrixRandomDistributionDescriptor) SetStandardDeviation ¶

func (o *MPSMatrixRandomDistributionDescriptor) SetStandardDeviation(standardDeviation float32)

func (*MPSMatrixRandomDistributionDescriptor) StandardDeviation ¶

func (o *MPSMatrixRandomDistributionDescriptor) StandardDeviation() float32

@property standardDeviation @abstract The value to use for distributions described by their standardDeviation.

func (*MPSMatrixRandomMTGP32) InitWithCoderDevice ¶

func (o *MPSMatrixRandomMTGP32) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSMatrixRandomMTGP32

func (*MPSMatrixRandomMTGP32) InitWithDevice ¶

func (o *MPSMatrixRandomMTGP32) InitWithDevice(device metal.MTLDevice) *MPSMatrixRandomMTGP32

@abstract initialize a MPSMatrixRandomMTGP32 filter to generate 32-bit unsigned integer values with an initial seed of 0. @param device The device the filter will run on

func (*MPSMatrixRandomMTGP32) InitWithDeviceDestinationDataTypeSeed ¶

func (o *MPSMatrixRandomMTGP32) InitWithDeviceDestinationDataTypeSeed(device metal.MTLDevice, destinationDataType mpscore.MPSDataType, seed uint) *MPSMatrixRandomMTGP32

@abstract initialize a MPSMatrixRandomMTGP32 filter using a default distribution. @param device The device the filter will run on @param destinationDataType The data type of the result. @param seed The seed to initialize the random number generators with.

func (*MPSMatrixRandomMTGP32) InitWithDeviceDestinationDataTypeSeedDistributionDescriptor ¶

func (o *MPSMatrixRandomMTGP32) InitWithDeviceDestinationDataTypeSeedDistributionDescriptor(device metal.MTLDevice, destinationDataType mpscore.MPSDataType, seed uint, distributionDescriptor *MPSMatrixRandomDistributionDescriptor) *MPSMatrixRandomMTGP32

@abstract initialize a MPSMatrixRandomMTGP32 filter @param device The device the filter will run on @param destinationDataType The data type of the result. @param seed The seed to initialize the random number generators with. @param distributionDescriptor A descriptor containing information about the distribution.

func (*MPSMatrixRandomMTGP32) SynchronizeStateOnCommandBuffer ¶

func (o *MPSMatrixRandomMTGP32) SynchronizeStateOnCommandBuffer(commandBuffer metal.MTLCommandBuffer)

@abstract Synchronize internal MTGP32 state between GPU and CPU. @param commandBuffer The command buffer on which to encode the synchronization.

func (*MPSMatrixRandomPhilox) InitWithCoderDevice ¶

func (o *MPSMatrixRandomPhilox) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSMatrixRandomPhilox

func (*MPSMatrixRandomPhilox) InitWithDevice ¶

func (o *MPSMatrixRandomPhilox) InitWithDevice(device metal.MTLDevice) *MPSMatrixRandomPhilox

@abstract initialize a MPSMatrixRandomPhilox filter to generate 32-bit unsigned integer values with an initial seed of 0. @param device The device the filter will run on

func (*MPSMatrixRandomPhilox) InitWithDeviceDestinationDataTypeSeed ¶

func (o *MPSMatrixRandomPhilox) InitWithDeviceDestinationDataTypeSeed(device metal.MTLDevice, destinationDataType mpscore.MPSDataType, seed uint) *MPSMatrixRandomPhilox

@abstract initialize a MPSMatrixRandomPhilox filter using a default distribution. @param device The device the filter will run on @param destinationDataType The data type of the result. @param seed The seed to initialize the random number generators with.

func (*MPSMatrixRandomPhilox) InitWithDeviceDestinationDataTypeSeedDistributionDescriptor ¶

func (o *MPSMatrixRandomPhilox) InitWithDeviceDestinationDataTypeSeedDistributionDescriptor(device metal.MTLDevice, destinationDataType mpscore.MPSDataType, seed uint, distributionDescriptor *MPSMatrixRandomDistributionDescriptor) *MPSMatrixRandomPhilox

@abstract initialize a MPSMatrixRandomPhilox filter @param device The device the filter will run on @param destinationDataType The data type of the result. @param seed The seed to initialize the random number generators with. @param distributionDescriptor A descriptor containing information about the distribution.

func (*MPSMatrixSoftMax) EncodeToCommandBufferInputMatrixResultMatrix ¶

func (o *MPSMatrixSoftMax) EncodeToCommandBufferInputMatrixResultMatrix(commandBuffer metal.MTLCommandBuffer, inputMatrix *mpscore.MPSMatrix, resultMatrix *mpscore.MPSMatrix)

@abstract Encode a MPSMatrixSoftMax object to a command buffer. @param commandBuffer A valid MTLCommandBuffer to receive the encoded kernel. @param inputMatrix A valid MPSMatrix object which specifies the input matrix. @param resultMatrix A valid MPSMatrix object which specifies the matrix which will be overwritten by the result. @discussion 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: The result matrix must be large enough to hold a two dimensional array of 'sourceRows' rows and 'sourceColumns' columns beginning at resultMatrixOrigin. Each matrix within the range specified by batchStart and batchSize, which also specifies a valid set of matrices within inputMatrix and resultMatrix, will be processed. The datatypes of the matrices inputMatrix and resultMatrix must match and be either MPSDataTypeFloat32 or MPSDataTypeFloat16.

func (*MPSMatrixSoftMax) InitWithCoderDevice ¶

func (o *MPSMatrixSoftMax) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSMatrixSoftMax

@abstract NSSecureCoding compatability @discussion See @ref MPSKernel#initWithCoder. @param aDecoder The NSCoder subclass with your serialized MPSMatrixSoftMax @param device The MTLDevice on which to make the MPSMatrixSoftMax @return A new MPSMatrixSoftMax object, or nil if failure.

func (*MPSMatrixSoftMax) InitWithDevice ¶

func (o *MPSMatrixSoftMax) InitWithDevice(device metal.MTLDevice) *MPSMatrixSoftMax

@abstract Initialize an MPSMatrixSoftMax object on a device for a given size. @param device The device on which the kernel will execute. @return A valid MPSMatrixSoftMax object or nil, if failure.

func (*MPSMatrixSoftMax) SetSourceColumns ¶

func (o *MPSMatrixSoftMax) SetSourceColumns(sourceColumns uint)

func (*MPSMatrixSoftMax) SetSourceRows ¶

func (o *MPSMatrixSoftMax) SetSourceRows(sourceRows uint)

func (*MPSMatrixSoftMax) SourceColumns ¶

func (o *MPSMatrixSoftMax) SourceColumns() uint

@property sourceColumns @discussion 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 resultMatrix parameter in encodeToCommandBuffer is 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).

func (*MPSMatrixSoftMax) SourceRows ¶

func (o *MPSMatrixSoftMax) SourceRows() uint

@property sourceRows @discussion 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 resultMatrix parameter in encodeToCommandBuffer is 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).

func (*MPSMatrixSoftMaxGradient) EncodeToCommandBufferGradientMatrixForwardOutputMatrixResultMatrix ¶

func (o *MPSMatrixSoftMaxGradient) EncodeToCommandBufferGradientMatrixForwardOutputMatrixResultMatrix(commandBuffer metal.MTLCommandBuffer, gradientMatrix *mpscore.MPSMatrix, forwardOutputMatrix *mpscore.MPSMatrix, resultMatrix *mpscore.MPSMatrix)

@abstract Encode a MPSMatrixSoftMaxGradient object to a command buffer. @param commandBuffer A valid MTLCommandBuffer to receive the encoded kernel. @param gradientMatrix A MPSMatrix object containing gradient values with respect to the forward operation's output. dL_dY in the class description. @param forwardOutputMatrix A MPSMatrix object containing the output values from the forward operation. Y in the class description. @param resultMatrix The MPSMatrix object to hold the resulting gradient values with respect to the forward operation's input. dL_dX in the class description.

func (*MPSMatrixSoftMaxGradient) InitWithCoderDevice ¶

func (o *MPSMatrixSoftMaxGradient) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSMatrixSoftMaxGradient

@abstract NSSecureCoding compatability @discussion See @ref MPSKernel#initWithCoder. @param aDecoder The NSCoder subclass with your serialized MPSMatrixSoftMaxGradient @param device The MTLDevice on which to make the MPSMatrixSoftMaxGradient @return A new MPSMatrixSoftMaxGradient object, or nil if failure.

func (*MPSMatrixSoftMaxGradient) InitWithDevice ¶

func (o *MPSMatrixSoftMaxGradient) InitWithDevice(device metal.MTLDevice) *MPSMatrixSoftMaxGradient

@abstract Initialize an MPSMatrixSoftMaxGradient object on a device. @param device The device on which the kernel will execute. @return A valid MPSMatrixSoftMaxGradient object or nil, if failure.

func (*MPSMatrixSoftMaxGradient) SetSourceColumns ¶

func (o *MPSMatrixSoftMaxGradient) SetSourceColumns(sourceColumns uint)

func (*MPSMatrixSoftMaxGradient) SetSourceRows ¶

func (o *MPSMatrixSoftMaxGradient) SetSourceRows(sourceRows uint)

func (*MPSMatrixSoftMaxGradient) SourceColumns ¶

func (o *MPSMatrixSoftMaxGradient) SourceColumns() uint

@property sourceColumns @discussion The number of columns to consider from the sources 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 matrices available starting from [primary/secondary]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 resultMatrix parameter in encodeToCommandBuffer is large enough to accommodate the results of this operation, otherwise the results of the encode call are undefined. NOTE: primarySourceMatrixOrigin, secondarySourceMatrixOrigin and resultMatrixOrigin from MPSMatrixBinaryKernel can be used to control the starting points in the primary source, secondary source, and result matrices respectively.

func (*MPSMatrixSoftMaxGradient) SourceRows ¶

func (o *MPSMatrixSoftMaxGradient) SourceRows() uint

@property sourceRows @discussion The number of rows to consider from the sources 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 matrices available starting from [primary/secondary]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 resultMatrix parameter in encodeToCommandBuffer is large enough to accommodate the results of this operation, otherwise the results of the encode call are undefined. NOTE: primarySourceMatrixOrigin, secondarySourceMatrixOrigin and resultMatrixOrigin from MPSMatrixBinaryKernel can be used to control the starting points in the primary source, secondary source, and result matrices respectively.

func (*MPSMatrixSolveCholesky) EncodeToCommandBufferSourceMatrixRightHandSideMatrixSolutionMatrix ¶

func (o *MPSMatrixSolveCholesky) EncodeToCommandBufferSourceMatrixRightHandSideMatrixSolutionMatrix(commandBuffer metal.MTLCommandBuffer, sourceMatrix *mpscore.MPSMatrix, rightHandSideMatrix *mpscore.MPSMatrix, solutionMatrix *mpscore.MPSMatrix)

@abstract Encode a MPSMatrixSolveCholesky kernel into a command Buffer. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param sourceMatrix A valid MPSMatrix containing the source matrix in factored form as returned by a previous successful execution of a MPSMatrixDecompositionCholesky kernel. @param rightHandSideMatrix A valid MPSMatrix containing the right hand side values. @param solutionMatrix A valid MPSMatrix to contain the result. @discussion This function encodes the MPSMatrixSolveCholesky object to a valid command buffer. sourceMatrix should contain either the lower or upper triangular factors corresponding to the factorization returned by a previous execution of MPSMatrixDecompositionCholesky. rightHandSideMatrix and solutionMatrix must be large enough to hold a matrix of size order x numberOfRightHandSides starting at secondarySourceMatrixOrigin and resultMatrixOrigin respectively. sourceMatrix must be at least size order x order starting at primarySourceMatrixOrigin.

func (*MPSMatrixSolveCholesky) InitWithDeviceUpperOrderNumberOfRightHandSides ¶

func (o *MPSMatrixSolveCholesky) InitWithDeviceUpperOrderNumberOfRightHandSides(device metal.MTLDevice, upper bool, order uint, numberOfRightHandSides uint) *MPSMatrixSolveCholesky

@abstract Initialize an MPSMatrixSolveCholesky object on a device @param device The device on which the kernel will execute. @param upper A boolean value which indicates if the source matrix stores the lower or upper triangular factors. @param order The order of the source matrix and the number of rows in the solution and right hand side matrices. @param numberOfRightHandSides The number of columns in the solution and right hand side matrices. @return A valid MPSMatrixSolveCholesky object or nil, if failure.

func (*MPSMatrixSolveLU) EncodeToCommandBufferSourceMatrixRightHandSideMatrixPivotIndicesSolutionMatrix ¶

func (o *MPSMatrixSolveLU) EncodeToCommandBufferSourceMatrixRightHandSideMatrixPivotIndicesSolutionMatrix(commandBuffer metal.MTLCommandBuffer, sourceMatrix *mpscore.MPSMatrix, rightHandSideMatrix *mpscore.MPSMatrix, pivotIndices *mpscore.MPSMatrix, solutionMatrix *mpscore.MPSMatrix)

@abstract Encode a MPSMatrixSolveLU kernel into a command Buffer. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param sourceMatrix A valid MPSMatrix containing the source matrix in factored form as returned by a previous successful execution of a MPSMatrixDecompositionLU kernel. @param rightHandSideMatrix A valid MPSMatrix containing the right hand side values. @param pivotIndices A valid MPSMatrix which contains the pivot indices as returned by a previous successful execution of a MPSMatrixDecompositionLU kernel. @param solutionMatrix A valid MPSMatrix to contain the result. @discussion This function encodes the MPSMatrixSolveLU object to a valid command buffer. sourceMatrix should contain the lower and upper triangular factors of A as results from a previous execution of MPSMatrixDecompositionLU. pivotIndices is an array of pivots resulting from a previous execution of MPSMatrixDecompositionLU. rightHandSideMatrix and solutionMatrix must be large enough to hold a matrix of size order x numberOfRightHandSides starting at secondarySourceMatrixOrigin and resultMatrixOrigin respectively. sourceMatrix must be at least size order x order starting at primarySourceMatrixOrigin.

func (*MPSMatrixSolveLU) InitWithDeviceTransposeOrderNumberOfRightHandSides ¶

func (o *MPSMatrixSolveLU) InitWithDeviceTransposeOrderNumberOfRightHandSides(device metal.MTLDevice, transpose bool, order uint, numberOfRightHandSides uint) *MPSMatrixSolveLU

@abstract Initialize an MPSMatrixSolveLU object on a device @param device The device on which the kernel will execute. @param transpose A boolean value which indicates if the source matrix should be used in transposed form. @param order The order of the source matrix and the number of rows in the solution and right hand side matrices. @param numberOfRightHandSides The number of columns in the solution and right hand side matrices. @return A valid MPSMatrixSolveLU object or nil, if failure.

func (*MPSMatrixSolveTriangular) EncodeToCommandBufferSourceMatrixRightHandSideMatrixSolutionMatrix ¶

func (o *MPSMatrixSolveTriangular) EncodeToCommandBufferSourceMatrixRightHandSideMatrixSolutionMatrix(commandBuffer metal.MTLCommandBuffer, sourceMatrix *mpscore.MPSMatrix, rightHandSideMatrix *mpscore.MPSMatrix, solutionMatrix *mpscore.MPSMatrix)

@abstract Encode a MPSMatrixSolveTriangular kernel into a command Buffer. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param sourceMatrix A valid MPSMatrix containing the source matrix. @param rightHandSideMatrix A valid MPSMatrix containing the right hand side values. @param solutionMatrix A valid MPSMatrix to contain the result. @discussion This function encodes the MPSMatrixSolveTriangular object to a valid command buffer. rightHandSideMatrix and solutionMatrix must be large enough to hold at least order * numberOfRightHandSides values starting at secondarySourceMatrixOrigin and resultMatrixOrigin respectively. sourceMatrix must be at least size order x order starting at primarySourceMatrixOrigin.

func (*MPSMatrixSolveTriangular) InitWithDeviceRightUpperTransposeUnitOrderNumberOfRightHandSidesAlpha ¶

func (o *MPSMatrixSolveTriangular) InitWithDeviceRightUpperTransposeUnitOrderNumberOfRightHandSidesAlpha(device metal.MTLDevice, right bool, upper bool, transpose bool, unit bool, order uint, numberOfRightHandSides uint, alpha float64) *MPSMatrixSolveTriangular

@abstract Initialize an MPSMatrixSolveTriangular object on a device @param device The device on which the kernel will execute. @param right A boolean value which indicates if the coefficient matrix is multiplied on the left or right side of the solution. NO indicates the multiplication is on the left. @param upper A boolean value which indicates if the source is lower or upper triangular. NO indicates that the coefficient matrix is lower triangular. @param transpose A boolean value which indicates if the source matrix should be used in transposed form. NO indicates that the coefficient matrix is to be used normally. @param unit A boolean value which indicates if the source matrix is unit triangular. @param order The order of the source matrix and, if right == NO, the number of rows in the solution and right hand side matrices. If right == YES the number of columns in the solution and right hand side matrices. @param numberOfRightHandSides If right == NO, the number of columns in the solution and right hand side matrices. The number of rows otherwise. @param alpha A double precision value used to scale the right hand sides. @discussion This function initializes a MPSMatrixSolveTriangular object. It may allocate device side memory. @return A valid MPSMatrixSolveTriangular object or nil, if failure.

func (*MPSMatrixUnaryKernel) BatchSize ¶

func (o *MPSMatrixUnaryKernel) BatchSize() uint

@property batchSize @discussion The number of matrices in the batch to process. This property is modifiable and by default allows all matrices available at encoding time to be processed. If a single matrix should be processed set this value to 1.

func (*MPSMatrixUnaryKernel) BatchStart ¶

func (o *MPSMatrixUnaryKernel) BatchStart() uint

@property batchStart @discussion The index of the first matrix in the batch. This property is modifiable and defaults to 0 at initialization time. If batch processing should begin at a different matrix this value should be modified prior to encoding the kernel.

func (*MPSMatrixUnaryKernel) ResultMatrixOrigin ¶

func (o *MPSMatrixUnaryKernel) ResultMatrixOrigin() metal.MTLOrigin

@property resultMatrixOrigin @discussion 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. The z value must be 0.

func (*MPSMatrixUnaryKernel) SetBatchSize ¶

func (o *MPSMatrixUnaryKernel) SetBatchSize(batchSize uint)

func (*MPSMatrixUnaryKernel) SetBatchStart ¶

func (o *MPSMatrixUnaryKernel) SetBatchStart(batchStart uint)

func (*MPSMatrixUnaryKernel) SetResultMatrixOrigin ¶

func (o *MPSMatrixUnaryKernel) SetResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin)

func (*MPSMatrixUnaryKernel) SetSourceMatrixOrigin ¶

func (o *MPSMatrixUnaryKernel) SetSourceMatrixOrigin(sourceMatrixOrigin metal.MTLOrigin)

func (*MPSMatrixUnaryKernel) SourceMatrixOrigin ¶

func (o *MPSMatrixUnaryKernel) SourceMatrixOrigin() metal.MTLOrigin

@property sourceMatrixOrigin @discussion The origin, relative to [0, 0] in the source matrix, at which to start reading values. 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. The z value must be 0.

func (*MPSMatrixVectorMultiplication) EncodeToCommandBufferInputMatrixInputVectorResultVector ¶

func (o *MPSMatrixVectorMultiplication) EncodeToCommandBufferInputMatrixInputVectorResultVector(commandBuffer metal.MTLCommandBuffer, inputMatrix *mpscore.MPSMatrix, inputVector *mpscore.MPSVector, resultVector *mpscore.MPSVector)

@abstract Encode a MPSMatrixVectorMultiplication object to a command buffer. @param commandBuffer A valid MTLCommandBuffer to receive the encoded kernel. @param inputMatrix A valid MPSMatrix object which specifies the input matrix A. @param inputVector A valid MPSVector object which specifies the input vector x. @param resultVector A valid MPSVector object which specifies the addend vector which will also be overwritten by the result. @discussion The left input matrix must be large enough to hold an array of size (rows x columns) elements beginning at primarySourceMatrixOrigin. The input vector must be large enough to hold an array of size (columns) elements beginning at secondarySourceMatrixOrigin.x secondarySourceMatrixOrigin.y and secondarySourceMatrixOrigin.z must be zero. The result vector must be large enough to hold an array of size (rows) elements beginning at resultMatrixOrigin.x. resultMatrixOrigin.y and resultMatrixOrigin.z must be zero.

func (*MPSMatrixVectorMultiplication) InitWithDeviceRowsColumns ¶

func (o *MPSMatrixVectorMultiplication) InitWithDeviceRowsColumns(device metal.MTLDevice, rows uint, columns uint) *MPSMatrixVectorMultiplication

@abstract Convenience initialization for a matrix-vector multiplication with no transposition, unit scaling of the product, and no accumulation of the result. The scaling factors alpha and beta are taken to be 1.0 and 0.0 respectively. @param device The device on which the kernel will execute. @param rows The number of rows in the input matrix A, and the number of elements in the vector y. @param columns The number of columns in the input matrix A, and the number of elements in the input vector x. @return A valid MPSMatrixVectorMultiplication object or nil, if failure.

func (*MPSMatrixVectorMultiplication) InitWithDeviceTransposeRowsColumnsAlphaBeta ¶

func (o *MPSMatrixVectorMultiplication) InitWithDeviceTransposeRowsColumnsAlphaBeta(device metal.MTLDevice, transpose bool, rows uint, columns uint, alpha float64, beta float64) *MPSMatrixVectorMultiplication

@abstract Initialize an MPSMatrixVectorMultiplication object on a device for a given size and desired transpose and scale values. @param device The device on which the kernel will execute. @param transpose A boolean value which indicates if the input matrix should be used in transposed form. if 'YES' then op(A) == A**T, otherwise op(A) == A. @param rows The number of rows in the input matrix op(A), and the number of elements in the vector y. @param columns The number of columns in the input matrix op(A), and the number of elements in the input vector x. @param 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. @param beta The scale factor to apply to the initial values of y. Specified in double precision. Will be converted to the appropriate precision in the implementation subject to rounding and/or clamping as necessary. @return A valid MPSMatrixVectorMultiplication object or nil, if failure.

func (Mach_vm_range_flags_t) String ¶

func (e Mach_vm_range_flags_t) String() string

func (Mach_vm_range_flavor_t) String ¶

func (e Mach_vm_range_flavor_t) String() string

func (Mach_vm_range_tag_t) String ¶

func (e Mach_vm_range_tag_t) String() string

func (Mpo_flags_t) String ¶

func (e Mpo_flags_t) String() string

func (Os_clockid_t) String ¶

func (e Os_clockid_t) String() string

func (Ptrauth_key) String ¶

func (e Ptrauth_key) String() string

func (Qos_class_t) String ¶

func (e Qos_class_t) String() string

func (Virtual_memory_guard_exception_code_t) String ¶

func (e Virtual_memory_guard_exception_code_t) String() string

func (Xpc_listener_create_flags_t) String ¶

func (e Xpc_listener_create_flags_t) String() string

func (Xpc_session_create_flags_t) String ¶

func (e Xpc_session_create_flags_t) String() string