Math::...::Base(3pm)

πŸ’… Math::Symbolic::Custom::Base β€” the tea β˜•

okay bestie, welcome to Math::Symbolic::Custom::Base(3pm) 🫢 this is the base class for tree tests and transformations, and yes it's giving "I'm the scaffolding your cute little custom module stands on." Let's get into it ✨


🌸 NAME 🌸

Math::Symbolic::Custom::Base β€” the base class for tree tests and transformations. she's foundational, she's iconic, she's the blueprint πŸ’–


✨ SYNOPSIS ✨

so like, you know how you'd extend the Math::Symbolic::Custom class? yeah. here's exactly how, no cap:

# Extending the Math::Symbolic::Custom class:
package Math::Symbolic::Custom::MyTransformations;
use Math::Symbolic::Custom::Base;
BEGIN {*import = \&Math::Symbolic::Custom::Base::aggregate_import}

our $Aggregate_Export = [qw/apply_transformation1 .../];
sub apply_transformation1 {
   # ...
}

that BEGIN block is doing main character energy work, pls respect it πŸ™ˆ


πŸ¦‹ DESCRIPTION πŸ¦‹

okay so, real talk: this is a base class for your extensions to the Math::Symbolic::Custom class. literally it exists so you can go off and do your own thing without breaking everything. periodt.

to extend the class, just use the following template for your custom class, mmkay? πŸ’œ

package Math::Symbolic::Custom::MyTransformations;

use Math::Symbolic::Custom::Base;
BEGIN {*import = \&Math::Symbolic::Custom::Base::aggregate_import}

our $Aggregate_Export = [...]; # exported subroutines listed here.

# Now implement the subroutines.
# Exported subroutine names must start with 'apply_', 'mod_',
# 'is_', 'test_', 'contains_', or 'to_'

# ...

1;

heads up bestie: those exported subroutine names must start with 'apply_', 'mod_', 'is_', 'test_', 'contains_', or 'to_' β€” that's the vibe check your names have to pass πŸ‘‘

πŸŽ€ EXPORT πŸŽ€

uses a custom exporter implementation to export certain routines from the invoking namespace over to the Math::Symbolic::Custom namespace. but... nevermind. πŸ’€

((yes that's really what it says. she said "nevermind." and moved on. respect.))


πŸ’– SUBROUTINES πŸ’–

⭐ aggregate_import

aggregate_import() is the only public subroutine defined by Math::Symbolic::Custom::Base, and she should only be called in BEGIN blocks β€” like the one shown in the SYNOPSIS up there ☝️ don't be calling her anywhere else, that's not her moment πŸ™ˆ


🫢 AUTHOR 🫢

pls pls pls send feedback, bug reports, and support requests to the Math::Symbolic support mailing list: math-symbolic-support at lists dot sourceforge dot net 🌈 also, if you could let them know how you use Math::Symbolic, that would be so sweet. thank you!! πŸ’–

if you're interested in helping with the development or extending the module's functionality, hit up the developers' mailing list: math-symbolic-develop at lists dot sourceforge dot net πŸ’…

list of contributors, icons only:

Steffen MοΏ½ller, symbolic-module at steffen-mueller dot net
Stray Toaster, mwk at users dot sourceforge dot net
Oliver EbenhοΏ½h

🌟 SEE ALSO 🌟

new versions of this module can be found on http://steffen-mueller.net or CPAN πŸ¦‹ the module development takes place on Sourceforge at http://sourceforge.net/projects/math-symbolic/ ✨

also go look at Math::Symbolic obviously, she's the moment πŸ’…


and that's the whole page bestie πŸ’œ this was Math::Symbolic::Custom::Base(3pm) from perl v5.40.0, dated 2024-09-16 β€” mwah, no notes, she ate πŸ”₯πŸŽ€πŸ‘‘

πŸ“¦ where this page comes from