Struct elevate_lib::person::Person

pub struct Person {
    pub floor_on: usize,
    pub floor_to: usize,
    pub is_leaving: bool,
    pub wait_time: usize,
    pub p_out: f64,
    pub p_tip: f64,
    /* private fields */
}

Person struct

A Person is aggregated by floors and elevators, and transported between floors by elevators. The person struct generally should not be directly instantiated; instead it should be managed in aggregate via the Building type.

Fields

floor_on: usize

floor_to: usize

is_leaving: bool

wait_time: usize

p_out: f64

p_tip: f64

Implementations

impl Person

Person type implementation

The following functions are used by Elevator/Elevators, Floor/Floors, and Building types to randomly generate the behavior of Persons

pub fn from( p_out: f64, p_tip: f64, num_floors: usize, rng: &mut impl Rng ) -> Person

Initialize a new person given that persons probability of leaving, the number of floors in the building, and an Rng implementation to randomize the person’s destination floor

Example

let p_out: f64 = 0.05_f64; //Must be between 0 and 1
let p_tip: f64 = 0.2_f64; //Must be between 0 and 1
let num_floors: usize = 5_usize;
let my_rng = rand::thread_rng(); //From rand library
let my_pers: Person = Person::from(p_out, num_floors, &mut my_rng);

pub fn gen_is_leaving(&mut self, rng: &mut impl Rng) -> bool

Sample a person’s dst_out distribution to update the person’s is_leaving property randomly and return the result as a bool. Or if the person is already leaving then return the property as is.

pub fn gen_tip(&self, rng: &mut impl Rng) -> bool

Sample a person’s dst_tip distribution to determine whether or not they will decide to tip.

pub fn increment_wait_time(&mut self)

Increment a person’s wait_time property by 1_usize. Generally this should be called by Elevator/Elevators, Floor/Floors, and Building types aggregating Persons when the Person is not at their desired floor.

pub fn reset_wait_time(&mut self)

Reset a person’s wait_time property to 0_usize. Generally this should be called by Elevator/Elevators, Floor/Floors, and Building types aggregating Persons when the Person finally reaches their desired floor.

Trait Implementations

impl Clone for Person

fn clone(&self) -> Person

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Person

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

Format a Person as a string. If a person is not at their desired floor then display the person’s current and desired floor like so: Person 2 -> 4. If the person is at their desired floor then just display their current floor like so: Person 4.

Example

println!("{}", my_pers);

impl Extend<Person> for Elevator

fn extend<T: IntoIterator<Item = Person>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<Person> for Floor

fn extend<T: IntoIterator<Item = Person>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.