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::Constant - Constants in symbolic calculations

SYNOPSIS

  use Math::Symbolic::Constant;
  my $const = Math::Symbolic::Constant->new(25);
  my $zero  = Math::Symbolic::Constant->zero();
  my $one   = Math::Symbolic::Constant->one();
  my $euler = Math::Symbolic::Constant->euler();
  # e = 2.718281828...

DESCRIPTION

This module implements numeric constants for Math::Symbolic trees.

EXPORT

None by default.

METHODS

Constructor new

Takes hash reference of key-value pairs as argument. Special case: a value for the constant instead of the hash. Returns a Math::Symbolic::Constant.

Constructor zero

Arguments are treated as key-value pairs of object attributes. Returns a Math::Symbolic::Constant with value of 0.

Constructor one

Arguments are treated as key-value pairs of object attributes. Returns a Math::Symbolic::Constant with value of 1.

Constructor euler

Arguments are treated as key-value pairs of object attributes. Returns a Math::Symbolic::Constant with value of e, the Euler number. The object has its 'special' attribute set to 'euler'.

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 and for constants, it doesn't do anything either.

Generally, set_value() works like this:

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 special

Optional argument: sets the object's special attribute. Returns the object's special attribute.

Method to_string

Returns a string representation of the constant.

Method term_type

Returns the type of the term. (T_CONSTANT)

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