.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Math::Symbolic::Custom::DefaultTests 3pm"
.TH Math::Symbolic::Custom::DefaultTests 3pm "2021-01-07" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Math::Symbolic::Custom::DefaultTests \- Default Math::Symbolic tree tests
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Math::Symbolic;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a class of default tests for Math::Symbolic trees. Likewise,
Math::Symbolic::Custom::DefaultMods defines default tree transformation
routines.
For details on how the custom method delegation model works, please have
a look at the Math::Symbolic::Custom and Math::Symbolic::Custom::Base
classes.
.SS "\s-1EXPORT\s0"
.IX Subsection "EXPORT"
Please see the docs for Math::Symbolic::Custom::Base for details, but
you should not try to use the standard Exporter semantics with this
class.
.SH "SUBROUTINES"
.IX Header "SUBROUTINES"
.SS "\fBis_zero()\fP"
.IX Subsection "is_zero()"
Returns true (1) of the tree is a constant and '0'. Returns
false (0) otherwise.
.SS "\fBis_one()\fP"
.IX Subsection "is_one()"
Returns true (1) of the tree is a constant and '1'. Returns
false (0) otherwise.
.SS "\fBis_zero_or_one()\fP"
.IX Subsection "is_zero_or_one()"
Returns true ('1' for 1, '0E0' for 0) of the tree is a constant and '1' or '0'.
Returns false (0) otherwise.
.SS "\fBis_integer()\fP"
.IX Subsection "is_integer()"
\&\fBis_integer()\fR returns a boolean.
.PP
It returns true (1) if the tree is a constant object representing an
integer value. It does \fInot\fR compute the value of the tree.
(eg. '5*10' is \fInot\fR considered an integer, but '50' is.)
.PP
It returns false (0) otherwise.
.SS "\fBis_simple_constant()\fP"
.IX Subsection "is_simple_constant()"
\&\fBis_simple_constant()\fR returns a boolean.
.PP
It returns true if the tree consists of only constants and operators.
As opposed to \fBis_constant()\fR, \fBis_simple_constant()\fR does not apply derivatives
if necessary.
.PP
It returns false (0) otherwise.
.SS "\fBis_constant()\fP"
.IX Subsection "is_constant()"
\&\fBis_constant()\fR returns a boolean.
.PP
It returns true (1) if the tree consists of only constants and operators or
if it becomes a tree of only constants and operators after application
of derivatives.
.PP
It returns false (0) otherwise.
.PP
If you need not pay the price of applying derivatives, you should use the
\&\fBis_simple_constant()\fR method instead.
.SS "\fBis_identical()\fP"
.IX Subsection "is_identical()"
\&\fBis_identical()\fR returns a boolean.
.PP
It compares the tree it is called on to its first argument. If the first
argument is not a Math::Symbolic tree, it is sent through the parser.
.PP
\&\fBis_identical()\fR returns true (1) if the trees are completely identical. That
includes operands of commutating operators having the same order, etc. This
does \fInot\fR test of mathematical equivalence! (Which is \fBmuch, much\fR harder
to test for. If you know how to, \fIplease\fR let me know!)
.PP
It returns false (0) otherwise.
.SS "is_identical_base"
.IX Subsection "is_identical_base"
\&\fBis_identical_base()\fR returns a boolean.
.PP
It compares the tree it is called on to its first argument. If the first
argument is not a Math::Symbolic tree, it is sent through the parser.
.PP
\&\fBis_identical_base()\fR returns true (1) if the trees are identical or
if they are exponentiations with the same base. The same gotchas that
apply to is_identical apply here, too.
.PP
For example, 'x*y' and '(x*y)^e' result in a true return value because
\&'x*y' is equal to '(x*y)^1' and this has the same base as '(x*y)^e'.
.PP
It returns false (0) otherwise.
.SS "\fBis_sum()\fP"
.IX Subsection "is_sum()"
(beta)
.PP
\&\fBis_constant()\fR returns a boolean.
.PP
It returns true (1) if the tree contains no variables (because it can then
be evaluated to a single constant which is a sum). It also returns true if
it is a sum or difference of constants and variables. Furthermore, it is
true for products of integers and constants because those products are really
sums of variables.
If none of the above cases match, it applies all derivatives and tries again.
.PP
It returns false (0) otherwise.
.PP
Please contact the author in case you encounter bugs in the specs or
implementation. The heuristics aren't all that great.
.SS "\fBtest_num_equiv()\fP"
.IX Subsection "test_num_equiv()"
Takes another Math::Symbolic tree or a code ref as first
argument. Tests the tree
it is called on and the one passed in as first argument for
equivalence by sampling random numbers for their parameters and
evaluating them.
.PP
This is no guarantee that the functions are actually similar. The
computation required for this test may be very high for large
numbers of tests.
.PP
In case of a subroutine reference passed in, the values of the
parameters of the Math::Symbolic tree are passed to the sub
ref sorted by the parameter names.
.PP
Following the test-tree, there may be various options as key/value
pairs:
.PP
.Vb 10
\&  limits: A hash reference with parameter names as keys and code refs
\&          as arguments. A code ref for parameter \*(Aqx\*(Aq, will be executed
\&          for every number of \*(Aqx\*(Aq that is generated. If the code
\&          returns false, the number is discarded and regenerated.
\&  tests:  The number of tests to carry out. Default: 20
\&  epsilon: The accuracy of the numeric comparison. Default: 1e\-7
\&  retries: The number of attempts to make if a function evaluation
\&           throws an error.
\&  upper:   Upper limit of the random numbers. Default: 10
\&  lower:   Lower limit of the random numbers. Default: \-10
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Please send feedback, bug reports, and support requests to the Math::Symbolic
support mailing list:
math-symbolic-support at lists dot sourceforge dot net. Please
consider letting us know how you use Math::Symbolic. Thank you.
.PP
If you're interested in helping with the development or extending the
module's functionality, please contact the developers' mailing list:
math-symbolic-develop at lists dot sourceforge dot net.
.PP
List of contributors:
.PP
.Vb 3
\&  Steffen MXller, symbolic\-module at steffen\-mueller dot net
\&  Stray Toaster, mwk at users dot sourceforge dot net
\&  Oliver EbenhXh
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
New versions of this module can be found on
http://steffen\-mueller.net or \s-1CPAN.\s0 The module development takes place on
Sourceforge at http://sourceforge.net/projects/math\-symbolic/
.PP
Math::Symbolic::Custom
Math::Symbolic::Custom::DefaultDumpers
Math::Symbolic::Custom::DefaultMods
Math::Symbolic