RuleAssignment

Struct RuleAssignment 

Source
pub struct RuleAssignment(pub HashMap<char, DrawAction>);
Expand description

Represents an assignment of chars to DrawActions.

Tuple Fields§

§0: HashMap<char, DrawAction>

Implementations§

Source§

impl RuleAssignment

Source

pub fn translate(&self, s: String) -> ActionString

Applies the assignment to a string to produce an action string.

§Example
use std::f64::consts::PI;
use std::collections::HashMap;
use l_system_fractals::num_validity::AlmostEq;

use l_system_fractals::rules::{DrawAction, ActionString, RuleAssignment};

let assignment = RuleAssignment(
    HashMap::from([
        ('A', DrawAction::DrawForward(1.0)),
        ('B', DrawAction::MoveForward(1.0))
    ])
);

let action1 = assignment.translate("ABA".to_string());
let action2 = ActionString(
    vec![
        DrawAction::DrawForward(1.0),
        DrawAction::MoveForward(1.0),
        DrawAction::DrawForward(1.0)
    ]
);

assert!(action1.almost_eq(&action2, 0.001));
Source

pub fn make_path( &self, s: String, start: Point, start_angle: f64, ) -> Result<Path, LSystemError>

Translates the string using the assignment and then makes a path with the given starting point and initial angle.

§Example
use std::f64::consts::PI;
use std::collections::HashMap;

use l_system_fractals::rules::{DrawAction, ActionString, RuleAssignment};
use l_system_fractals::paths::{Path, Point};
use l_system_fractals::num_validity::AlmostEq;

let assignment = RuleAssignment(
    HashMap::from([
        ('A', DrawAction::DrawForward(1.0)),
        ('B', DrawAction::MoveForward(1.0))
    ])
);

let pth1 = assignment
    .make_path("ABA".to_string(), Point::new(1.0, 1.0), 0.0)
    .unwrap();
let pth2 = assignment
    .translate("ABA".to_string())
    .make_path(Point::new(1.0, 1.0), 0.0)
    .unwrap();

assert!(pth1.almost_eq(&pth2, 0.001));
Source

pub fn make_default_path(&self, s: String) -> Result<Path, LSystemError>

Translates the string using the assignment and then makes a path with the default starting point and angle (Point::new(0.0, 0.0) and 0.0, respectively).

§Example
use std::f64::consts::PI;
use std::collections::HashMap;

use l_system_fractals::rules::{DrawAction, ActionString, RuleAssignment};
use l_system_fractals::paths::{Path, Point};
use l_system_fractals::num_validity::AlmostEq;

let assignment = RuleAssignment(
    HashMap::from([
        ('A', DrawAction::DrawForward(1.0)),
        ('B', DrawAction::MoveForward(1.0))
    ])
);

let pth1 = assignment
    .make_path("ABA".to_string(), Point::new(0.0, 0.0), 0.0)
    .unwrap();
let pth2 = assignment
    .make_default_path("ABA".to_string())
    .unwrap();

assert!(pth1.almost_eq(&pth2, 0.001));

Trait Implementations§

Source§

impl AlmostEq for RuleAssignment

Source§

fn almost_eq(&self, other: &Self, epsilon: f64) -> bool

Returns true if the distance between objects is less than epsilon.
Source§

impl Clone for RuleAssignment

Source§

fn clone(&self) -> RuleAssignment

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RuleAssignment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<HashMap<char, DrawAction>> for RuleAssignment

Source§

fn from(hm: HashMap<char, DrawAction>) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for RuleAssignment

Source§

fn eq(&self, other: &RuleAssignment) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for RuleAssignment

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.