Skip to main content

Ormtr

Struct Ormtr 

Source
pub struct Ormtr<T> { /* private fields */ }
Expand description

Typed operation that applies tridiagonalization factors to a matrix.

Implementations§

Source§

impl<T> Ormtr<T>
where T: OrmtrScalar,

Source

pub const fn new( side: SideMode, fill_mode: FillMode, operation: Operation, rows: usize, cols: usize, ) -> Self

Creates a typed ORMTR/UNMTR operation.

Source

pub const fn side(&self) -> SideMode

Returns which side receives the tridiagonalization factor product.

Source

pub const fn fill_mode(&self) -> FillMode

Returns the cuSOLVER fill mode.

Source

pub const fn operation(&self) -> Operation

Returns the operation applied to the factor product.

Source

pub const fn rows(&self) -> usize

Returns the target matrix row count.

Source

pub const fn cols(&self) -> usize

Returns the target matrix column count.

Source

pub fn workspace_len( &self, ctx: &Context, reflectors: MatrixRef<'_, T>, tau: VectorRef<'_, T>, matrix: MatrixRef<'_, T>, ) -> Result<usize>

Returns the required legacy workspace length in elements.

§Errors

Returns an error if inputs are invalid or if cuSOLVER cannot report the workspace length.

Source

pub fn run(&self, ctx: &Context, args: OrmtrArgs<'_, T>) -> Result<()>

Applies the tridiagonalization factor product in place.

§Errors

Returns an error if inputs or workspace are invalid, or if cuSOLVER reports a failure.

Trait Implementations§

Source§

impl<T: Clone> Clone for Ormtr<T>

Source§

fn clone(&self) -> Ormtr<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Copy> Copy for Ormtr<T>

Source§

impl<T: Debug> Debug for Ormtr<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Eq> Eq for Ormtr<T>

Source§

impl<T: PartialEq> PartialEq for Ormtr<T>

Source§

fn eq(&self, other: &Ormtr<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl<T: PartialEq> StructuralPartialEq for Ormtr<T>

Auto Trait Implementations§

§

impl<T> Freeze for Ormtr<T>

§

impl<T> RefUnwindSafe for Ormtr<T>
where T: RefUnwindSafe,

§

impl<T> Send for Ormtr<T>
where T: Send,

§

impl<T> Sync for Ormtr<T>
where T: Sync,

§

impl<T> Unpin for Ormtr<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Ormtr<T>

§

impl<T> UnwindSafe for Ormtr<T>
where T: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.