Struct elevate_lib::building::Building

pub struct Building {
    pub elevators: Vec<Elevator>,
    pub floors: Vec<Floor>,
    pub avg_energy: f64,
    pub avg_wait_time: f64,
    /* private fields */
}

Building struct

A Building aggregates Elevators and Floors. It also tracks the everage energy usage by the elevators, and the average wait time among the people on the building’s floors and elevators. It randomly generates arrivals.

Fields

elevators: Vec<Elevator>

floors: Vec<Floor>

avg_energy: f64

avg_wait_time: f64

Implementations

impl Building

Building type implementation

The following functions are used to control the behavior of the people and elevators owned by the Building type.

pub fn from( num_floors: usize, num_elevators: usize, p_in: f64, energy_up: f64, energy_down: f64, energy_coef: f64 ) -> Building

Initialize a new building given the number of floors, the number of elevators the expected number of arrivals per time step, the base energy spent while moving an elevator up and down, and the additional energy spent per person moved.

Example

let num_floors: usize = 4_usize;
let num_elevators: usize = 2_usize;
let p_in: f64 = 0.5_f64;
let energy_up: f64 = 5.0_f64;
let energy_down: f64 = 2.5_f64;
let energy_coef: f64 = 0.5_f64;
let my_building: Building = Building::from(
    num_floors,
    num_elevators,
    p_in,
    energy_up,
    energy_down,
    energy_coef
);

pub fn update_dest_probabilities(&mut self)

Calculate the probability that each floor becomes a destination floor for an elevator during the next time step. If the floor currently is a destination floor, then return 1_f64.

pub fn gen_people_arriving(&mut self, rng: &mut impl Rng)

Generate the people arriving by sampling the Poisson distribution to receive a number of arrivals, and then instantiate that many people and append them to the first floor.

pub fn exchange_people_on_elevator(&mut self)

For each of the building’s elevators, exchange people between the elevator and its current floor if anyone on the elevator is going to the current floor, or if anyone on the floor is waiting for the elevator.

pub fn update_average_energy(&mut self, time_step: i32, energy_spent: f64)

Update the average energy spent by the building’s elevators given the time step and the energy spent during the time step.

Trait Implementations

impl Display for Building

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

Format a Building as a string.

Example

println!("{}", my_building);

impl Floors for Building

fn are_people_waiting_on_floor(&self, floor_index: usize) -> bool

Determines whether there are any people waiting on a given floor. Returns a bool which is true if so, and false if not.

fn get_nearest_wait_floor(&self, floor_on: usize) -> (usize, usize)

Determines the nearest floor at which people are waiting with respect to the given floor. Returns a tuple of usizes representing the floor index and the distance to the floor.

fn get_dest_probabilities(&self) -> Vec<f64>

Gets the probability that each floor becomes a destination floor in the next time step.

fn gen_people_leaving(&mut self, rng: &mut impl Rng)

Randomly generates the people leaving each floor using each Floor’s gen_people_leaving function, which itself uses each Person’s gen_is_leaving function.

fn flush_first_floor(&mut self)

Removes anyone who is leaving the first floor.

fn increment_wait_times(&mut self)

Increments the waiting times among people who are waiting/not at their destination floor throughout the building’s floors and elevators.