NAME
Math::Symbolic::Custom::ToShorterString - Shorter string representations of Math::Symbolic trees
VERSION
Version 0.2
SYNOPSIS
use Math::Symbolic 0.613 qw(:all);
use Math::Symbolic::Custom::ToShorterString 0.2;
# Note: ToShorterString v0.2 automatically adds ln(x) as an alias for log(e,x) in the parser
my $f = parse_from_string("1*2+3*4+5*sqrt(x+y+z)+ln(y)");
# Try displaying with Math::Symbolic's to_string()
my $to_string = $f->to_string();
print "to_string():\t$to_string\n";
# to_string(): (((1 * 2) + (3 * 4)) + (5 * (((x + y) + z) ^ 0.5))) + (log(2.71828182845905, y))
# Try displaying with ToShorterString
my $to_shorter_infix_string = $f->to_shorter_infix_string();
print "to_shorter_infix_string():\t$to_shorter_infix_string\n";
# to_shorter_infix_string(): ((1*2 + 3*4) + (5*sqrt(x + y + z))) + ln(y)
# Check that the two output string representations parse to the same expression
my $f2 = parse_from_string($to_string);
my $f3 = parse_from_string($to_shorter_infix_string);
if ( $f2->to_string() eq $f3->to_string() ) {
print "Parsed to same string\n";
}DESCRIPTION
Provides to_shorter_infix_string() through the Math::Symbolic module extension class. "to_shorter_infix_string()" attempts to provide a string representation of a Math::Symbolic tree that is shorter and therefore more readable than the existing (infix) to_string() method.
The "to_string()" method wraps every branch in parentheses/brackets, which makes larger expressions difficult to read. "to_shorter_infix_string()" tries to determine whether parentheses are required and omits them. One of the goals of this module is that the output string should parse to a Math::Symbolic tree that is (at least numerically) equivalent to the original expression - even if the resulting Math::Symbolic tree might not be completely identical to the original (for that, use "to_string()"). Where appropriate, it produces strings containing the Math::Symbolic parser aliases sqrt() and exp().
From v0.2, the module uses Math::SymbolicX::ParserExtensionFactory to automatically add ln(x) as an alias for log(e,x) in the parser, and uses it for string output as well (in the same way as sqrt() and exp()).
The "to_shorter_infix_string()" does not replace the "to_string()" method, it has to be called explicitly.
SEE ALSO
AUTHOR
Matt Johnson, <mjohnson at cpan.org>
ACKNOWLEDGEMENTS
Steffen Mueller, author of Math::Symbolic
LICENSE AND COPYRIGHT
This software is copyright (c) 2024 by Matt Johnson.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.