Struct StreamOrDevice

pub struct StreamOrDevice { /* private fields */ }

Parameter type for all MLX operations.

Use this to control where operations are evaluated:

If omitted it will use the Default::default(), which will be Device::gpu() unless set otherwise.

Implementations

impl StreamOrDevice

pub fn new(stream: Stream) -> StreamOrDevice

Create a new StreamOrDevice with a Stream.

pub fn new_with_device(device: &Device) -> StreamOrDevice

Create a new StreamOrDevice with a Device.

pub fn cpu() -> StreamOrDevice

Current default CPU stream.

pub fn gpu() -> StreamOrDevice

Current default GPU stream.

Trait Implementations

impl AsRef<Stream> for StreamOrDevice

fn as_ref(&self) -> &Stream

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for StreamOrDevice

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StreamOrDevice

fn default() -> Self

The default stream on the default device.

This will be Device::gpu() unless Device::set_default() sets it otherwise.

impl Display for StreamOrDevice

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StreamOrDevice

fn eq(&self, other: &StreamOrDevice) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StreamOrDevice