Struct Var 

pub struct Var<'a, S: VarScheme + ?Sized> { /* private fields */ }

One variable of a VarScheme, which is to say a scheme together with an index.

It is returned by VarScheme::var, and it is what a variable’s name is written from: it implements Display, ToLatex, and ToTypst.

Implementations

impl<'a, S: VarScheme + ?Sized> Var<'a, S>

pub const fn new(scheme: &'a S, index: usize) -> Self

Makes a handle to one of a scheme’s variables.

VarScheme::var is the shorter way to say this, and works whenever the scheme’s type is known. This one also works for a scheme behind a dyn.

Worst-case complexity

Constant time and additional memory.

Examples

use malachite_base::vars::abc::AbcVars;
use malachite_base::vars::{Var, VarScheme};

let scheme: &dyn VarScheme = &AbcVars;
assert_eq!(Var::new(scheme, 2).to_string(), "c");

pub const fn index(&self) -> usize

The variable’s index.

Worst-case complexity

Constant time and additional memory.

Examples

use malachite_base::vars::VarScheme;
use malachite_base::vars::xyz::XyzVars;

assert_eq!(XyzVars.var(3).index(), 3);

pub const fn scheme(&self) -> &'a S

The scheme the variable belongs to.

Worst-case complexity

Constant time and additional memory.

Examples

use malachite_base::vars::VarScheme;
use malachite_base::vars::abc::AbcVars;

assert_eq!(AbcVars.var(3).scheme().capacity(), Some(26));

Trait Implementations

impl<S: VarScheme + ?Sized> Clone for Var<'_, S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: VarScheme + ?Sized> Copy for Var<'_, S>

impl<S: VarScheme + ?Sized> Debug for Var<'_, S>

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

Converts a variable to a String.

This is the same as the Display implementation: a variable is its name, and a scheme is not required to have a depiction of its own.

Worst-case complexity

Same as the time and additional memory complexity of fmt_var for the scheme.

Examples

use malachite_base::strings::ToDebugString;
use malachite_base::vars::VarScheme;
use malachite_base::vars::indexed::IndexedVars;

assert_eq!(IndexedVars.var(10).to_debug_string(), "x₁₀");

impl<S: VarScheme + ?Sized> Display for Var<'_, S>

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

Converts a variable to a String.

This is the plain name, the one VarScheme::parse_var reads back.

Worst-case complexity

Same as the time and additional memory complexity of fmt_var for the scheme.

Examples

use malachite_base::vars::VarScheme;
use malachite_base::vars::indexed::IndexedVars;

assert_eq!(IndexedVars.var(10).to_string(), "x₁₀");

impl<S: VarScheme + ?Sized> ToLatex for Var<'_, S>

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

Writes a variable as a LaTeX math-mode fragment.

Worst-case complexity

Same as the time and additional memory complexity of fmt_var_latex for the scheme.

Examples

use malachite_base::strings::latex::ToLatex;
use malachite_base::vars::VarScheme;
use malachite_base::vars::greek::GreekVars;
use malachite_base::vars::indexed::IndexedVars;

assert_eq!(IndexedVars.var(10).to_latex_string(), "x_{10}");
assert_eq!(GreekVars.var(0).to_latex_string(), r"\alpha");

Those fragments render as $x_{10}$ and $\alpha$.

fn to_latex(&self) -> LatexWrapper<'_, Self>

where Self: Sized,

Converts a value to a LaTeX math-mode fragment.

fn to_latex_string(&self) -> String

where Self: Sized,

Converts a value to a LaTeX math-mode fragment, as a String.

impl<S: VarScheme + ?Sized> ToTypst for Var<'_, S>

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

Writes a variable as a Typst math-mode fragment.

Worst-case complexity

Same as the time and additional memory complexity of fmt_var_typst for the scheme.

Examples

use malachite_base::strings::typst::ToTypst;
use malachite_base::vars::VarScheme;
use malachite_base::vars::greek::GreekVars;
use malachite_base::vars::indexed::IndexedVars;

assert_eq!(IndexedVars.var(10).to_typst_string(), "x_(10)");
assert_eq!(GreekVars.var(0).to_typst_string(), "α");

fn to_typst(&self) -> TypstWrapper<'_, Self>

where Self: Sized,

Converts a value to a Typst math-mode fragment.

fn to_typst_string(&self) -> String

where Self: Sized,

Converts a value to a Typst math-mode fragment, as a String.