The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Math-Bacovia-0.04
River stage zero No dependents
/ Math::Bacovia::Symbol

NAME

Math::Bacovia::Symbol - Represents a symbolic value.

SYNOPSIS

use 5.014;
use Math::Bacovia qw(Symbol);

my $x = Symbol('x');
my $y = Symbol('y', 64);

say $y->numeric;           #=> 64
say $y->sqrt->numeric;     #=> 8
say (($x + $y)->pretty);   #=> (x + y)

foreach my $n (1..5) {
    $x->set($n);
    say "sinh(log($n)) = ", $x->log->sinh->simple->numeric;
}

METHODS

This section describes the methods provided by the Math::Bacovia::Symbol module.

new

my $x = Math::Bacovia::Symbol->new("x");
my $y = Math::Bacovia::Symbol->new("y", $value);

Constructs and returns a new Math::Bacovia::Symbol object.

set

$obj->set($value);

Assigns a (numerical) value to the symbolic self-object.

get

my ($name, $value) = $obj->get;

Returns the name and the internal value of the self-object (if any).

eq

$x == $y
$x->eq($y)

Return a true value when x and y are symbolically equal.

SPECIAL METHODS

This section describes the special methods provided by the Math::Bacovia::Symbol module.

pretty

my $str = $obj->pretty;

Returns a human-readable stringification of the self-expression.

stringify

my $str = $obj->stringify;

Returns a stringification of the self-expression.

numeric

my $num = $obj->numeric;

Evaluates the self-expression numerically and returns a Math::AnyNum object.

SEE ALSO

The other parts of Math::Bacovia:

AUTHOR

Daniel Șuteu, <trizen at protonmail.com>

BUGS

Please report any bugs or feature requests to https://github.com/trizen/Math-Bacovia. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Math::Bacovia::Symbol

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2017-2018 Daniel Șuteu.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.