Struct bigbang::GravTree

pub struct GravTree<T: AsEntity + Clone> {
    pub root: Node<T>,
    // some fields omitted
}

The main struct you will interact with. This is a k-d tree containing all of your gravitational entities.

Fields

root: Node<T>

A GravTree consists of a root [[Node]]. A [[Node]] is a recursive binary tree data structure. Tragically must be public for now for testing reasons. Perhaps could be replaced by various getter methods later.

Methods

impl<T: AsEntity + Clone + Send + Sync> GravTree<T>

pub fn new(pts: &mut Vec<T>, time_step: f64) -> GravTree<T> where
    T: AsEntity, 

pub fn as_vec(&self) -> Vec<T>

Traverses the tree and returns a vector of all entities in the tree.

pub fn get_number_of_entities(&self) -> usize

Gets the total number of entities contained by this tree.

pub fn time_step(&self) -> GravTree<T>

This function creates a vector of all entities from the tree and applies gravity to them. Returns a new GravTree.

pub fn from_data_file(
    file_string: String,
    time_step: f64
) -> Result<GravTree<Entity>, &'static str>

Reads a data file generated by this program. To see the format of this file, go to [[write_data_file]]. Takes in a file path and a time_step value. These are not encoded in the data files to allow for SwiftViz to read the files without issue. There is currently no way to offload theta, max_pts, and time_step into the data file. Returns a new GravTree with the data from the file on success, or an error message if the data format is incorrect. Panics if the file path provided is incorrect.

pub fn write_data_file(self, file_path: String)

Writes a utf8 file with one entity per line, space separated values of the format: x y z vx vy vz mass radius. Must have a newline after the final entity. This is compatible with SwiftVis visualizations.