Struct HPN 

pub struct HPN { /* private fields */ }

Primary struct backing the HPN engine.

Implementations

impl HPN

pub fn clear_tape(&mut self)

Clears the history for this calculator object. Does not alter the stack or memory.

pub fn evaluate(&mut self, line: &str)

Parses and evaluates the given string, applying each change in turn.

use hpn::prelude::*;
let mut hp = HPN::default();
hp.evaluate("4 3 2 1");
println!("{hp}");
// Output:
//  0: [ T:    0.000 | Z:    0.000 | Y:    0.000 | X:    0.000 ]  <- 4
//  1: [ T:    0.000 | Z:    0.000 | Y:    0.000 | X:    4.000 ]  <- 3
//  2: [ T:    0.000 | Z:    0.000 | Y:    4.000 | X:    3.000 ]  <- 2
//  3: [ T:    0.000 | Z:    4.000 | Y:    3.000 | X:    2.000 ]  <- 1
//  4: [ T:    4.000 | Z:    3.000 | Y:    2.000 | X:    1.000 ]

pub fn x(&self) -> &Number

Returns the value of the x register.

assert_eq!(*hp.x(), Number::zero());

pub fn y(&self) -> &Number

Returns the value of the y register.

assert_eq!(*hp.y(), Number::one());

pub fn z(&self) -> &Number

Returns the value of the z register.

let hp = HPN::from("3 2 1 0");
assert_eq!(*hp.z(), Number::from(2));

pub fn t(&self) -> &Number

Returns the value of the t register.

let hp = HPN::from("3 2 1 0");
assert_eq!(*hp.t(), Number::from(3));

pub fn tape(&self) -> impl Iterator<Item = String>

Returns the accumulated history of operations performed in this calculator as a lazy iterator of Strings.

let hp = HPN::from("3 4 7 - +");
hp.tape().for_each(|line| println!("{line}"));

pub fn version() -> String

Yields the version of the crate

Trait Implementations

impl Clone for HPN

fn clone(&self) -> HPN

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HPN

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

Formats the value using the given formatter.

impl Default for HPN

Constructs new HPN instance, with emtpy tape and 0 in each register.

use hpn::prelude::*;

let mut hp = HPN::default();

fn default() -> Self

Returns the “default value” for a type.

impl Display for HPN

Displays the current state of the stack.

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

Formats the value using the given formatter.

impl From<&str> for HPN

Constructs an HPN instance and evaluates the expression passed.

fn from(expr: &str) -> Self

Converts to this type from the input type.

impl From<[BigDecimal; 4]> for HPN

Constructs an HPN instance with the given initial stack.

fn from(stack: [Number; 4]) -> Self

Converts to this type from the input type.

impl From<[f64; 4]> for HPN

Constructs an HPN instance with the given initial stack.

fn from(values: [f64; 4]) -> Self

Converts to this type from the input type.

impl From<[i32; 4]> for HPN

Constructs an HPN instance with the given initial stack.

fn from(values: [i32; 4]) -> Self

Converts to this type from the input type.

impl TryFrom<&HPN> for [f64; 4]

Attempts to convert an HPN instance to an [f64; 4].

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(hp: &HPN) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&HPN> for [i32; 4]

Attempts to convert an HPN instance to an [i32; 4].

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(hp: &HPN) -> Result<Self, Self::Error>

Performs the conversion.