Skip to main content

Scratch

Struct Scratch 

Source
pub struct Scratch {
    pub grid: NeighborGrid,
    /* private fields */
}
Expand description

Reusable scratch buffers for the crowd models.

Every step_* path in this crate needs exactly one Vec<Vec2> of length peds.len() (for next-tick accelerations, velocities, or positions) and one NeighborGrid rebuilt against the current pedestrian slice. Scratch bundles both so a caller can allocate once per simulation instead of twice per tick.

let mut scratch = Scratch::with_capacity(peds.len(), 1.0);
for _ in 0..num_steps {
    social_force::step_scratch(&mut peds, &walls, &params, dt, &mut scratch);
}

Scratch is not tied to a specific model: the same instance can drive social_force, collision_free_speed, anticipation_velocity, generalized_centrifugal_force, or optimal_steps step-by-step, provided the grid’s cell_size is a sensible cap on the largest neighbor_cutoff in play.

Fields§

§grid: NeighborGrid

Neighbour grid rebuilt against the pedestrian slice each tick.

Implementations§

Source§

impl Scratch

Source

pub fn new(cell_size: f64) -> Self

Empty scratch with a grid of the given cell size (metres).

§Panics

Panics if cell_size is not strictly positive.

Source

pub fn with_capacity(n: usize, cell_size: f64) -> Self

Scratch pre-sized for n pedestrians and a grid of cell_size.

Source

pub fn clear(&mut self)

Clear the buffers without releasing their capacity.

Trait Implementations§

Source§

impl Clone for Scratch

Source§

fn clone(&self) -> Scratch

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Scratch

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Message for T
where T: Clone + Send + Sync + 'static,