The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Math::Symbolic::Base - Base class for symbols in symbolic calculations

SYNOPSIS

  use Math::Symbolic::Base;

DESCRIPTION

This is a base class for all Math::Symbolic::* terms such as Math::Symbolic::Operator, Math::Symbolic::Variable and Math::Symbolic::Constant objects.

EXPORT

None by default.

METHODS

Method to_string

Default method for stringification just returns the object's value.

Method value

value() evaluates the Math::Symbolic tree to its numeric representation.

value() without arguments requires that every variable in the tree contains a defined value attribute. Please note that this refers to every variable object, not just every named variable.

value() with one argument sets the object's value.

value() with named arguments (key/value pairs) associates variables in the tree with the value-arguments if the corresponging key matches the variable name. (Can one say this any more complicated?)

Example: $tree->value(x => 1, y => 2, z => 3, t => 0) assigns the value 1 to any occurrances of variables of the name "x", aso.

Method set_value

set_value() returns nothing.

set_value() requires named arguments (key/value pairs) that associate variable names of variables in the tree with the value-arguments if the corresponging key matches the variable name. (Can one say this any more complicated?)

Example: $tree->set_value(x => 1, y => 2, z => 3, t => 0) assigns the value 1 to any occurrances of variables of the name "x", aso.

As opposed to value(), set_value() assigns to the variables permanently and does not evaluate the tree.

Method signature

signature() returns a tree's signature.

In the context of Math::Symbolic, signatures are the list of variables any given tree depends on. That means the tree "v*t+x" depends on the variables v, t, and x. Thus, applying signature() on the tree that would be parsed from above example yields the sorted list ('t', 'v', 'x').

Constants do not depend on any variables and therefore return the empty list. Obviously, operators' dependencies vary.

Math::Symbolic::Variable objects, however, may have a slightly more involved signature. By convention, Math::Symbolic variables depend on themselves. That means their signature contains their own name. But they can also depend on various other variables because variables themselves can be viewed as placeholders for more compicated terms. For example in mechanics, the acceleration of a particle depends on its mass and the sum of all forces acting on it. So the variable 'acceleration' would have the signature ('acceleration', 'force1', 'force2',..., 'mass', 'time').

Method set_signature

set_signature expects any number of variable identifiers as arguments. It sets a variable's signature to this list of identifiers.

Method implement

Takes key/value pairs as arguments. The keys are to be variable names and the values must be valid Math::Symbolic trees. All occurrances of the variables will be replaced with their implementation.

Method simplify

Minimum method for term simpilification just clones.

Method term_type

Returns the type of the term. This is a stub to be overridden.

AUTHOR

Steffen Mueller, <symbolic-module at steffen-mueller dot net>

New versions of this module can be found on http://steffen-mueller.net or CPAN.

SEE ALSO

Math::Symbolic