Struct ScanOptions 

#[non_exhaustive]
pub struct ScanOptions { /* private fields */ }

Direction and inclusivity of an ErasedScanPlan.

The default is an inclusive forward scan: output k combines inputs 0..=k. exclusive combines inputs 0..k instead, so the first output is the identity (0 for sums, 1 for products). reverse scans from the end of the axis: output k combines inputs k..n (inclusive) or k+1..n (exclusive).

Examples

use strided_basic::ScanOptions;
let options = ScanOptions::new().exclusive(true).reverse(true);
assert!(options.is_exclusive() && options.is_reverse());
assert_eq!(ScanOptions::default(), ScanOptions::new());

Implementations

impl ScanOptions

pub const fn new() -> Self

An inclusive forward scan.

Examples

use strided_basic::ScanOptions;
assert!(!ScanOptions::new().is_exclusive());

pub const fn exclusive(self, exclusive: bool) -> Self

Select an exclusive (true) or inclusive (false) scan.

Examples

use strided_basic::ScanOptions;
assert!(ScanOptions::new().exclusive(true).is_exclusive());

pub const fn reverse(self, reverse: bool) -> Self

Select a reverse (true) or forward (false) scan.

Examples

use strided_basic::ScanOptions;
assert!(ScanOptions::new().reverse(true).is_reverse());

pub const fn is_exclusive(&self) -> bool

Whether the scan is exclusive.

Examples

use strided_basic::ScanOptions;
assert!(!ScanOptions::default().is_exclusive());

pub const fn is_reverse(&self) -> bool

Whether the scan runs from the end of the axis.

Examples

use strided_basic::ScanOptions;
assert!(!ScanOptions::default().is_reverse());

Trait Implementations

impl Clone for ScanOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ScanOptions

impl Debug for ScanOptions

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

Formats the value using the given formatter.

impl Default for ScanOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ScanOptions

impl PartialEq for ScanOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScanOptions