Skip to main content

DeviceBackend

Enum DeviceBackend 

Source
pub enum DeviceBackend {
    Cpu,
}
Expand description

Active backend selected at runtime.

Obtain via DeviceBackend::auto_detect for automatic selection, or DeviceBackend::from_preference to request a specific backend.

§Feature gating

  • Cuda variant requires --features cuda.
  • Avx2 variant requires --features avx2 on an x86_64 host.
  • Cpu is always present and is the fallback of last resort.

Variants§

§

Cpu

Scalar CPU path, delegates to zer-compare (Rayon parallel).

Implementations§

Source§

impl DeviceBackend

Source

pub fn auto_detect() -> Self

Auto-detect the best available backend: CUDA → AVX2 → CPU scalar.

Never panics; always returns a usable backend. Tracing output explains which path was selected and why alternatives were skipped.

Source

pub fn cpu() -> Self

Force the scalar CPU backend regardless of available hardware.

Useful in tests where deterministic, non-SIMD behaviour is required.

Source

pub fn from_preference(pref: BackendPreference) -> Result<Self, GpuError>

Request a specific backend.

Returns Err(BackendUnavailable) when:

  • The requested feature flag was not compiled in.
  • The hardware initialisation fails (e.g. no CUDA GPU present).
  • The requested ISA extension is absent at runtime (AVX2).
Source

pub fn run<K: Kernel>(&self, input: K::Input<'_>) -> Result<K::Output, GpuError>
where Self: KernelDispatch<K>,

Dispatch kernel K on this backend.

Source

pub fn name(&self) -> &'static str

Human-readable name of the active backend.

Source

pub fn is_gpu(&self) -> bool

true when a GPU backend (CUDA or Vulkan) is active.

Source

pub fn is_accelerated(&self) -> bool

true when this backend provides any hardware acceleration (GPU or SIMD), i.e. it is not the scalar CPU fallback.

Source

pub fn available_vram_bytes(&self) -> Option<u64>

Available VRAM in bytes, or None for CPU/AVX2 paths.

Source

pub fn total_vram_bytes(&self) -> Option<u64>

Total (installed) VRAM in bytes, or None for CPU/AVX2 paths.

Trait Implementations§

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more