mpsmatrix

package
v0.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 11, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Rendered for darwin/amd64

Overview

Package mpsmatrix provides a fluent Go API over the macOS MPSMatrix framework.

Construction

New… functions create objects; each With… method sets one property and returns its receiver, so configuration calls chain. A <Type>FromID constructor adopts an Objective-C object obtained elsewhere.

Lifecycle

A wrapper releases its Objective-C object automatically once the garbage collector finds it unreachable. Call Release to relinquish the reference deterministically (for objects holding scarce resources); Release is idempotent, and afterwards the wrapper's methods are no-ops returning zero values.

Types

Each base type below lists the concrete types you construct and pass where the base is accepted:

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Clockid added in v0.17.0 

type Clockid int32
const (
	ClockidRealtime           Clockid = 0
	ClockidMonotonic          Clockid = 6
	ClockidMonotonicRaw       Clockid = 4
	ClockidMonotonicRawApprox Clockid = 5
	ClockidUptimeRaw          Clockid = 8
	ClockidUptimeRawApprox    Clockid = 9
	ClockidProcessCputimeID   Clockid = 12
	ClockidThreadCputimeID    Clockid = 16
)

func (Clockid) String added in v0.17.0 

func (e Clockid) String() string

String returns the Clockid constant's name, or its numeric form when the value is not a known constant.

type CustomKernelIndex added in v0.17.0 

type CustomKernelIndex int32
const (
	CustomKernelIndexDestIndex     CustomKernelIndex = 0
	CustomKernelIndexSrc0Index     CustomKernelIndex = 0
	CustomKernelIndexSrc1Index     CustomKernelIndex = 1
	CustomKernelIndexSrc2Index     CustomKernelIndex = 2
	CustomKernelIndexSrc3Index     CustomKernelIndex = 3
	CustomKernelIndexSrc4Index     CustomKernelIndex = 4
	CustomKernelIndexUserDataIndex CustomKernelIndex = 30
)

func (CustomKernelIndex) String added in v0.17.0 

func (e CustomKernelIndex) String() string

String returns the CustomKernelIndex constant's name, or its numeric form when the value is not a known constant.

type DeviceCapsValues added in v0.17.0 

type DeviceCapsValues uint32
const (
	DeviceCapsNull                        DeviceCapsValues = 0
	DeviceSupportsReadableArrayOfTextures DeviceCapsValues = 1
	DeviceSupportsWritableArrayOfTextures DeviceCapsValues = 2
	DeviceSupportsReadWriteTextures       DeviceCapsValues = 4
	DeviceSupportsSimdgroupBarrier        DeviceCapsValues = 8
	DeviceSupportsQuadShuffle             DeviceCapsValues = 16
	DeviceSupportsSimdShuffle             DeviceCapsValues = 32
	DeviceSupportsSimdReduction           DeviceCapsValues = 64
	DeviceSupportsFloat32Filtering        DeviceCapsValues = 128
	DeviceSupportsNorm16BicubicFiltering  DeviceCapsValues = 256
	DeviceSupportsFloat16BicubicFiltering DeviceCapsValues = 512
	DeviceIsAppleDevice                   DeviceCapsValues = 1024
	DeviceSupportsSimdShuffleAndFill      DeviceCapsValues = 2048
	DeviceSupportsBFloat16Arithmetic      DeviceCapsValues = 4096
	DeviceCapsLast                        DeviceCapsValues = 8192
)

func (DeviceCapsValues) String added in v0.17.0 

func (e DeviceCapsValues) String() string

String returns the DeviceCapsValues constant's name, or its numeric form when the value is not a known constant.

type DispatchAutoreleaseFrequency added in v0.17.0 

type DispatchAutoreleaseFrequency uint64
const (
	DispatchAutoreleaseFrequencyInherit  DispatchAutoreleaseFrequency = 0
	DispatchAutoreleaseFrequencyWorkItem DispatchAutoreleaseFrequency = 1
	DispatchAutoreleaseFrequencyNever    DispatchAutoreleaseFrequency = 2
)

func (DispatchAutoreleaseFrequency) String added in v0.17.0 

func (e DispatchAutoreleaseFrequency) String() string

String returns the DispatchAutoreleaseFrequency constant's name, or its numeric form when the value is not a known constant.

type DispatchBlockFlags added in v0.17.0 

type DispatchBlockFlags uint64

Bitmask — values may be combined with |. 

const (
	DispatchBlockFlagsBarrier         DispatchBlockFlags = 1
	DispatchBlockFlagsDetached        DispatchBlockFlags = 2
	DispatchBlockFlagsAssignCurrent   DispatchBlockFlags = 4
	DispatchBlockFlagsNoQosClass      DispatchBlockFlags = 8
	DispatchBlockFlagsInheritQosClass DispatchBlockFlags = 16
	DispatchBlockFlagsEnforceQosClass DispatchBlockFlags = 32
)

func (DispatchBlockFlags) String added in v0.17.0 

func (e DispatchBlockFlags) String() string

String returns the DispatchBlockFlags constant's name, or its numeric form when the value is not a known constant.

type EntryID added in v0.17.0 

type EntryID int32
const (
	EntryIDFirstEntry EntryID = 0
	EntryIDNextEntry  EntryID = -1
	EntryIDLastEntry  EntryID = -2
)

func (EntryID) String added in v0.17.0 

func (e EntryID) String() string

String returns the EntryID constant's name, or its numeric form when the value is not a known constant.

type FilesecProperty added in v0.17.0 

type FilesecProperty int32
const (
	FilesecPropertyOwner        FilesecProperty = 1
	FilesecPropertyGroup        FilesecProperty = 2
	FilesecPropertyUUID         FilesecProperty = 3
	FilesecPropertyMode         FilesecProperty = 4
	FilesecPropertyACL          FilesecProperty = 5
	FilesecPropertyGrpuuid      FilesecProperty = 6
	FilesecPropertyACLRaw       FilesecProperty = 100
	FilesecPropertyACLAllocsize FilesecProperty = 101
)

func (FilesecProperty) String added in v0.17.0 

func (e FilesecProperty) String() string

String returns the FilesecProperty constant's name, or its numeric form when the value is not a known constant.

type Flag added in v0.17.0 

type Flag int32
const (
	FlagFlagDeferInherit      Flag = 1
	FlagFlagNoInherit         Flag = 131072
	FlagEntryInherited        Flag = 16
	FlagEntryFileInherit      Flag = 32
	FlagEntryDirectoryInherit Flag = 64
	FlagEntryLimitInherit     Flag = 128
	FlagEntryOnlyInherit      Flag = 256
)

func (Flag) String added in v0.17.0 

func (e Flag) String() string

String returns the Flag constant's name, or its numeric form when the value is not a known constant.

type Idtype added in v0.17.0 

type Idtype int32
const (
	IdtypeAll  Idtype = 0
	IdtypePid  Idtype = 1
	IdtypePgid Idtype = 2
)

func (Idtype) String added in v0.17.0 

func (e Idtype) String() string

String returns the Idtype constant's name, or its numeric form when the value is not a known constant.

type ImageType added in v0.17.0 

type ImageType uint32
const (
	ImageType2d                    ImageType = 0
	ImageType2d_array              ImageType = 1
	ImageTypeArray2d               ImageType = 2
	ImageTypeArray2d_array         ImageType = 3
	ImageType_ArrayMask            ImageType = 1
	ImageType_BatchMask            ImageType = 2
	ImageType_typeMask             ImageType = 3
	ImageType_noAlpha              ImageType = 4
	ImageType_texelFormatMask      ImageType = 56
	ImageType_texelFormatShift     ImageType = 3
	ImageType_texelFormatStandard  ImageType = 0
	ImageType_texelFormatUnorm8    ImageType = 8
	ImageType_texelFormatFloat16   ImageType = 16
	ImageType_texelFormatBFloat16  ImageType = 24
	ImageType_bitCount             ImageType = 6
	ImageType_mask                 ImageType = 63
	ImageType2d_noAlpha            ImageType = 4
	ImageType2d_array_noAlpha      ImageType = 5
	ImageTypeArray2d_noAlpha       ImageType = 6
	ImageTypeArray2d_array_noAlpha ImageType = 7
)

func (ImageType) String added in v0.17.0 

func (e ImageType) String() string

String returns the ImageType constant's name, or its numeric form when the value is not a known constant.

type IpcInfoObjectType added in v0.17.0 

type IpcInfoObjectType uint32
const (
	IpcInfoObjectTypeNone               IpcInfoObjectType = 0
	IpcInfoObjectTypeThreadControl      IpcInfoObjectType = 1
	IpcInfoObjectTypeTaskControl        IpcInfoObjectType = 2
	IpcInfoObjectTypeHost               IpcInfoObjectType = 3
	IpcInfoObjectTypeHostPriv           IpcInfoObjectType = 4
	IpcInfoObjectTypeProcessor          IpcInfoObjectType = 5
	IpcInfoObjectTypeProcessorSet       IpcInfoObjectType = 6
	IpcInfoObjectTypeProcessorSetName   IpcInfoObjectType = 7
	IpcInfoObjectTypeTimer              IpcInfoObjectType = 8
	IpcInfoObjectTypePortSubstOnce      IpcInfoObjectType = 9
	IpcInfoObjectTypeMig                IpcInfoObjectType = 10
	IpcInfoObjectTypeMemoryObject       IpcInfoObjectType = 11
	IpcInfoObjectTypeXmmPager           IpcInfoObjectType = 12
	IpcInfoObjectTypeXmmKernel          IpcInfoObjectType = 13
	IpcInfoObjectTypeXmmReply           IpcInfoObjectType = 14
	IpcInfoObjectTypeUndReply           IpcInfoObjectType = 15
	IpcInfoObjectTypeHostNotify         IpcInfoObjectType = 16
	IpcInfoObjectTypeHostSecurity       IpcInfoObjectType = 17
	IpcInfoObjectTypeLedger             IpcInfoObjectType = 18
	IpcInfoObjectTypeMainDevice         IpcInfoObjectType = 19
	IpcInfoObjectTypeTaskName           IpcInfoObjectType = 20
	IpcInfoObjectTypeSubsystem          IpcInfoObjectType = 21
	IpcInfoObjectTypeIODoneQueue        IpcInfoObjectType = 22
	IpcInfoObjectTypeSemaphore          IpcInfoObjectType = 23
	IpcInfoObjectTypeLockSet            IpcInfoObjectType = 24
	IpcInfoObjectTypeClock              IpcInfoObjectType = 25
	IpcInfoObjectTypeClockCtrl          IpcInfoObjectType = 26
	IpcInfoObjectTypeIokitIdent         IpcInfoObjectType = 27
	IpcInfoObjectTypeNamedEntry         IpcInfoObjectType = 28
	IpcInfoObjectTypeIokitConnect       IpcInfoObjectType = 29
	IpcInfoObjectTypeIokitObject        IpcInfoObjectType = 30
	IpcInfoObjectTypeUpl                IpcInfoObjectType = 31
	IpcInfoObjectTypeMemObjControl      IpcInfoObjectType = 32
	IpcInfoObjectTypeAuSessionport      IpcInfoObjectType = 33
	IpcInfoObjectTypeFileport           IpcInfoObjectType = 34
	IpcInfoObjectTypeLabelh             IpcInfoObjectType = 35
	IpcInfoObjectTypeTaskResume         IpcInfoObjectType = 36
	IpcInfoObjectTypeVoucher            IpcInfoObjectType = 37
	IpcInfoObjectTypeVoucherAttrControl IpcInfoObjectType = 38
	IpcInfoObjectTypeWorkInterval       IpcInfoObjectType = 39
	IpcInfoObjectTypeUxHandler          IpcInfoObjectType = 40
	IpcInfoObjectTypeUextObject         IpcInfoObjectType = 41
	IpcInfoObjectTypeArcadeReg          IpcInfoObjectType = 42
	IpcInfoObjectTypeEventlink          IpcInfoObjectType = 43
	IpcInfoObjectTypeTaskInspect        IpcInfoObjectType = 44
	IpcInfoObjectTypeTaskRead           IpcInfoObjectType = 45
	IpcInfoObjectTypeThreadInspect      IpcInfoObjectType = 46
	IpcInfoObjectTypeThreadRead         IpcInfoObjectType = 47
	IpcInfoObjectTypeSuidCred           IpcInfoObjectType = 48
	IpcInfoObjectTypeHypervisor         IpcInfoObjectType = 49
	IpcInfoObjectTypeTaskIDToken        IpcInfoObjectType = 50
	IpcInfoObjectTypeTaskFatal          IpcInfoObjectType = 51
	IpcInfoObjectTypeKcdata             IpcInfoObjectType = 52
	IpcInfoObjectTypeExclavesResource   IpcInfoObjectType = 53
	IpcInfoObjectTypeThreadResume       IpcInfoObjectType = 54
	IpcInfoObjectTypeUnknown            IpcInfoObjectType = 4294967295
)

func (IpcInfoObjectType) String added in v0.17.0 

func (e IpcInfoObjectType) String() string

String returns the IpcInfoObjectType constant's name, or its numeric form when the value is not a known constant.

type LaunchDataType added in v0.17.0 

type LaunchDataType int32
const (
	LaunchDataTypeDictionary LaunchDataType = 1
	LaunchDataTypeArray      LaunchDataType = 2
	LaunchDataTypeFd         LaunchDataType = 3
	LaunchDataTypeInteger    LaunchDataType = 4
	LaunchDataTypeReal       LaunchDataType = 5
	LaunchDataTypeBool       LaunchDataType = 6
	LaunchDataTypeString     LaunchDataType = 7
	LaunchDataTypeOpaque     LaunchDataType = 8
	LaunchDataTypeErrno      LaunchDataType = 9
	LaunchDataTypeMachport   LaunchDataType = 10
)

func (LaunchDataType) String added in v0.17.0 

func (e LaunchDataType) String() string

String returns the LaunchDataType constant's name, or its numeric form when the value is not a known constant.

type MDLabelDomain 

type MDLabelDomain int32

These constants are used to specify a domain to MDLabelCreate(). 

const (
	KMDLabelUserDomain  MDLabelDomain = 0
	KMDLabelLocalDomain MDLabelDomain = 1
)

func (MDLabelDomain) String 

func (e MDLabelDomain) String() string

String returns the MDLabelDomain constant's name, or its numeric form when the value is not a known constant.

type MDQueryOptionFlags 

type MDQueryOptionFlags int32
const (
	KMDQuerySynchronous        MDQueryOptionFlags = 1
	KMDQueryWantsUpdates       MDQueryOptionFlags = 4
	KMDQueryAllowFSTranslation MDQueryOptionFlags = 8
)

func (MDQueryOptionFlags) String 

func (e MDQueryOptionFlags) String() string

String returns the MDQueryOptionFlags constant's name, or its numeric form when the value is not a known constant.

type MDQuerySortOptionFlags 

type MDQuerySortOptionFlags int32
const (
	KMDQueryReverseSortOrderFlag MDQuerySortOptionFlags = 1
)

func (MDQuerySortOptionFlags) String 

func (e MDQuerySortOptionFlags) String() string

String returns the MDQuerySortOptionFlags constant's name, or its numeric form when the value is not a known constant.

type MPSMatrixCopyOffsets 

type MPSMatrixCopyOffsets struct {
	SourceRowOffset         uint32
	SourceColumnOffset      uint32
	DestinationRowOffset    uint32
	DestinationColumnOffset uint32
}

type MachVMRangeFlags added in v0.17.0 

type MachVMRangeFlags uint64

Bitmask — values may be combined with |. 

const (
	MachVMRangeFlagsNone MachVMRangeFlags = 0
)

func (MachVMRangeFlags) String added in v0.17.0 

func (e MachVMRangeFlags) String() string

String returns the MachVMRangeFlags constant's name, or its numeric form when the value is not a known constant.

type MachVMRangeFlavor added in v0.17.0 

type MachVMRangeFlavor uint32
const (
	MachVMRangeFlavorInvalid MachVMRangeFlavor = 0
	MachVMRangeFlavorV1      MachVMRangeFlavor = 1
)

func (MachVMRangeFlavor) String added in v0.17.0 

func (e MachVMRangeFlavor) String() string

String returns the MachVMRangeFlavor constant's name, or its numeric form when the value is not a known constant.

type MachVMRangeTag added in v0.17.0 

type MachVMRangeTag uint16
const (
	MachVMRangeTagDefault MachVMRangeTag = 0
	MachVMRangeTagData    MachVMRangeTag = 1
	MachVMRangeTagFixed   MachVMRangeTag = 2
)

func (MachVMRangeTag) String added in v0.17.0 

func (e MachVMRangeTag) String() string

String returns the MachVMRangeTag constant's name, or its numeric form when the value is not a known constant.

type MatrixBinaryKernel added in v0.17.0 

type MatrixBinaryKernel struct {
	objref.Handle
}

MatrixBinaryKernel is an idiomatic wrapper over the Objective-C class MPSMatrixBinaryKernel.

MatrixBinaryKernel is an abstract base — you do not construct it directly. Construct one of MatrixSoftMaxGradient, MatrixSolveCholesky, MatrixSolveLU, MatrixSolveTriangular, MatrixVectorMultiplication and pass it where a MatrixBinaryKernel is accepted.

func MatrixBinaryKernelFromID added in v0.17.0 

func MatrixBinaryKernelFromID(id objc.ID) *MatrixBinaryKernel

MatrixBinaryKernelFromID adopts an existing Objective-C object as a MatrixBinaryKernel (nil for 0), retaining it and registering a release finalizer.

func (*MatrixBinaryKernel) BatchSize added in v0.17.0 

func (mbk *MatrixBinaryKernel) BatchSize() int

BatchSize returns 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 (*MatrixBinaryKernel) BatchStart added in v0.17.0 

func (mbk *MatrixBinaryKernel) BatchStart() int

BatchStart returns 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 (*MatrixBinaryKernel) Description added in v0.17.0 

func (mbk *MatrixBinaryKernel) Description() string

Description returns the object's -description text.

func (*MatrixBinaryKernel) IsEqual added in v0.17.0 

func (mbk *MatrixBinaryKernel) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*MatrixBinaryKernel) IsKind added in v0.17.0 

func (mbk *MatrixBinaryKernel) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*MatrixBinaryKernel) PrimarySourceMatrixOrigin added in v0.17.0 

func (mbk *MatrixBinaryKernel) PrimarySourceMatrixOrigin() metal.MTLOrigin

PrimarySourceMatrixOrigin returns 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 (*MatrixBinaryKernel) ResultMatrixOrigin added in v0.17.0 

func (mbk *MatrixBinaryKernel) ResultMatrixOrigin() metal.MTLOrigin

ResultMatrixOrigin returns 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 (*MatrixBinaryKernel) SecondarySourceMatrixOrigin added in v0.17.0 

func (mbk *MatrixBinaryKernel) SecondarySourceMatrixOrigin() metal.MTLOrigin

SecondarySourceMatrixOrigin returns 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 (*MatrixBinaryKernel) String added in v0.17.0 

func (mbk *MatrixBinaryKernel) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*MatrixBinaryKernel) WithBatchSize added in v0.17.0 

func (mbk *MatrixBinaryKernel) WithBatchSize(batchSize int) *MatrixBinaryKernel

WithBatchSize sets 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 (*MatrixBinaryKernel) WithBatchStart added in v0.17.0 

func (mbk *MatrixBinaryKernel) WithBatchStart(batchStart int) *MatrixBinaryKernel

WithBatchStart sets 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 (*MatrixBinaryKernel) WithPrimarySourceMatrixOrigin added in v0.17.0 

func (mbk *MatrixBinaryKernel) WithPrimarySourceMatrixOrigin(primarySourceMatrixOrigin metal.MTLOrigin) *MatrixBinaryKernel

WithPrimarySourceMatrixOrigin sets 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 (*MatrixBinaryKernel) WithResultMatrixOrigin added in v0.17.0 

func (mbk *MatrixBinaryKernel) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixBinaryKernel

WithResultMatrixOrigin sets 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 (*MatrixBinaryKernel) WithSecondarySourceMatrixOrigin added in v0.17.0 

func (mbk *MatrixBinaryKernel) WithSecondarySourceMatrixOrigin(secondarySourceMatrixOrigin metal.MTLOrigin) *MatrixBinaryKernel

WithSecondarySourceMatrixOrigin sets 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.

type MatrixBinaryKernelProvider added in v0.17.0 

type MatrixBinaryKernelProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

MatrixBinaryKernelProvider is accepted wherever a MPSMatrixBinaryKernel (or one of its subclasses) is expected.

type MatrixCopy added in v0.17.0 

type MatrixCopy struct {
	objref.Handle
}

MatrixCopy is an idiomatic wrapper over the Objective-C class MPSMatrixCopy.

func MatrixCopyFromID added in v0.17.0 

func MatrixCopyFromID(id objc.ID) *MatrixCopy

MatrixCopyFromID adopts an existing Objective-C object as a MatrixCopy (nil for 0), retaining it and registering a release finalizer.

func NewMatrixCopy added in v0.17.0 

func NewMatrixCopy() *MatrixCopy

NewMatrixCopy creates a new MatrixCopy.

func (*MatrixCopy) CopyColumns added in v0.17.0 

func (mc *MatrixCopy) CopyColumns() int

CopyColumns returns the number of columns to copy for each copy operation

func (*MatrixCopy) CopyRows added in v0.17.0 

func (mc *MatrixCopy) CopyRows() int

CopyRows returns the number of rows to copy for each copy operation

func (*MatrixCopy) Description added in v0.17.0 

func (mc *MatrixCopy) Description() string

Description returns the object's -description text.

func (*MatrixCopy) DestinationsAreTransposed added in v0.17.0 

func (mc *MatrixCopy) DestinationsAreTransposed() bool

DestinationsAreTransposed reports whether if true, the destinations are in row major storage order

func (*MatrixCopy) IsEqual added in v0.17.0 

func (mc *MatrixCopy) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*MatrixCopy) IsKind added in v0.17.0 

func (mc *MatrixCopy) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*MatrixCopy) SourcesAreTransposed added in v0.17.0 

func (mc *MatrixCopy) SourcesAreTransposed() bool

SourcesAreTransposed reports whether if true, the sources are in row major storage order

func (*MatrixCopy) String added in v0.17.0 

func (mc *MatrixCopy) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type MatrixCopyDescriptor added in v0.17.0 

type MatrixCopyDescriptor struct {
	objref.Handle
}

MatrixCopyDescriptor is an idiomatic wrapper over the Objective-C class MPSMatrixCopyDescriptor.

func DescriptorWithSourceMatrixDestinationMatrixOffsets added in v0.18.1 

func DescriptorWithSourceMatrixDestinationMatrixOffsets(sourceMatrix obj.Object, destinationMatrix obj.Object, offsets MPSMatrixCopyOffsets) *MatrixCopyDescriptor

DescriptorWithSourceMatrixDestinationMatrixOffsets convenience allocator for single copies

func MatrixCopyDescriptorFromID added in v0.17.0 

func MatrixCopyDescriptorFromID(id objc.ID) *MatrixCopyDescriptor

MatrixCopyDescriptorFromID adopts an existing Objective-C object as a MatrixCopyDescriptor (nil for 0), retaining it and registering a release finalizer.

func NewMatrixCopyDescriptorWithSourceMatricesDestinationMatricesOffsetVectorOffset added in v0.17.0 

func NewMatrixCopyDescriptorWithSourceMatricesDestinationMatricesOffsetVectorOffset(sourceMatrices []obj.Object, destinationMatrices []obj.Object, offsets obj.Object, byteOffset int) *MatrixCopyDescriptor

NewMatrixCopyDescriptorWithSourceMatricesDestinationMatricesOffsetVectorOffset initialize a MPSMatrixCopyDescriptor using offsets generated on the GPU Use this method when the offsets needed are coming from GPU based computation.

func (*MatrixCopyDescriptor) Description added in v0.17.0 

func (mcd *MatrixCopyDescriptor) Description() string

Description returns the object's -description text.

func (*MatrixCopyDescriptor) IsEqual added in v0.17.0 

func (mcd *MatrixCopyDescriptor) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*MatrixCopyDescriptor) IsKind added in v0.17.0 

func (mcd *MatrixCopyDescriptor) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*MatrixCopyDescriptor) SetCopyOperationAtIndexSourceMatrixDestinationMatrixOffsets added in v0.18.1 

func (mcd *MatrixCopyDescriptor) SetCopyOperationAtIndexSourceMatrixDestinationMatrixOffsets(index int, sourceMatrix obj.Object, destinationMatrix obj.Object, offsets MPSMatrixCopyOffsets)

SetCopyOperationAtIndexSourceMatrixDestinationMatrixOffsets initialize a MPSMatrixCopyDescriptor using offsets generated on the CPU This is for one at a time intialization of the copy operations

func (*MatrixCopyDescriptor) String added in v0.17.0 

func (mcd *MatrixCopyDescriptor) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type MatrixDecompositionCholesky added in v0.17.0 

type MatrixDecompositionCholesky struct {
	MatrixUnaryKernel
}

MatrixDecompositionCholesky is an idiomatic wrapper over the Objective-C class MPSMatrixDecompositionCholesky.

It embeds MatrixUnaryKernel, promoting that type's methods.

func MatrixDecompositionCholeskyFromID added in v0.17.0 

func MatrixDecompositionCholeskyFromID(id objc.ID) *MatrixDecompositionCholesky

MatrixDecompositionCholeskyFromID adopts an existing Objective-C object as a MatrixDecompositionCholesky (nil for 0), retaining it and registering a release finalizer.

func NewMatrixDecompositionCholesky added in v0.17.0 

func NewMatrixDecompositionCholesky() *MatrixDecompositionCholesky

NewMatrixDecompositionCholesky creates a new MatrixDecompositionCholesky.

func (*MatrixDecompositionCholesky) WithBatchSize added in v0.17.0 

func (mdc *MatrixDecompositionCholesky) WithBatchSize(batchSize int) *MatrixDecompositionCholesky

WithBatchSize sets 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 (*MatrixDecompositionCholesky) WithBatchStart added in v0.17.0 

func (mdc *MatrixDecompositionCholesky) WithBatchStart(batchStart int) *MatrixDecompositionCholesky

WithBatchStart sets 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 (*MatrixDecompositionCholesky) WithResultMatrixOrigin added in v0.17.0 

func (mdc *MatrixDecompositionCholesky) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixDecompositionCholesky

WithResultMatrixOrigin sets 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 (*MatrixDecompositionCholesky) WithSourceMatrixOrigin added in v0.17.0 

func (mdc *MatrixDecompositionCholesky) WithSourceMatrixOrigin(sourceMatrixOrigin metal.MTLOrigin) *MatrixDecompositionCholesky

WithSourceMatrixOrigin sets 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.

type MatrixDecompositionLU added in v0.17.0 

type MatrixDecompositionLU struct {
	MatrixUnaryKernel
}

MatrixDecompositionLU is an idiomatic wrapper over the Objective-C class MPSMatrixDecompositionLU.

It embeds MatrixUnaryKernel, promoting that type's methods.

func MatrixDecompositionLUFromID added in v0.17.0 

func MatrixDecompositionLUFromID(id objc.ID) *MatrixDecompositionLU

MatrixDecompositionLUFromID adopts an existing Objective-C object as a MatrixDecompositionLU (nil for 0), retaining it and registering a release finalizer.

func NewMatrixDecompositionLU added in v0.17.0 

func NewMatrixDecompositionLU() *MatrixDecompositionLU

NewMatrixDecompositionLU creates a new MatrixDecompositionLU.

func (*MatrixDecompositionLU) WithBatchSize added in v0.17.0 

func (mdl *MatrixDecompositionLU) WithBatchSize(batchSize int) *MatrixDecompositionLU

WithBatchSize sets 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 (*MatrixDecompositionLU) WithBatchStart added in v0.17.0 

func (mdl *MatrixDecompositionLU) WithBatchStart(batchStart int) *MatrixDecompositionLU

WithBatchStart sets 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 (*MatrixDecompositionLU) WithResultMatrixOrigin added in v0.17.0 

func (mdl *MatrixDecompositionLU) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixDecompositionLU

WithResultMatrixOrigin sets 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 (*MatrixDecompositionLU) WithSourceMatrixOrigin added in v0.17.0 

func (mdl *MatrixDecompositionLU) WithSourceMatrixOrigin(sourceMatrixOrigin metal.MTLOrigin) *MatrixDecompositionLU

WithSourceMatrixOrigin sets 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.

type MatrixDecompositionStatus added in v0.17.0 

type MatrixDecompositionStatus int32
const (
	MatrixDecompositionStatusSuccess             MatrixDecompositionStatus = 0
	MatrixDecompositionStatusFailure             MatrixDecompositionStatus = -1
	MatrixDecompositionStatusSingular            MatrixDecompositionStatus = -2
	MatrixDecompositionStatusNonPositiveDefinite MatrixDecompositionStatus = -3
)

func (MatrixDecompositionStatus) String added in v0.17.0 

func (e MatrixDecompositionStatus) String() string

String returns the MatrixDecompositionStatus constant's name, or its numeric form when the value is not a known constant.

type MatrixFindTopK added in v0.17.0 

type MatrixFindTopK struct {
	MatrixUnaryKernel
}

MatrixFindTopK is an idiomatic wrapper over the Objective-C class MPSMatrixFindTopK.

It embeds MatrixUnaryKernel, promoting that type's methods.

func MatrixFindTopKFromID added in v0.17.0 

func MatrixFindTopKFromID(id objc.ID) *MatrixFindTopK

MatrixFindTopKFromID adopts an existing Objective-C object as a MatrixFindTopK (nil for 0), retaining it and registering a release finalizer.

func NewMatrixFindTopK added in v0.17.0 

func NewMatrixFindTopK() *MatrixFindTopK

NewMatrixFindTopK creates a new MatrixFindTopK.

func (*MatrixFindTopK) IndexOffset added in v0.17.0 

func (mftk *MatrixFindTopK) IndexOffset() int

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

func (*MatrixFindTopK) NumberOfTopKValues added in v0.17.0 

func (mftk *MatrixFindTopK) NumberOfTopKValues() int

NumberOfTopKValues returns 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 (*MatrixFindTopK) SourceColumns added in v0.17.0 

func (mftk *MatrixFindTopK) SourceColumns() int

SourceColumns returns 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 (*MatrixFindTopK) SourceRows added in v0.17.0 

func (mftk *MatrixFindTopK) SourceRows() int

SourceRows returns 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 (*MatrixFindTopK) WithBatchSize added in v0.17.0 

func (mftk *MatrixFindTopK) WithBatchSize(batchSize int) *MatrixFindTopK

WithBatchSize sets 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 (*MatrixFindTopK) WithBatchStart added in v0.17.0 

func (mftk *MatrixFindTopK) WithBatchStart(batchStart int) *MatrixFindTopK

WithBatchStart sets 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 (*MatrixFindTopK) WithIndexOffset added in v0.17.0 

func (mftk *MatrixFindTopK) WithIndexOffset(indexOffset int) *MatrixFindTopK

WithIndexOffset sets 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 (*MatrixFindTopK) WithNumberOfTopKValues added in v0.17.0 

func (mftk *MatrixFindTopK) WithNumberOfTopKValues(numberOfTopKValues int) *MatrixFindTopK

WithNumberOfTopKValues sets 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 (*MatrixFindTopK) WithResultMatrixOrigin added in v0.17.0 

func (mftk *MatrixFindTopK) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixFindTopK

WithResultMatrixOrigin sets 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 (*MatrixFindTopK) WithSourceColumns added in v0.17.0 

func (mftk *MatrixFindTopK) WithSourceColumns(sourceColumns int) *MatrixFindTopK

WithSourceColumns sets 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 (*MatrixFindTopK) WithSourceMatrixOrigin added in v0.17.0 

func (mftk *MatrixFindTopK) WithSourceMatrixOrigin(sourceMatrixOrigin metal.MTLOrigin) *MatrixFindTopK

WithSourceMatrixOrigin sets 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 (*MatrixFindTopK) WithSourceRows added in v0.17.0 

func (mftk *MatrixFindTopK) WithSourceRows(sourceRows int) *MatrixFindTopK

WithSourceRows sets 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).

type MatrixLogSoftMax added in v0.17.0 

type MatrixLogSoftMax struct {
	MatrixSoftMax
}

MatrixLogSoftMax is an idiomatic wrapper over the Objective-C class MPSMatrixLogSoftMax.

It embeds MatrixSoftMax, promoting that type's methods.

func MatrixLogSoftMaxFromID added in v0.17.0 

func MatrixLogSoftMaxFromID(id objc.ID) *MatrixLogSoftMax

MatrixLogSoftMaxFromID adopts an existing Objective-C object as a MatrixLogSoftMax (nil for 0), retaining it and registering a release finalizer.

func NewMatrixLogSoftMax added in v0.17.0 

func NewMatrixLogSoftMax() *MatrixLogSoftMax

NewMatrixLogSoftMax creates a new MatrixLogSoftMax.

func (*MatrixLogSoftMax) WithBatchSize added in v0.17.0 

func (mlsm *MatrixLogSoftMax) WithBatchSize(batchSize int) *MatrixLogSoftMax

WithBatchSize sets 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 (*MatrixLogSoftMax) WithBatchStart added in v0.17.0 

func (mlsm *MatrixLogSoftMax) WithBatchStart(batchStart int) *MatrixLogSoftMax

WithBatchStart sets 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 (*MatrixLogSoftMax) WithResultMatrixOrigin added in v0.17.0 

func (mlsm *MatrixLogSoftMax) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixLogSoftMax

WithResultMatrixOrigin sets 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 (*MatrixLogSoftMax) WithSourceColumns added in v0.17.0 

func (mlsm *MatrixLogSoftMax) WithSourceColumns(sourceColumns int) *MatrixLogSoftMax

WithSourceColumns sets 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 (*MatrixLogSoftMax) WithSourceMatrixOrigin added in v0.17.0 

func (mlsm *MatrixLogSoftMax) WithSourceMatrixOrigin(sourceMatrixOrigin metal.MTLOrigin) *MatrixLogSoftMax

WithSourceMatrixOrigin sets 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 (*MatrixLogSoftMax) WithSourceRows added in v0.17.0 

func (mlsm *MatrixLogSoftMax) WithSourceRows(sourceRows int) *MatrixLogSoftMax

WithSourceRows sets 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).

type MatrixLogSoftMaxGradient added in v0.17.0 

type MatrixLogSoftMaxGradient struct {
	MatrixSoftMaxGradient
}

MatrixLogSoftMaxGradient is an idiomatic wrapper over the Objective-C class MPSMatrixLogSoftMaxGradient.

It embeds MatrixSoftMaxGradient, promoting that type's methods.

func MatrixLogSoftMaxGradientFromID added in v0.17.0 

func MatrixLogSoftMaxGradientFromID(id objc.ID) *MatrixLogSoftMaxGradient

MatrixLogSoftMaxGradientFromID adopts an existing Objective-C object as a MatrixLogSoftMaxGradient (nil for 0), retaining it and registering a release finalizer.

func NewMatrixLogSoftMaxGradient added in v0.17.0 

func NewMatrixLogSoftMaxGradient() *MatrixLogSoftMaxGradient

NewMatrixLogSoftMaxGradient creates a new MatrixLogSoftMaxGradient.

func (*MatrixLogSoftMaxGradient) WithBatchSize added in v0.17.0 

func (mlsmg *MatrixLogSoftMaxGradient) WithBatchSize(batchSize int) *MatrixLogSoftMaxGradient

WithBatchSize sets 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 (*MatrixLogSoftMaxGradient) WithBatchStart added in v0.17.0 

func (mlsmg *MatrixLogSoftMaxGradient) WithBatchStart(batchStart int) *MatrixLogSoftMaxGradient

WithBatchStart sets 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 (*MatrixLogSoftMaxGradient) WithPrimarySourceMatrixOrigin added in v0.17.0 

func (mlsmg *MatrixLogSoftMaxGradient) WithPrimarySourceMatrixOrigin(primarySourceMatrixOrigin metal.MTLOrigin) *MatrixLogSoftMaxGradient

WithPrimarySourceMatrixOrigin sets 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 (*MatrixLogSoftMaxGradient) WithResultMatrixOrigin added in v0.17.0 

func (mlsmg *MatrixLogSoftMaxGradient) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixLogSoftMaxGradient

WithResultMatrixOrigin sets 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 (*MatrixLogSoftMaxGradient) WithSecondarySourceMatrixOrigin added in v0.17.0 

func (mlsmg *MatrixLogSoftMaxGradient) WithSecondarySourceMatrixOrigin(secondarySourceMatrixOrigin metal.MTLOrigin) *MatrixLogSoftMaxGradient

WithSecondarySourceMatrixOrigin sets 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 (*MatrixLogSoftMaxGradient) WithSourceColumns added in v0.17.0 

func (mlsmg *MatrixLogSoftMaxGradient) WithSourceColumns(sourceColumns int) *MatrixLogSoftMaxGradient

WithSourceColumns sets 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 (*MatrixLogSoftMaxGradient) WithSourceRows added in v0.17.0 

func (mlsmg *MatrixLogSoftMaxGradient) WithSourceRows(sourceRows int) *MatrixLogSoftMaxGradient

WithSourceRows sets 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.

type MatrixMultiplication added in v0.17.0 

type MatrixMultiplication struct {
	objref.Handle
}

MatrixMultiplication is an idiomatic wrapper over the Objective-C class MPSMatrixMultiplication.

func MatrixMultiplicationFromID added in v0.17.0 

func MatrixMultiplicationFromID(id objc.ID) *MatrixMultiplication

MatrixMultiplicationFromID adopts an existing Objective-C object as a MatrixMultiplication (nil for 0), retaining it and registering a release finalizer.

func NewMatrixMultiplication added in v0.17.0 

func NewMatrixMultiplication() *MatrixMultiplication

NewMatrixMultiplication creates a new MatrixMultiplication.

func (*MatrixMultiplication) BatchSize added in v0.17.0 

func (mm *MatrixMultiplication) BatchSize() int

BatchSize returns 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 (*MatrixMultiplication) BatchStart added in v0.17.0 

func (mm *MatrixMultiplication) BatchStart() int

BatchStart returns 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 (*MatrixMultiplication) Description added in v0.17.0 

func (mm *MatrixMultiplication) Description() string

Description returns the object's -description text.

func (*MatrixMultiplication) IsEqual added in v0.17.0 

func (mm *MatrixMultiplication) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*MatrixMultiplication) IsKind added in v0.17.0 

func (mm *MatrixMultiplication) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*MatrixMultiplication) LeftMatrixOrigin added in v0.17.0 

func (mm *MatrixMultiplication) LeftMatrixOrigin() metal.MTLOrigin

LeftMatrixOrigin returns 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 (*MatrixMultiplication) ResultMatrixOrigin added in v0.17.0 

func (mm *MatrixMultiplication) ResultMatrixOrigin() metal.MTLOrigin

ResultMatrixOrigin returns 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 (*MatrixMultiplication) RightMatrixOrigin added in v0.17.0 

func (mm *MatrixMultiplication) RightMatrixOrigin() metal.MTLOrigin

RightMatrixOrigin returns 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 (*MatrixMultiplication) String added in v0.17.0 

func (mm *MatrixMultiplication) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*MatrixMultiplication) WithBatchSize added in v0.17.0 

func (mm *MatrixMultiplication) WithBatchSize(batchSize int) *MatrixMultiplication

WithBatchSize sets 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 (*MatrixMultiplication) WithBatchStart added in v0.17.0 

func (mm *MatrixMultiplication) WithBatchStart(batchStart int) *MatrixMultiplication

WithBatchStart sets 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 (*MatrixMultiplication) WithLeftMatrixOrigin added in v0.17.0 

func (mm *MatrixMultiplication) WithLeftMatrixOrigin(leftMatrixOrigin metal.MTLOrigin) *MatrixMultiplication

WithLeftMatrixOrigin sets 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 (*MatrixMultiplication) WithResultMatrixOrigin added in v0.17.0 

func (mm *MatrixMultiplication) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixMultiplication

WithResultMatrixOrigin sets 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 (*MatrixMultiplication) WithRightMatrixOrigin added in v0.17.0 

func (mm *MatrixMultiplication) WithRightMatrixOrigin(rightMatrixOrigin metal.MTLOrigin) *MatrixMultiplication

WithRightMatrixOrigin sets 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.

type MatrixRandom added in v0.17.0 

type MatrixRandom struct {
	objref.Handle
}

MatrixRandom is an idiomatic wrapper over the Objective-C class MPSMatrixRandom.

MatrixRandom is an abstract base — you do not construct it directly. Construct one of MatrixRandomMTGP32, MatrixRandomPhilox and pass it where a MatrixRandom is accepted.

func MatrixRandomFromID added in v0.17.0 

func MatrixRandomFromID(id objc.ID) *MatrixRandom

MatrixRandomFromID adopts an existing Objective-C object as a MatrixRandom (nil for 0), retaining it and registering a release finalizer.

func (*MatrixRandom) BatchSize added in v0.17.0 

func (mr *MatrixRandom) BatchSize() int

BatchSize returns the size of the batch to process.

func (*MatrixRandom) BatchStart added in v0.17.0 

func (mr *MatrixRandom) BatchStart() int

BatchStart returns the starting index in the destination batch.

func (*MatrixRandom) Description added in v0.17.0 

func (mr *MatrixRandom) Description() string

Description returns the object's -description text.

func (*MatrixRandom) DistributionType added in v0.17.0 

func (mr *MatrixRandom) DistributionType() MatrixRandomDistribution

DistributionType returns the distribution from which to generate random values. Default is MPSMatrixRandomDistributionDefault

func (*MatrixRandom) IsEqual added in v0.17.0 

func (mr *MatrixRandom) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*MatrixRandom) IsKind added in v0.17.0 

func (mr *MatrixRandom) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*MatrixRandom) String added in v0.17.0 

func (mr *MatrixRandom) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*MatrixRandom) WithBatchSize added in v0.17.0 

func (mr *MatrixRandom) WithBatchSize(batchSize int) *MatrixRandom

WithBatchSize sets the size of the batch to process.

func (*MatrixRandom) WithBatchStart added in v0.17.0 

func (mr *MatrixRandom) WithBatchStart(batchStart int) *MatrixRandom

WithBatchStart sets the starting index in the destination batch.

type MatrixRandomDistribution added in v0.17.0 

type MatrixRandomDistribution uint64

Bitmask — values may be combined with |. 

const (
	MatrixRandomDistributionDefault MatrixRandomDistribution = 1
	MatrixRandomDistributionUniform MatrixRandomDistribution = 2
	MatrixRandomDistributionNormal  MatrixRandomDistribution = 3
)

func (MatrixRandomDistribution) String added in v0.17.0 

func (e MatrixRandomDistribution) String() string

String returns the MatrixRandomDistribution constant's name, or its numeric form when the value is not a known constant.

type MatrixRandomDistributionDescriptor added in v0.17.0 

type MatrixRandomDistributionDescriptor struct {
	objref.Handle
}

MatrixRandomDistributionDescriptor is an idiomatic wrapper over the Objective-C class MPSMatrixRandomDistributionDescriptor.

func DefaultDistributionDescriptor added in v0.17.0 

func DefaultDistributionDescriptor() *MatrixRandomDistributionDescriptor

DefaultDistributionDescriptor returns make a descriptor for a default distribution.

func MatrixRandomDistributionDescriptorFromID added in v0.17.0 

func MatrixRandomDistributionDescriptorFromID(id objc.ID) *MatrixRandomDistributionDescriptor

MatrixRandomDistributionDescriptorFromID adopts an existing Objective-C object as a MatrixRandomDistributionDescriptor (nil for 0), retaining it and registering a release finalizer.

func NewMatrixRandomDistributionDescriptor added in v0.17.0 

func NewMatrixRandomDistributionDescriptor() *MatrixRandomDistributionDescriptor

NewMatrixRandomDistributionDescriptor creates a new MatrixRandomDistributionDescriptor.

func NormalDistributionDescriptorWithMeanStandardDeviation added in v0.17.0 

func NormalDistributionDescriptorWithMeanStandardDeviation(mean float32, standardDeviation float32) *MatrixRandomDistributionDescriptor

NormalDistributionDescriptorWithMeanStandardDeviation make a descriptor for a normal distribution of floating point values.

func NormalDistributionDescriptorWithMeanStandardDeviationMinimumMaximum added in v0.17.0 

func NormalDistributionDescriptorWithMeanStandardDeviationMinimumMaximum(mean float32, standardDeviation float32, minimum float32, maximum float32) *MatrixRandomDistributionDescriptor

NormalDistributionDescriptorWithMeanStandardDeviationMinimumMaximum make a descriptor for a truncated normal distribution of floating point values.

func UniformDistributionDescriptorWithMinimumMaximum added in v0.17.0 

func UniformDistributionDescriptorWithMinimumMaximum(minimum float32, maximum float32) *MatrixRandomDistributionDescriptor

UniformDistributionDescriptorWithMinimumMaximum make a descriptor for a uniform distribution of floating point values in the range [minimum, maximum).

func (*MatrixRandomDistributionDescriptor) Description added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) Description() string

Description returns the object's -description text.

func (*MatrixRandomDistributionDescriptor) DistributionType added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) DistributionType() MatrixRandomDistribution

DistributionType returns the type of distribution.

func (*MatrixRandomDistributionDescriptor) IsEqual added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*MatrixRandomDistributionDescriptor) IsKind added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*MatrixRandomDistributionDescriptor) Maximum added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) Maximum() float32

Maximum returns for distributions of values bounded above, this value describes the maximum.

func (*MatrixRandomDistributionDescriptor) Mean added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) Mean() float32

Mean returns the value to use for distributions described by their mean.

func (*MatrixRandomDistributionDescriptor) Minimum added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) Minimum() float32

Minimum returns for distributions of values bounded below, this value describes the minimum.

func (*MatrixRandomDistributionDescriptor) StandardDeviation added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) StandardDeviation() float32

StandardDeviation returns the value to use for distributions described by their standardDeviation.

func (*MatrixRandomDistributionDescriptor) String added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*MatrixRandomDistributionDescriptor) WithDistributionType added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) WithDistributionType(distributionType MatrixRandomDistribution) *MatrixRandomDistributionDescriptor

WithDistributionType sets the type of distribution.

func (*MatrixRandomDistributionDescriptor) WithMaximum added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) WithMaximum(maximum float32) *MatrixRandomDistributionDescriptor

WithMaximum sets for distributions of values bounded above, this value describes the maximum.

func (*MatrixRandomDistributionDescriptor) WithMean added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) WithMean(mean float32) *MatrixRandomDistributionDescriptor

WithMean sets the value to use for distributions described by their mean.

func (*MatrixRandomDistributionDescriptor) WithMinimum added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) WithMinimum(minimum float32) *MatrixRandomDistributionDescriptor

WithMinimum sets for distributions of values bounded below, this value describes the minimum.

func (*MatrixRandomDistributionDescriptor) WithStandardDeviation added in v0.17.0 

func (mrdd *MatrixRandomDistributionDescriptor) WithStandardDeviation(standardDeviation float32) *MatrixRandomDistributionDescriptor

WithStandardDeviation sets the value to use for distributions described by their standardDeviation.

type MatrixRandomMTGP32 added in v0.17.0 

type MatrixRandomMTGP32 struct {
	MatrixRandom
}

MatrixRandomMTGP32 is an idiomatic wrapper over the Objective-C class MPSMatrixRandomMTGP32.

It embeds MatrixRandom, promoting that type's methods.

func MatrixRandomMTGP32FromID added in v0.17.0 

func MatrixRandomMTGP32FromID(id objc.ID) *MatrixRandomMTGP32

MatrixRandomMTGP32FromID adopts an existing Objective-C object as a MatrixRandomMTGP32 (nil for 0), retaining it and registering a release finalizer.

func NewMatrixRandomMTGP32 added in v0.17.0 

func NewMatrixRandomMTGP32() *MatrixRandomMTGP32

NewMatrixRandomMTGP32 creates a new MatrixRandomMTGP32.

func (*MatrixRandomMTGP32) WithBatchSize added in v0.17.0 

func (mrm *MatrixRandomMTGP32) WithBatchSize(batchSize int) *MatrixRandomMTGP32

WithBatchSize sets the size of the batch to process.

func (*MatrixRandomMTGP32) WithBatchStart added in v0.17.0 

func (mrm *MatrixRandomMTGP32) WithBatchStart(batchStart int) *MatrixRandomMTGP32

WithBatchStart sets the starting index in the destination batch.

type MatrixRandomPhilox added in v0.17.0 

type MatrixRandomPhilox struct {
	MatrixRandom
}

MatrixRandomPhilox is an idiomatic wrapper over the Objective-C class MPSMatrixRandomPhilox.

It embeds MatrixRandom, promoting that type's methods.

func MatrixRandomPhiloxFromID added in v0.17.0 

func MatrixRandomPhiloxFromID(id objc.ID) *MatrixRandomPhilox

MatrixRandomPhiloxFromID adopts an existing Objective-C object as a MatrixRandomPhilox (nil for 0), retaining it and registering a release finalizer.

func NewMatrixRandomPhilox added in v0.17.0 

func NewMatrixRandomPhilox() *MatrixRandomPhilox

NewMatrixRandomPhilox creates a new MatrixRandomPhilox.

func (*MatrixRandomPhilox) WithBatchSize added in v0.17.0 

func (mrp *MatrixRandomPhilox) WithBatchSize(batchSize int) *MatrixRandomPhilox

WithBatchSize sets the size of the batch to process.

func (*MatrixRandomPhilox) WithBatchStart added in v0.17.0 

func (mrp *MatrixRandomPhilox) WithBatchStart(batchStart int) *MatrixRandomPhilox

WithBatchStart sets the starting index in the destination batch.

type MatrixRandomProvider added in v0.17.0 

type MatrixRandomProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

MatrixRandomProvider is accepted wherever a MPSMatrixRandom (or one of its subclasses) is expected.

type MatrixSoftMax added in v0.17.0 

type MatrixSoftMax struct {
	MatrixUnaryKernel
}

MatrixSoftMax is an idiomatic wrapper over the Objective-C class MPSMatrixSoftMax.

MatrixSoftMax is an abstract base — you do not construct it directly. Construct one of MatrixLogSoftMax and pass it where a MatrixSoftMax is accepted.

func MatrixSoftMaxFromID added in v0.17.0 

func MatrixSoftMaxFromID(id objc.ID) *MatrixSoftMax

MatrixSoftMaxFromID adopts an existing Objective-C object as a MatrixSoftMax (nil for 0), retaining it and registering a release finalizer.

func (*MatrixSoftMax) SourceColumns added in v0.17.0 

func (msm *MatrixSoftMax) SourceColumns() int

SourceColumns returns 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 (*MatrixSoftMax) SourceRows added in v0.17.0 

func (msm *MatrixSoftMax) SourceRows() int

SourceRows returns 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 (*MatrixSoftMax) WithBatchSize added in v0.17.0 

func (msm *MatrixSoftMax) WithBatchSize(batchSize int) *MatrixSoftMax

WithBatchSize sets 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 (*MatrixSoftMax) WithBatchStart added in v0.17.0 

func (msm *MatrixSoftMax) WithBatchStart(batchStart int) *MatrixSoftMax

WithBatchStart sets 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 (*MatrixSoftMax) WithResultMatrixOrigin added in v0.17.0 

func (msm *MatrixSoftMax) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixSoftMax

WithResultMatrixOrigin sets 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 (*MatrixSoftMax) WithSourceColumns added in v0.17.0 

func (msm *MatrixSoftMax) WithSourceColumns(sourceColumns int) *MatrixSoftMax

WithSourceColumns sets 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 (*MatrixSoftMax) WithSourceMatrixOrigin added in v0.17.0 

func (msm *MatrixSoftMax) WithSourceMatrixOrigin(sourceMatrixOrigin metal.MTLOrigin) *MatrixSoftMax

WithSourceMatrixOrigin sets 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 (*MatrixSoftMax) WithSourceRows added in v0.17.0 

func (msm *MatrixSoftMax) WithSourceRows(sourceRows int) *MatrixSoftMax

WithSourceRows sets 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).

type MatrixSoftMaxGradient added in v0.17.0 

type MatrixSoftMaxGradient struct {
	MatrixBinaryKernel
}

MatrixSoftMaxGradient is an idiomatic wrapper over the Objective-C class MPSMatrixSoftMaxGradient.

MatrixSoftMaxGradient is an abstract base — you do not construct it directly. Construct one of MatrixLogSoftMaxGradient and pass it where a MatrixSoftMaxGradient is accepted.

func MatrixSoftMaxGradientFromID added in v0.17.0 

func MatrixSoftMaxGradientFromID(id objc.ID) *MatrixSoftMaxGradient

MatrixSoftMaxGradientFromID adopts an existing Objective-C object as a MatrixSoftMaxGradient (nil for 0), retaining it and registering a release finalizer.

func (*MatrixSoftMaxGradient) SourceColumns added in v0.17.0 

func (msmg *MatrixSoftMaxGradient) SourceColumns() int

SourceColumns returns 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 (*MatrixSoftMaxGradient) SourceRows added in v0.17.0 

func (msmg *MatrixSoftMaxGradient) SourceRows() int

SourceRows returns 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 (*MatrixSoftMaxGradient) WithBatchSize added in v0.17.0 

func (msmg *MatrixSoftMaxGradient) WithBatchSize(batchSize int) *MatrixSoftMaxGradient

WithBatchSize sets 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 (*MatrixSoftMaxGradient) WithBatchStart added in v0.17.0 

func (msmg *MatrixSoftMaxGradient) WithBatchStart(batchStart int) *MatrixSoftMaxGradient

WithBatchStart sets 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 (*MatrixSoftMaxGradient) WithPrimarySourceMatrixOrigin added in v0.17.0 

func (msmg *MatrixSoftMaxGradient) WithPrimarySourceMatrixOrigin(primarySourceMatrixOrigin metal.MTLOrigin) *MatrixSoftMaxGradient

WithPrimarySourceMatrixOrigin sets 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 (*MatrixSoftMaxGradient) WithResultMatrixOrigin added in v0.17.0 

func (msmg *MatrixSoftMaxGradient) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixSoftMaxGradient

WithResultMatrixOrigin sets 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 (*MatrixSoftMaxGradient) WithSecondarySourceMatrixOrigin added in v0.17.0 

func (msmg *MatrixSoftMaxGradient) WithSecondarySourceMatrixOrigin(secondarySourceMatrixOrigin metal.MTLOrigin) *MatrixSoftMaxGradient

WithSecondarySourceMatrixOrigin sets 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 (*MatrixSoftMaxGradient) WithSourceColumns added in v0.17.0 

func (msmg *MatrixSoftMaxGradient) WithSourceColumns(sourceColumns int) *MatrixSoftMaxGradient

WithSourceColumns sets 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 (*MatrixSoftMaxGradient) WithSourceRows added in v0.17.0 

func (msmg *MatrixSoftMaxGradient) WithSourceRows(sourceRows int) *MatrixSoftMaxGradient

WithSourceRows sets 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.

type MatrixSoftMaxGradientProvider added in v0.17.0 

type MatrixSoftMaxGradientProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

MatrixSoftMaxGradientProvider is accepted wherever a MPSMatrixSoftMaxGradient (or one of its subclasses) is expected.

type MatrixSoftMaxProvider added in v0.17.0 

type MatrixSoftMaxProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

MatrixSoftMaxProvider is accepted wherever a MPSMatrixSoftMax (or one of its subclasses) is expected.

type MatrixSolveCholesky added in v0.17.0 

type MatrixSolveCholesky struct {
	MatrixBinaryKernel
}

MatrixSolveCholesky is an idiomatic wrapper over the Objective-C class MPSMatrixSolveCholesky.

It embeds MatrixBinaryKernel, promoting that type's methods.

func MatrixSolveCholeskyFromID added in v0.17.0 

func MatrixSolveCholeskyFromID(id objc.ID) *MatrixSolveCholesky

MatrixSolveCholeskyFromID adopts an existing Objective-C object as a MatrixSolveCholesky (nil for 0), retaining it and registering a release finalizer.

func NewMatrixSolveCholesky added in v0.17.0 

func NewMatrixSolveCholesky() *MatrixSolveCholesky

NewMatrixSolveCholesky creates a new MatrixSolveCholesky.

func (*MatrixSolveCholesky) WithBatchSize added in v0.17.0 

func (msc *MatrixSolveCholesky) WithBatchSize(batchSize int) *MatrixSolveCholesky

WithBatchSize sets 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 (*MatrixSolveCholesky) WithBatchStart added in v0.17.0 

func (msc *MatrixSolveCholesky) WithBatchStart(batchStart int) *MatrixSolveCholesky

WithBatchStart sets 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 (*MatrixSolveCholesky) WithPrimarySourceMatrixOrigin added in v0.17.0 

func (msc *MatrixSolveCholesky) WithPrimarySourceMatrixOrigin(primarySourceMatrixOrigin metal.MTLOrigin) *MatrixSolveCholesky

WithPrimarySourceMatrixOrigin sets 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 (*MatrixSolveCholesky) WithResultMatrixOrigin added in v0.17.0 

func (msc *MatrixSolveCholesky) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixSolveCholesky

WithResultMatrixOrigin sets 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 (*MatrixSolveCholesky) WithSecondarySourceMatrixOrigin added in v0.17.0 

func (msc *MatrixSolveCholesky) WithSecondarySourceMatrixOrigin(secondarySourceMatrixOrigin metal.MTLOrigin) *MatrixSolveCholesky

WithSecondarySourceMatrixOrigin sets 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.

type MatrixSolveLU added in v0.17.0 

type MatrixSolveLU struct {
	MatrixBinaryKernel
}

MatrixSolveLU is an idiomatic wrapper over the Objective-C class MPSMatrixSolveLU.

It embeds MatrixBinaryKernel, promoting that type's methods.

func MatrixSolveLUFromID added in v0.17.0 

func MatrixSolveLUFromID(id objc.ID) *MatrixSolveLU

MatrixSolveLUFromID adopts an existing Objective-C object as a MatrixSolveLU (nil for 0), retaining it and registering a release finalizer.

func NewMatrixSolveLU added in v0.17.0 

func NewMatrixSolveLU() *MatrixSolveLU

NewMatrixSolveLU creates a new MatrixSolveLU.

func (*MatrixSolveLU) WithBatchSize added in v0.17.0 

func (msl *MatrixSolveLU) WithBatchSize(batchSize int) *MatrixSolveLU

WithBatchSize sets 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 (*MatrixSolveLU) WithBatchStart added in v0.17.0 

func (msl *MatrixSolveLU) WithBatchStart(batchStart int) *MatrixSolveLU

WithBatchStart sets 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 (*MatrixSolveLU) WithPrimarySourceMatrixOrigin added in v0.17.0 

func (msl *MatrixSolveLU) WithPrimarySourceMatrixOrigin(primarySourceMatrixOrigin metal.MTLOrigin) *MatrixSolveLU

WithPrimarySourceMatrixOrigin sets 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 (*MatrixSolveLU) WithResultMatrixOrigin added in v0.17.0 

func (msl *MatrixSolveLU) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixSolveLU

WithResultMatrixOrigin sets 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 (*MatrixSolveLU) WithSecondarySourceMatrixOrigin added in v0.17.0 

func (msl *MatrixSolveLU) WithSecondarySourceMatrixOrigin(secondarySourceMatrixOrigin metal.MTLOrigin) *MatrixSolveLU

WithSecondarySourceMatrixOrigin sets 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.

type MatrixSolveTriangular added in v0.17.0 

type MatrixSolveTriangular struct {
	MatrixBinaryKernel
}

MatrixSolveTriangular is an idiomatic wrapper over the Objective-C class MPSMatrixSolveTriangular.

It embeds MatrixBinaryKernel, promoting that type's methods.

func MatrixSolveTriangularFromID added in v0.17.0 

func MatrixSolveTriangularFromID(id objc.ID) *MatrixSolveTriangular

MatrixSolveTriangularFromID adopts an existing Objective-C object as a MatrixSolveTriangular (nil for 0), retaining it and registering a release finalizer.

func NewMatrixSolveTriangular added in v0.17.0 

func NewMatrixSolveTriangular() *MatrixSolveTriangular

NewMatrixSolveTriangular creates a new MatrixSolveTriangular.

func (*MatrixSolveTriangular) WithBatchSize added in v0.17.0 

func (mst *MatrixSolveTriangular) WithBatchSize(batchSize int) *MatrixSolveTriangular

WithBatchSize sets 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 (*MatrixSolveTriangular) WithBatchStart added in v0.17.0 

func (mst *MatrixSolveTriangular) WithBatchStart(batchStart int) *MatrixSolveTriangular

WithBatchStart sets 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 (*MatrixSolveTriangular) WithPrimarySourceMatrixOrigin added in v0.17.0 

func (mst *MatrixSolveTriangular) WithPrimarySourceMatrixOrigin(primarySourceMatrixOrigin metal.MTLOrigin) *MatrixSolveTriangular

WithPrimarySourceMatrixOrigin sets 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 (*MatrixSolveTriangular) WithResultMatrixOrigin added in v0.17.0 

func (mst *MatrixSolveTriangular) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixSolveTriangular

WithResultMatrixOrigin sets 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 (*MatrixSolveTriangular) WithSecondarySourceMatrixOrigin added in v0.17.0 

func (mst *MatrixSolveTriangular) WithSecondarySourceMatrixOrigin(secondarySourceMatrixOrigin metal.MTLOrigin) *MatrixSolveTriangular

WithSecondarySourceMatrixOrigin sets 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.

type MatrixUnaryKernel added in v0.17.0 

type MatrixUnaryKernel struct {
	objref.Handle
}

MatrixUnaryKernel is an idiomatic wrapper over the Objective-C class MPSMatrixUnaryKernel.

MatrixUnaryKernel is an abstract base — you do not construct it directly. Construct one of MatrixDecompositionCholesky, MatrixDecompositionLU, MatrixFindTopK, MatrixSoftMax and pass it where a MatrixUnaryKernel is accepted.

func MatrixUnaryKernelFromID added in v0.17.0 

func MatrixUnaryKernelFromID(id objc.ID) *MatrixUnaryKernel

MatrixUnaryKernelFromID adopts an existing Objective-C object as a MatrixUnaryKernel (nil for 0), retaining it and registering a release finalizer.

func (*MatrixUnaryKernel) BatchSize added in v0.17.0 

func (muk *MatrixUnaryKernel) BatchSize() int

BatchSize returns 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 (*MatrixUnaryKernel) BatchStart added in v0.17.0 

func (muk *MatrixUnaryKernel) BatchStart() int

BatchStart returns 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 (*MatrixUnaryKernel) Description added in v0.17.0 

func (muk *MatrixUnaryKernel) Description() string

Description returns the object's -description text.

func (*MatrixUnaryKernel) IsEqual added in v0.17.0 

func (muk *MatrixUnaryKernel) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*MatrixUnaryKernel) IsKind added in v0.17.0 

func (muk *MatrixUnaryKernel) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*MatrixUnaryKernel) ResultMatrixOrigin added in v0.17.0 

func (muk *MatrixUnaryKernel) ResultMatrixOrigin() metal.MTLOrigin

ResultMatrixOrigin returns 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 (*MatrixUnaryKernel) SourceMatrixOrigin added in v0.17.0 

func (muk *MatrixUnaryKernel) SourceMatrixOrigin() metal.MTLOrigin

SourceMatrixOrigin returns 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 (*MatrixUnaryKernel) String added in v0.17.0 

func (muk *MatrixUnaryKernel) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*MatrixUnaryKernel) WithBatchSize added in v0.17.0 

func (muk *MatrixUnaryKernel) WithBatchSize(batchSize int) *MatrixUnaryKernel

WithBatchSize sets 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 (*MatrixUnaryKernel) WithBatchStart added in v0.17.0 

func (muk *MatrixUnaryKernel) WithBatchStart(batchStart int) *MatrixUnaryKernel

WithBatchStart sets 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 (*MatrixUnaryKernel) WithResultMatrixOrigin added in v0.17.0 

func (muk *MatrixUnaryKernel) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixUnaryKernel

WithResultMatrixOrigin sets 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 (*MatrixUnaryKernel) WithSourceMatrixOrigin added in v0.17.0 

func (muk *MatrixUnaryKernel) WithSourceMatrixOrigin(sourceMatrixOrigin metal.MTLOrigin) *MatrixUnaryKernel

WithSourceMatrixOrigin sets 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.

type MatrixUnaryKernelProvider added in v0.17.0 

type MatrixUnaryKernelProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

MatrixUnaryKernelProvider is accepted wherever a MPSMatrixUnaryKernel (or one of its subclasses) is expected.

type MatrixVectorMultiplication added in v0.17.0 

type MatrixVectorMultiplication struct {
	MatrixBinaryKernel
}

MatrixVectorMultiplication is an idiomatic wrapper over the Objective-C class MPSMatrixVectorMultiplication.

It embeds MatrixBinaryKernel, promoting that type's methods.

func MatrixVectorMultiplicationFromID added in v0.17.0 

func MatrixVectorMultiplicationFromID(id objc.ID) *MatrixVectorMultiplication

MatrixVectorMultiplicationFromID adopts an existing Objective-C object as a MatrixVectorMultiplication (nil for 0), retaining it and registering a release finalizer.

func NewMatrixVectorMultiplication added in v0.17.0 

func NewMatrixVectorMultiplication() *MatrixVectorMultiplication

NewMatrixVectorMultiplication creates a new MatrixVectorMultiplication.

func (*MatrixVectorMultiplication) WithBatchSize added in v0.17.0 

func (mvm *MatrixVectorMultiplication) WithBatchSize(batchSize int) *MatrixVectorMultiplication

WithBatchSize sets 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 (*MatrixVectorMultiplication) WithBatchStart added in v0.17.0 

func (mvm *MatrixVectorMultiplication) WithBatchStart(batchStart int) *MatrixVectorMultiplication

WithBatchStart sets 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 (*MatrixVectorMultiplication) WithPrimarySourceMatrixOrigin added in v0.17.0 

func (mvm *MatrixVectorMultiplication) WithPrimarySourceMatrixOrigin(primarySourceMatrixOrigin metal.MTLOrigin) *MatrixVectorMultiplication

WithPrimarySourceMatrixOrigin sets 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 (*MatrixVectorMultiplication) WithResultMatrixOrigin added in v0.17.0 

func (mvm *MatrixVectorMultiplication) WithResultMatrixOrigin(resultMatrixOrigin metal.MTLOrigin) *MatrixVectorMultiplication

WithResultMatrixOrigin sets 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 (*MatrixVectorMultiplication) WithSecondarySourceMatrixOrigin added in v0.17.0 

func (mvm *MatrixVectorMultiplication) WithSecondarySourceMatrixOrigin(secondarySourceMatrixOrigin metal.MTLOrigin) *MatrixVectorMultiplication

WithSecondarySourceMatrixOrigin sets 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.

type MpoFlags added in v0.17.0 

type MpoFlags uint32

Bitmask — values may be combined with |. 

const (
	MpoFlagsPort                        MpoFlags = 0
	MpoFlagsServicePort                 MpoFlags = 1024
	MpoFlagsConnectionPort              MpoFlags = 2048
	MpoFlagsReplyPort                   MpoFlags = 4096
	MpoFlagsWeakReplyPort               MpoFlags = 16384
	MpoFlagsNotificationPort            MpoFlags = 17408
	MpoFlagsExceptionPort               MpoFlags = 32768
	MpoFlagsConnectionPortWithPortArray MpoFlags = 65536
)

func (MpoFlags) String added in v0.17.0 

func (e MpoFlags) String() string

String returns the MpoFlags constant's name, or its numeric form when the value is not a known constant.

type OSClockid added in v0.17.0 

type OSClockid uint32
const (
	OSClockidTime OSClockid = 32
)

func (OSClockid) String added in v0.17.0 

func (e OSClockid) String() string

String returns the OSClockid constant's name, or its numeric form when the value is not a known constant.

type Perm added in v0.17.0 

type Perm int32
const (
	PermReadData           Perm = 2
	PermListDirectory      Perm = 2
	PermWriteData          Perm = 4
	PermAddFile            Perm = 4
	PermExecute            Perm = 8
	PermSearch             Perm = 8
	PermDelete             Perm = 16
	PermAppendData         Perm = 32
	PermAddSubdirectory    Perm = 32
	PermDeleteChild        Perm = 64
	PermReadAttributes     Perm = 128
	PermWriteAttributes    Perm = 256
	PermReadExtattributes  Perm = 512
	PermWriteExtattributes Perm = 1024
	PermReadSecurity       Perm = 2048
	PermWriteSecurity      Perm = 4096
	PermChangeOwner        Perm = 8192
	PermSynchronize        Perm = 1048576
)

func (Perm) String added in v0.17.0 

func (e Perm) String() string

String returns the Perm constant's name, or its numeric form when the value is not a known constant.

type PtrauthKey added in v0.17.0 

type PtrauthKey int32
const (
	Ptrauth_key_none                     PtrauthKey = -1
	Ptrauth_key_asia                     PtrauthKey = 0
	Ptrauth_key_asib                     PtrauthKey = 1
	Ptrauth_key_asda                     PtrauthKey = 2
	Ptrauth_key_asdb                     PtrauthKey = 3
	Ptrauth_key_process_independent_code PtrauthKey = 0
	Ptrauth_key_process_dependent_code   PtrauthKey = 1
	Ptrauth_key_process_independent_data PtrauthKey = 2
	Ptrauth_key_process_dependent_data   PtrauthKey = 3
	Ptrauth_key_return_address           PtrauthKey = 1
	Ptrauth_key_frame_pointer            PtrauthKey = 3
	Ptrauth_key_function_pointer         PtrauthKey = 0
	Ptrauth_key_block_function           PtrauthKey = 0
	Ptrauth_key_cxx_vtable_pointer       PtrauthKey = 2
	Ptrauth_key_method_list_pointer      PtrauthKey = 2
	Ptrauth_key_objc_isa_pointer         PtrauthKey = 2
	Ptrauth_key_objc_super_pointer       PtrauthKey = 2
	Ptrauth_key_objc_sel_pointer         PtrauthKey = 3
	Ptrauth_key_objc_class_ro_pointer    PtrauthKey = 2
	Ptrauth_key_block_descriptor_pointer PtrauthKey = 2
	Ptrauth_key_init_fini_pointer        PtrauthKey = 0
)

func (PtrauthKey) String added in v0.17.0 

func (e PtrauthKey) String() string

String returns the PtrauthKey constant's name, or its numeric form when the value is not a known constant.

type QosClass added in v0.17.0 

type QosClass uint32
const (
	QosClassUserInteractive QosClass = 33
	QosClassUserInitiated   QosClass = 25
	QosClassDefault         QosClass = 21
	QosClassUtility         QosClass = 17
	QosClassBackground      QosClass = 9
	QosClassUnspecified     QosClass = 0
)

func (QosClass) String added in v0.17.0 

func (e QosClass) String() string

String returns the QosClass constant's name, or its numeric form when the value is not a known constant.

type Tag added in v0.17.0 

type Tag int32
const (
	TagUndefinedTag  Tag = 0
	TagExtendedAllow Tag = 1
	TagExtendedDeny  Tag = 2
)

func (Tag) String added in v0.17.0 

func (e Tag) String() string

String returns the Tag constant's name, or its numeric form when the value is not a known constant.

type Type added in v0.17.0 

type Type int32
const (
	TypeExtended Type = 256
	TypeAccess   Type = 0
	TypeDefault  Type = 1
	TypeAfs      Type = 2
	TypeCoda     Type = 3
	TypeNtfs     Type = 4
	TypeNwfs     Type = 5
)

func (Type) String added in v0.17.0 

func (e Type) String() string

String returns the Type constant's name, or its numeric form when the value is not a known constant.

type VirtualMemoryGuardExceptionCode added in v0.17.0 

type VirtualMemoryGuardExceptionCode uint32
const (
	KGUARD_EXC_DEALLOC_GAP                   VirtualMemoryGuardExceptionCode = 1
	KGUARD_EXC_RECLAIM_COPYIO_FAILURE        VirtualMemoryGuardExceptionCode = 2
	KGUARD_EXC_RECLAIM_INDEX_FAILURE         VirtualMemoryGuardExceptionCode = 4
	KGUARD_EXC_RECLAIM_DEALLOCATE_FAILURE    VirtualMemoryGuardExceptionCode = 8
	KGUARD_EXC_RECLAIM_ACCOUNTING_FAILURE    VirtualMemoryGuardExceptionCode = 9
	KGUARD_EXC_SEC_IOPL_ON_EXEC_PAGE         VirtualMemoryGuardExceptionCode = 10
	KGUARD_EXC_SEC_EXEC_ON_IOPL_PAGE         VirtualMemoryGuardExceptionCode = 11
	KGUARD_EXC_SEC_UPL_WRITE_ON_EXEC_REGION  VirtualMemoryGuardExceptionCode = 12
	KGUARD_EXC_LARGE_ALLOCATION_TELEMETRY    VirtualMemoryGuardExceptionCode = 13
	KGUARD_EXC_SEC_ACCESS_FAULT              VirtualMemoryGuardExceptionCode = 98
	KGUARD_EXC_SEC_ASYNC_ACCESS_FAULT        VirtualMemoryGuardExceptionCode = 99
	KGUARD_EXC_SEC_COPY_DENIED               VirtualMemoryGuardExceptionCode = 100
	KGUARD_EXC_SEC_SHARING_DENIED            VirtualMemoryGuardExceptionCode = 101
	KGUARD_EXC_MTE_SYNC_FAULT                VirtualMemoryGuardExceptionCode = 200
	KGUARD_EXC_MTE_ASYNC_USER_FAULT          VirtualMemoryGuardExceptionCode = 201
	KGUARD_EXC_MTE_ASYNC_KERN_FAULT          VirtualMemoryGuardExceptionCode = 202
	KGUARD_EXC_GUARD_OBJECT_ASYNC_USER_FAULT VirtualMemoryGuardExceptionCode = 203
	KGUARD_EXC_GUARD_OBJECT_ASYNC_KERN_FAULT VirtualMemoryGuardExceptionCode = 204
)

func (VirtualMemoryGuardExceptionCode) String added in v0.17.0 

func (e VirtualMemoryGuardExceptionCode) String() string

String returns the VirtualMemoryGuardExceptionCode constant's name, or its numeric form when the value is not a known constant.

type XpcListenerCreateFlags added in v0.17.0 

type XpcListenerCreateFlags uint64

Bitmask — values may be combined with |. 

const (
	XpcListenerCreateFlagsNone            XpcListenerCreateFlags = 0
	XpcListenerCreateFlagsInactive        XpcListenerCreateFlags = 1
	XpcListenerCreateFlagsForceMach       XpcListenerCreateFlags = 2
	XpcListenerCreateFlagsForceXpcservice XpcListenerCreateFlags = 4
)

func (XpcListenerCreateFlags) String added in v0.17.0 

func (e XpcListenerCreateFlags) String() string

String returns the XpcListenerCreateFlags constant's name, or its numeric form when the value is not a known constant.

type XpcSessionCreateFlags added in v0.17.0 

type XpcSessionCreateFlags uint64

Bitmask — values may be combined with |. 

const (
	XpcSessionCreateFlagsNone           XpcSessionCreateFlags = 0
	XpcSessionCreateFlagsInactive       XpcSessionCreateFlags = 1
	XpcSessionCreateFlagsMachPrivileged XpcSessionCreateFlags = 2
)

func (XpcSessionCreateFlags) String added in v0.17.0 

func (e XpcSessionCreateFlags) String() string

String returns the XpcSessionCreateFlags constant's name, or its numeric form when the value is not a known constant.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.