api

package

v0.3.0 Latest Latest Go to latest Published: Jul 21, 2025 License: Apache-2.0 Imports: 3 Imported by: 3

Details

Package api defines the interface between a backend and a GX package.

This section is empty.

This section is empty.

This section is empty.

type Device struct {
	// contains filtered or unexported fields
}

Device created by a runtime.

func (dev *Device) PlatformDevice() platform.Device

PlatformDevice returns the device used on the platform.

func (dev *Device) Runtime() *Runtime

Runtime returns the device's parent runtime.

type Runtime struct {
	// contains filtered or unexported fields
}

Runtime encapsulates a GX builder and a backend. A backend is a platform managing one or more devices and a graph builder.

func NewRuntime(bck backend.Backend, bld *builder.Builder) *Runtime

NewRuntime returns a new GX runtime.

func (rtm *Runtime) Backend() backend.Backend

Backend used by the runtime.

func (rtm *Runtime) Builder() *builder.Builder

Builder returns the builder used to build GX source code into a GX intermediate representation.

func (rtm *Runtime) Device(ord int) (*Device, error)

Device returns a new device on the platform.

Path	Synopsis
options Package options specifies options for packages.	Package options specifies options for packages.
trace Package trace is the API to use the builtin `trace` in GX.	Package trace is the API to use the builtin `trace` in GX.
tracer Package tracer implements a context and evaluator for the interpreter which builds a graph by tracing operators being executed when GX code is interpreted.	Package tracer implements a context and evaluator for the interpreter which builds a graph by tracing operators being executed when GX code is interpreted.
values Package values implements all values that GX can represent.	Package values implements all values that GX can represent.