Struct linfa_trees::Tikz

pub struct Tikz<'a, F: Float, L: Label + Debug> { /* private fields */ }

Struct to print a fitted decision tree in Tex using tikz and forest.

There are two settable parameters:

• legend: if true, a box with the names of the split features will appear in the top right of the tree
• complete: if true, a complete and standalone Tex document will be generated; otherwise the result will an embeddable Tex tree.

Usage

use linfa::prelude::*;
use linfa_datasets;
use linfa_trees::DecisionTree;

// Load dataset
let dataset = linfa_datasets::iris();
// Fit the tree
let tree = DecisionTree::params().fit(&dataset).unwrap();
// Export to tikz
let tikz = tree.export_to_tikz().with_legend();
let latex_tree = tikz.to_string();
// Now you can write latex_tree to the preferred destination

Implementations

impl<'a, F: Float, L: Debug + Label> Tikz<'a, F, L>

pub fn new(tree: &'a DecisionTree<F, L>) -> Self

Creates a new Tikz structure for the decision tree with the following default parameters:

• legend=false
• complete=true

pub fn complete(self, complete: bool) -> Self

Whether a complete Tex document should be generated

pub fn with_legend(self) -> Self

Add a legend to the generated tree

Trait Implementations

impl<'a, F: Clone + Float, L: Clone + Label + Debug> Clone for Tikz<'a, F, L>

fn clone(&self) -> Tikz<'a, F, L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, F: Debug + Float, L: Debug + Label + Debug> Debug for Tikz<'a, F, L>

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

Formats the value using the given formatter.

impl<'a, F: Float, L: Debug + Label> Display for Tikz<'a, F, L>

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

Formats the value using the given formatter.

impl<'a, F: PartialEq + Float, L: PartialEq + Label + Debug> PartialEq for Tikz<'a, F, L>

fn eq(&self, other: &Tikz<'a, F, L>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, F: Float, L: Label + Debug> StructuralPartialEq for Tikz<'a, F, L>