Struct ExpandOpts 

pub struct ExpandOpts {
    pub mul: bool,
    pub multinomial: bool,
    pub power_base: bool,
    pub power_exp: bool,
    pub log: bool,
    pub trig: bool,
    pub deep: bool,
    pub force: bool,
}

Hints controlling Ex::expand_with.

Every rewrite is value-preserving. The hints that are only valid under side conditions (power_base, power_exp, log) are guarded by the assumption system unless force is set:

Hint	Rewrite	Guard (unless force)
mul	a·(b + c) → a·b + a·c	none
multinomial	(a + b)^n → … for integer n ≥ 0	none
power_base	(x·y)^e → x^e·y^e	e ∈ ℤ, or every factor known non-negative
power_exp	x^(a+b) → x^a·x^b	x = e, x > 0, all summands numeric same-sign, or all summands known integers
log	ln(a·b) → ln a + ln b, ln(a^n) → n·ln a	arguments known positive (n real)
trig	sin(a + b) → sin a cos b + cos a sin b, …	none
deep	also expand inside function arguments	—

Examples

use symplex::prelude::*;
use symplex::macros::ExpandOpts;

let ctx = Context::new();
let (x, y) = (ctx.symbol("x"), ctx.symbol("y"));
let expr = (&x * &y).ln();
// Default: logs are not expanded.
assert_eq!(format!("{}", expr.expand_with(&ExpandOpts::default())), "ln(x*y)");
// With `log` + `force` the identity is applied unconditionally.
let opts = ExpandOpts::default().log(true).force(true);
assert_eq!(format!("{}", expr.expand_with(&opts)), "ln(x) + ln(y)");

Fields

mul: bool

Distribute products over sums (default true).

multinomial: bool

Expand non-negative integer powers of sums (default true).

power_base: bool

Distribute powers over products, (x·y)^e → x^e·y^e (default true, guarded).

power_exp: bool

Split sums in exponents, x^(a+b) → x^a·x^b (default true, guarded).

log: bool

Expand logarithms of products / powers (default false, guarded).

trig: bool

Expand trigonometric functions of sums and multiples (default false).

deep: bool

Recurse into function arguments (default true). When false, only the algebraic skeleton reachable through Add/Mul/Pow from the root is expanded.

force: bool

Apply the guarded rewrites unconditionally (default false).

Implementations

impl ExpandOpts

pub fn none() -> Self

No hints enabled (only deep); combine with the builder methods.

pub fn all() -> Self

Every hint enabled (still guarded unless force).

pub fn with_mul(self, v: bool) -> Self

Builder: set mul.

pub fn multinomial(self, v: bool) -> Self

Builder: set multinomial.

pub fn power_base(self, v: bool) -> Self

Builder: set power_base.

pub fn power_exp(self, v: bool) -> Self

Builder: set power_exp.

pub fn log(self, v: bool) -> Self

Builder: set log.

pub fn trig(self, v: bool) -> Self

Builder: set trig.

pub fn deep(self, v: bool) -> Self

Builder: set deep.

pub fn force(self, v: bool) -> Self

Builder: set force.

Trait Implementations

impl Clone for ExpandOpts

fn clone(&self) -> ExpandOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ExpandOpts

impl Debug for ExpandOpts

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

Formats the value using the given formatter.

impl Default for ExpandOpts

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ExpandOpts

impl PartialEq for ExpandOpts

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ExpandOpts