Enum MemoryUsage 

pub enum MemoryUsage {
    MemorySize(usize),
    BatchSize(usize),
}

An enum expressing the memory requirements for batched algorithms such as SortPairs, ParSortPairs, and ParSortIters.

This type implements Mul and Div to scale the memory usage requirements by a given factor, independently of the variant.

Variants

MemorySize(usize)

The target overall memory usage in bytes.

This is the more user-friendly option. The actual number of elements can be computed using batch_size.

BatchSize(usize)

The number of elements used in all batches.

This is a more low-level option that gives more control to the user, but the actual memory usage will depend on the size of labels (if any).

Implementations

impl MemoryUsage

pub fn from_perc(perc: f64) -> Self

Creates a new memory usage expressed as a percentage of the physical RAM.

pub fn batch_size<T>(&self) -> usize

Returns the batch size for elements of type T.

If the memory usage is expressed as a number of bytes, this method divides the number of bytes by the size of T to obtain the number of elements. Otherwise, it just returns specified batch size.

Trait Implementations

impl Clone for MemoryUsage

fn clone(&self) -> MemoryUsage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryUsage

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

Formats the value using the given formatter.

impl Default for MemoryUsage

Default implementation, returning half of the physical RAM.

fn default() -> Self

Returns the “default value” for a type.

impl Display for MemoryUsage

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

Formats the value using the given formatter.

impl Div<usize> for MemoryUsage

type Output = MemoryUsage

The resulting type after applying the / operator.

fn div(self, rhs: usize) -> Self::Output

Performs the / operation.

impl Mul<usize> for MemoryUsage

type Output = MemoryUsage

The resulting type after applying the * operator.

fn mul(self, rhs: usize) -> Self::Output

Performs the * operation.

impl Copy for MemoryUsage