Struct CpuPlanCache 

pub struct CpuPlanCache { /* private fields */ }

A shareable, bounded cache of immutable CPU numerical plans.

Cloning the handle shares the cache. The lock inside is held only while a plan is looked up or inserted, never while a computation runs on it.

Examples

use tenferro_cpu::{CpuEngine, CpuPlanCache};

let plans = CpuPlanCache::new();
let first = CpuEngine::serial().with_plan_cache(plans.clone());
let second = CpuEngine::serial().with_plan_cache(plans.clone());
assert!(first.plan_cache().shares_with(second.plan_cache()));
assert_eq!(plans.stats().entries, 0);

Implementations

impl CpuPlanCache

pub fn new() -> Self

An empty cache with the default bounds.

Examples

let plans = tenferro_cpu::CpuPlanCache::new();
assert_eq!(plans.stats().entries, 0);

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

Whether other is a handle to the same cache.

Examples

let plans = tenferro_cpu::CpuPlanCache::new();
assert!(plans.shares_with(&plans.clone()));
assert!(!plans.shares_with(&tenferro_cpu::CpuPlanCache::new()));

pub fn stats(&self) -> CacheStats

Combined statistics of every plan family.

Examples

assert_eq!(tenferro_cpu::CpuPlanCache::new().stats().hits, 0);

pub fn contraction_stats(&self) -> CacheStats

Statistics of the contraction-plan family alone.

Examples

assert_eq!(tenferro_cpu::CpuPlanCache::new().contraction_stats().entries, 0);

pub fn indexed_stats(&self) -> CacheStats

Statistics of the indexed-traversal family alone.

Examples

assert_eq!(tenferro_cpu::CpuPlanCache::new().indexed_stats().entries, 0);

pub fn clear(&self)

Drop every retained plan.

Examples

let plans = tenferro_cpu::CpuPlanCache::new();
plans.clear();
assert_eq!(plans.stats().entries, 0);

pub fn clear_indexed(&self)

Drop every retained indexed-traversal plan.

Examples

let plans = tenferro_cpu::CpuPlanCache::new();
plans.clear_indexed();
assert_eq!(plans.indexed_stats().entries, 0);

pub fn contraction_capacity(&self) -> usize

Maximum number of retained contraction plans.

Examples

let plans = tenferro_cpu::CpuPlanCache::new();
plans.set_contraction_capacity(8);
assert_eq!(plans.contraction_capacity(), 8);

pub fn set_contraction_capacity(&self, max_plans: usize)

Bound the number of retained contraction plans.

Examples

let plans = tenferro_cpu::CpuPlanCache::new();
plans.set_contraction_capacity(0);
assert_eq!(plans.contraction_capacity(), 0);

pub fn indexed_limits(&self) -> IndexedPlanCacheLimits

Bounds of the indexed-traversal family.

Examples

let plans = tenferro_cpu::CpuPlanCache::new();
let limits = plans.indexed_limits();
plans.set_indexed_limits(limits);
assert_eq!(plans.indexed_limits(), limits);

pub fn set_indexed_limits(&self, limits: IndexedPlanCacheLimits)

Replace the bounds of the indexed-traversal family, evicting as needed.

Examples

let plans = tenferro_cpu::CpuPlanCache::new();
plans.set_indexed_limits(plans.indexed_limits());

Trait Implementations

impl Clone for CpuPlanCache

fn clone(&self) -> CpuPlanCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CpuPlanCache

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

Formats the value using the given formatter.

impl Default for CpuPlanCache

fn default() -> Self

Returns the “default value” for a type.