Skip to main content

BlockSparseLayout

Struct BlockSparseLayout 

Source
pub struct BlockSparseLayout<S: Sector> { /* private fields */ }
Expand description

Interpretation half of the block-sparse tensor split.

Holds the allowed-block enumeration (sorted by coordinate, packed offsets), the per-leg sector indices, the conserved flux, the cached logical shape, and the memory order the paired BlockSparseStorage is laid out in.

Construction goes through new, which enumerates flux-allowed blocks and produces a packed layout. Layout-internal invariants (sector conservation, coord uniqueness, no-gap packing) hold by construction; the storage-layout boundary check happens in TensorData::new.

Implementations§

Source§

impl<S: Sector> BlockSparseLayout<S>

Source

pub fn new(indices: Vec<QNIndex<S>>, flux: S, order: MemoryOrder) -> Self

Construct a layout by enumerating flux-allowed blocks.

The resulting layout has blocks sorted by coordinate (lexicographic) with packed offsets (no gaps or overlaps), every block satisfying the flux-conservation law, and a cached storage_extent equal to the sum of allowed block sizes.

Source

pub fn flux(&self) -> &S

Conserved flux (total quantum number).

Source

pub fn indices(&self) -> &[QNIndex<S>]

Per-leg QN indices.

Source

pub fn num_blocks(&self) -> usize

Number of stored (non-zero) blocks.

Source

pub fn block_metas(&self) -> &[BlockMeta]

Block metadata (sorted by coordinate).

Source

pub fn shape(&self) -> &[usize]

Logical shape (total dimension per leg).

Source

pub fn rank(&self) -> usize

Rank (number of legs).

Source

pub fn order(&self) -> MemoryOrder

Memory order the paired storage is laid out in.

Source

pub fn block_shape(&self, coord: &BlockCoord) -> Option<Vec<usize>>

Shape of a specific block, or None if the coordinate is out of range.

Source

pub fn is_allowed_block(&self, coord: &BlockCoord) -> bool

Check whether a block coordinate satisfies the flux conservation law.

Trait Implementations§

Source§

impl<S: Clone + Sector> Clone for BlockSparseLayout<S>

Source§

fn clone(&self) -> BlockSparseLayout<S>

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, S: Sector> StorageFor<BlockSparseLayout<S>> for BlockSparseStorage<T>

Source§

impl<S: Sector> TensorLayout for BlockSparseLayout<S>

Source§

fn shape(&self) -> &[usize]

Logical shape of the tensor.
Source§

fn storage_extent(&self) -> usize

Expected flat storage length for any compatible Storage. Read more

Auto Trait Implementations§

§

impl<S> Freeze for BlockSparseLayout<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for BlockSparseLayout<S>
where S: RefUnwindSafe,

§

impl<S> Send for BlockSparseLayout<S>
where S: Send,

§

impl<S> Sync for BlockSparseLayout<S>
where S: Sync,

§

impl<S> Unpin for BlockSparseLayout<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for BlockSparseLayout<S>
where S: UnsafeUnpin,

§

impl<S> UnwindSafe for BlockSparseLayout<S>
where S: 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<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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> 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V