Struct TgsCacheStats 

#[non_exhaustive]
pub struct TgsCacheStats {
    pub hits: u64,
    pub misses: u64,
}

Snapshot of SolverBackend::Tgs’s per-frame warm-start impulse cache effectiveness, returned by PhysicsWorld::tgs_cache_stats.

Mirrors crate::solver_tgs::ImpulseCacheStats (which stays crate-internal along with the rest of the solver_tgs family, see SolverBackend’s module doc) so a host can read warm-start diagnostics without depending on any pub(crate) type.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

hits: u64

Number of contacts whose previous-tick impulse was found in the cache (a successful warm start).

misses: u64

Number of contacts not found in the cache (new contact, or one whose entry was evicted by PhysicsWorld::step’s per-tick internal ImpulseCache::sweep call).

Implementations

impl TgsCacheStats

pub fn new(hits: u64, misses: u64) -> Self

Constructs from raw hit/miss counts. Prefer PhysicsWorld::tgs_cache_stats in production; this exists so test/bench code can construct a specific ratio directly — #[non_exhaustive] blocks the struct-literal syntax outside this crate.

pub fn hit_rate(&self) -> f64

Ratio in [0.0, 1.0]. Returns 0.0 when hits + misses == 0 (no lookups performed yet). Delegates to the internal ImpulseCacheStats::hit_rate (the same hits / (hits + misses) formula) rather than recomputing it here, so this public wrapper has a real dependency on the internal type instead of merely duplicating its arithmetic.

Trait Implementations

impl Clone for TgsCacheStats

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 TgsCacheStats

impl Debug for TgsCacheStats

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

Formats the value using the given formatter.

impl Default for TgsCacheStats

fn default() -> Self

Returns the “default value” for a type.

impl Eq for TgsCacheStats

impl PartialEq for TgsCacheStats

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TgsCacheStats