Struct quantized_density_fields::qdf::QDF

pub struct QDF<S>where
    S: State,{ /* private fields */ }

Object that represents quantized density fields.

Concept

MOST IMPORTANT NODE: QDF does not exists in any space - it IS the space, it describes it, so there are no space coordinates. To sample specified region you have to know some space and gather the rest of information based on it neighbors. It gives the ability to cotrol space density at specified locations, which can be used for example to simulate space curvature based on gravity.

Implementations

impl<S> QDF<S>where
    S: State,

pub fn new(dimensions: usize, root_state: S) -> Self

Creates new QDF information universe.

Arguments

• dimensions - Number of dimensions which space contains.
• root_state - State of root space.

Examples

use quantized_density_fields::QDF;

// Creates 2d space with `16` as root state.
let qdf = QDF::new(2, 9);
assert_eq!(*qdf.state(), 9);

pub fn id(&self) -> ID

Gets QDF id.

pub fn root(&self) -> ID

Gets QDF root space node id.

pub fn dimensions(&self) -> usize

Gets QDF dimensions number.

Examples

use quantized_density_fields::QDF;

let qdf = QDF::new(2, 9);
assert_eq!(qdf.dimensions(), 2);

pub fn state(&self) -> &S

Gets QDF dimensions number.

Examples

use quantized_density_fields::QDF;

let qdf = QDF::new(2, 9);
assert_eq!(*qdf.state(), 9);

pub fn space_exists(&self, id: ID) -> bool

Tells if space with given id exists in QDF.

Arguments

• id - space id.

Examples

use quantized_density_fields::QDF;

let qdf = QDF::new(2, 9);
assert!(qdf.space_exists(qdf.root()));

pub fn try_get_space(&self, id: ID) -> Option<&Space<S>>

Try to get given space.

Arguments

• id - space id.

Examples

use quantized_density_fields::QDF;

let qdf = QDF::new(2, 9);
if let Some(space) = qdf.try_get_space(qdf.root()) {
    assert_eq!(*space.state(), 9);
}

pub fn get_space(&self, id: ID) -> Result<&Space<S>>

Get given space or throw error if space does not exists.

Arguments

• id - space id.

Examples

use quantized_density_fields::QDF;

let qdf = QDF::new(2, 9);
if let Ok(space) = qdf.get_space(qdf.root()) {
    assert_eq!(*space.state(), 9);
}

pub fn space(&self, id: ID) -> &Space<S>

Get given space or panic if space does not exists.

Arguments

• id - space id.

Examples

use quantized_density_fields::QDF;

let qdf = QDF::new(2, 9);
assert_eq!(*qdf.space(qdf.root()).state(), 9);

pub fn try_set_space_state(&mut self, id: ID, state: S) -> bool

Try to set given space state.

Arguments

• id - space id.
• state - state.

Examples

use quantized_density_fields::QDF;

let mut qdf = QDF::new(2, 9);
let id = qdf.root();
assert!(qdf.try_set_space_state(id, 3));

pub fn set_space_state(&mut self, id: ID, state: S) -> Result<()>

Set given space state or throw error if space does not exists.

Arguments

• id - space id.
• state - state.

Examples

use quantized_density_fields::QDF;

let mut qdf = QDF::new(2, 9);
let id = qdf.root();
assert!(qdf.set_space_state(id, 3).is_ok());

pub fn find_space_neighbors(&self, id: ID) -> Result<Vec<ID>>

Get list of IDs of given space neighbors or throws error if space does not exists.

Arguments

• id - space id.

Examples

use quantized_density_fields::QDF;

let mut qdf = QDF::new(2, 9);
let id = qdf.root();
qdf.increase_space_density(id);
let subs = qdf.space(qdf.root()).subspace();
assert_eq!(qdf.find_space_neighbors(subs[0]).unwrap(), vec![subs[1], subs[2]]);

pub fn find_path(&self, from: ID, to: ID) -> Result<Vec<ID>>

Gets list of space IDs that defines shortest path between two spaces, or throws error if space does not exists.

Arguments

• from - source space id.
• to - target space id.

Examples

use quantized_density_fields::QDF;

let mut qdf = QDF::new(2, 9);
let id = qdf.root();
qdf.increase_space_density(id);
let subs = qdf.space(qdf.root()).subspace().to_vec();
qdf.increase_space_density(subs[0]);
let subs2 = qdf.space(subs[0]).subspace();
assert_eq!(qdf.find_path(subs2[0], subs[2]).unwrap(), vec![subs2[0], subs2[1], subs[2]]);

pub fn increase_space_density(&mut self, id: ID) -> Result<()>

Increases given space density (subdivide space and rebind it properly to its neighbors), or throws error if space does not exists.

Arguments

• id - space id.

Examples

use quantized_density_fields::QDF;

let mut qdf = QDF::new(2, 9);
let id = qdf.root();
qdf.increase_space_density(id);
assert_eq!(qdf.space(qdf.root()).subspace().len(), 3);

pub fn decrease_space_density(&mut self, id: ID) -> Result<bool>

Decreases given space density (merge space children and rebind them properly to theirs neighbors if space has 1 level of subdivision, otherwise perform this operation on its subspaces), or throws error if space does not exists.

Arguments

• id - space id.

Examples

use quantized_density_fields::QDF;

let mut qdf = QDF::new(2, 9);
let id = qdf.root();
qdf.increase_space_density(id);
assert_eq!(qdf.space(qdf.root()).subspace().len(), 3);
qdf.decrease_space_density(id);
assert!(qdf.space(qdf.root()).is_platonic());

pub fn decrease_space_density_level(&mut self, id: ID) -> Result<()>

Decreases given space density (merge space children and rebind them properly to theirs neighbors), or throws error if space does not exists. Basically it works like Self::decrease_space_density() but merges space to make it completely platonic.

Arguments

• id - space id.

Trait Implementations

impl<S> Debug for QDF<S>where
    S: State + Debug,

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

Formats the value using the given formatter.