Struct TreeShape 

pub struct TreeShape { /* private fields */ }

Tree shape for drawing

let a = radic!(5, [1, 2, 3, 4], [0, 3]);
let depth = 20;
let shape_options = TreeShapeOptions{
    direction: Direction::Up,
    ..Default::default()
};
let tree_shape = TreeShape::zoomed_tree(&a, depth, shape_options);

Implementations

impl TreeShape

pub fn full_tree( p: u32, depth: usize, options: TreeShapeOptions, ) -> Result<Self, AdicShapeError>

TreeShape showing a full tree with no special branches

Errors

Errors for (1) integer conversion failure, (2) inconsistent directions, and (3) petgraph inconsistency

This full tree uses a LOT of lines if the depth is large, on the order of p^depth. Consider using zoomed_tree instead.

pub fn adic_number_full_tree( adic_data: &impl AdicInteger, depth: usize, options: TreeShapeOptions, ) -> Result<Self, AdicShapeError>

TreeShape showing a full tree with a gold branch showing adic_data

Errors

Errors for (1) integer conversion failure, (2) inconsistent directions, and (3) petgraph inconsistency

This full tree uses a LOT of lines if the depth is large, on the order of p^depth. Consider using zoomed_tree instead.

pub fn zoomed_tree( adic_data: &impl AdicInteger, depth: usize, options: TreeShapeOptions, ) -> Result<Self, AdicShapeError>

TreeShape showing a zoomed tree, only fully following the adic_data branch choice

Errors

Errors for (1) integer conversion failure, (2) inconsistent directions, and (3) petgraph inconsistency

pub fn p(&self) -> u32

Number of branches from each branch point

pub fn center(&self) -> (f64, f64)

Centerpoint for the tree

Trait Implementations

impl Clone for TreeShape

fn clone(&self) -> TreeShape

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TreeShape

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

Formats the value using the given formatter.

impl DisplayShape for TreeShape

fn adic_els(&self) -> impl Iterator<Item = AdicEl>

Internal SVG elements generated from this shape

fn default_class(&self) -> String

Default css class

fn viewbox_width(&self) -> u32

Width of svg viewbox

fn viewbox_height(&self) -> u32

Height of svg viewbox

fn viewbox_str(&self) -> String

Viewbox string

impl SvgDocDisplay for TreeShape

SVG for an adic tree

let neg_one_fourth = radic!(5, [], [1]);
let num_digits = 6;
let adic_tree = TreeShape::full_tree(5, num_digits, TreeShapeOptions::default())?;
let tree_svg = adic_tree.create_svg_doc();
let adic_tree = TreeShape::adic_number_full_tree(&neg_one_fourth, num_digits, TreeShapeOptions::default())?;
let tree_svg = adic_tree.create_svg_doc();
let adic_tree = TreeShape::zoomed_tree(&neg_one_fourth, num_digits, TreeShapeOptions::default())?;
let tree_svg = adic_tree.create_svg_doc();

fn shape_style_els(&self) -> impl Iterator<Item = Element>

Iterator through the style elements for the svg

fn create_svg_doc(&self) -> Document

Create an SVG document for the shape

fn shape_svg_els(&self) -> impl Iterator<Item = Element>

Iterator through all the components of the svg