Struct Dim 

pub struct Dim { /* private fields */ }

TeX-style dimension: width, height, depth, italic correction, mu.

Values are zenith-float software floats. One unit is one em at the current math style unless a method says otherwise.

Examples

use latex_rust::Dim;

let half = Dim::ratio(1, 2);
assert!(half.eq_dim(&(&Dim::one() / &Dim::from_i64(2))));
assert!(!Dim::zero().eq_dim(&Dim::one()));

Implementations

impl Dim

pub fn zero() -> Self

Zero em.

pub fn one() -> Self

One em.

pub fn from_i64(v: i64) -> Self

Integer em count.

pub fn ratio(num: i64, den: i64) -> Self

Exact rational num / den em. den == 0 yields NaN.

pub fn parse(s: &str) -> Self

Parse a decimal string (including scientific form) with zenith-float.

pub fn from_font_units(units: i64, units_per_em: u16) -> Self

Convert integer font units to em: units / units_per_em.

pub fn mu() -> Self

One math unit (mu). TeX: 18 mu = 1 em.

pub fn to_mu(&self) -> Self

Convert this em value to mu (* 18).

pub fn from_mu(mu: &Self) -> Self

Convert a mu value to em (/ 18).

pub fn abs(&self) -> Self

Absolute value.

pub fn max(&self, other: &Self) -> Self

Maximum of two dimensions.

pub fn min(&self, other: &Self) -> Self

Minimum of two dimensions.

pub fn clamp_nonneg(&self) -> Self

max(self, 0).

pub fn is_nan(&self) -> bool

True when the value is NaN.

pub fn is_zero(&self) -> bool

True when the value compares equal to zero.

pub fn to_dec_string(&self) -> String

Decimal string from zenith-float (gold-stable for a given precision).

pub fn to_svg_string(&self) -> String

Compact decimal for SVG attributes (same zenith-float decimal as layout golds).

pub fn from_ieee32_bits(bits: u32) -> Self

Layout dimension from an IEEE-754 binary32 bit pattern (ttf-parser outline boundary).

pub fn to_ieee32_bits(&self) -> u32

Round to IEEE-754 binary32 bits for PNG / raster emission only.

Layout arithmetic stays in Dim. This is the pixel-coordinate terminal permitted for SVG/PNG backends.

pub fn floor_to_u32(&self) -> Result<u32, Error>

Largest u32 that is not greater than self. Negative and NaN fail.

pub fn ceil_to_u32(&self) -> Result<u32, Error>

Smallest u32 that is not less than self.

pub fn cmp(&self, other: &Self) -> Option<Ordering>

Compare two dimensions. None if either is NaN.

Named cmp after zenith-float’s partial compare. Ord is not implemented because NaN has no total order.

pub fn eq_dim(&self, other: &Self) -> bool

True when self and other compare equal.

Trait Implementations

impl Add for Dim

type Output = Dim

The resulting type after applying the + operator.

fn add(self, rhs: Dim) -> Dim

Performs the + operation.

impl Add for &Dim

type Output = Dim

The resulting type after applying the + operator.

fn add(self, rhs: &Dim) -> Dim

Performs the + operation.

impl Add<&Dim> for Dim

type Output = Dim

The resulting type after applying the + operator.

fn add(self, rhs: &Dim) -> Dim

Performs the + operation.

impl Add<Dim> for &Dim

type Output = Dim

The resulting type after applying the + operator.

fn add(self, rhs: Dim) -> Dim

Performs the + operation.

impl Clone for Dim

fn clone(&self) -> Dim

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dim

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

Formats the value using the given formatter.

impl Display for Dim

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

Formats the value using the given formatter.

impl Div for Dim

type Output = Dim

The resulting type after applying the / operator.

fn div(self, rhs: Dim) -> Dim

Performs the / operation.

impl Div for &Dim

type Output = Dim

The resulting type after applying the / operator.

fn div(self, rhs: &Dim) -> Dim

Performs the / operation.

impl Div<&Dim> for Dim

type Output = Dim

The resulting type after applying the / operator.

fn div(self, rhs: &Dim) -> Dim

Performs the / operation.

impl Div<Dim> for &Dim

type Output = Dim

The resulting type after applying the / operator.

fn div(self, rhs: Dim) -> Dim

Performs the / operation.

impl Eq for Dim

impl Mul for Dim

type Output = Dim

The resulting type after applying the * operator.

fn mul(self, rhs: Dim) -> Dim

Performs the * operation.

impl Mul for &Dim

type Output = Dim

The resulting type after applying the * operator.

fn mul(self, rhs: &Dim) -> Dim

Performs the * operation.

impl Mul<&Dim> for Dim

type Output = Dim

The resulting type after applying the * operator.

fn mul(self, rhs: &Dim) -> Dim

Performs the * operation.

impl Mul<Dim> for &Dim

type Output = Dim

The resulting type after applying the * operator.

fn mul(self, rhs: Dim) -> Dim

Performs the * operation.

impl Neg for Dim

type Output = Dim

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Dim

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Dim

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for Dim

type Output = Dim

The resulting type after applying the - operator.

fn sub(self, rhs: Dim) -> Dim

Performs the - operation.

impl Sub for &Dim

type Output = Dim

The resulting type after applying the - operator.

fn sub(self, rhs: &Dim) -> Dim

Performs the - operation.

impl Sub<&Dim> for Dim

type Output = Dim

The resulting type after applying the - operator.

fn sub(self, rhs: &Dim) -> Dim

Performs the - operation.

impl Sub<Dim> for &Dim

type Output = Dim

The resulting type after applying the - operator.

fn sub(self, rhs: Dim) -> Dim

Performs the - operation.