Skip to content

michal-josef-spacek/PYX-Optimization

Repository files navigation

NAME
    PYX::Optimization - PYX optimization Perl class.

SYNOPSIS
     use PYX::Optimization;

     my $obj = PYX::Optimization->new(%parameters);
     $obj->parse($pyx, $out);
     $obj->parse_file($pyx_file, $out);
     $obj->parse_handler($pyx_file_handler, $out);

METHODS
  "new"
     my $obj = PYX::Optimization->new(%parameters);

    Constructor.

    *       "output_encoding"

            Output encoding. Default value is 'utf-8'.

    *       "output_handler"

            Output handler. Default value is STDOUT.

    Returns instance of object.

  "parse"
     $obj->parse($pyx, $out);

    Optimize PYX defined by string $pyx. Output print to output handler. If
    $out not present, use 'output_handler'.

    Returns undef.

  "parse_file"
     $obj->parse_file($pux_file, $out);

    Optimize PYX defined by file $pyx_file. Output print to output handler.
    If $out not present, use 'output_handler'.

    Returns undef.

  "parse_handler"
     $obj->parse_handler($pyx_file_handler, $out);

    Optimize PYX defined by file handler $pyx_file_handler. Output print to
    output handler. If $out not present, use 'output_handler'.

    Returns undef.

ERRORS
     new():
             From Class::Utils::set_params():
                     Unknown parameter '%s'.

EXAMPLE1
     use strict;
     use warnings;

     use PYX::Optimization;

     # Content.
     my $pyx_to_optimize = <<'END';
     (element
     - data \n data
     )element
     _       comment
     (element
     -                                 \n foo
     )element
     END

     PYX::Optimization->new->parse($pyx_to_optimize);

     # Output:
     # (element
     # -data data
     # )element
     # _comment
     # (element
     # -foo
     # )element

EXAMPLE2
     use strict;
     use warnings;

     use PYX::Optimization;

     if (@ARGV < 1) {
             print STDERR "Usage: $0 pyx_file\n";
             exit 1;
     }
     my $pyx_file = $ARGV[0];

     PYX::Optimization->new->parse_file($pyx_file);

     # Output:
     # Usage: __SCRIPT__ pyx_file

DEPENDENCIES
    Class::Utils, Encode, Error::Pure, PYX, PYX::Parser, PYX::Utils.

SEE ALSO
    Task::PYX
        Install the PYX modules.

REPOSITORY
    <https://github.com/michal-josef-spacek/PYX-Optimization>

AUTHOR
    Michal Josef Špaček <mailto:skim@cpan.org>

    <http://skim.cz>

LICENSE AND COPYRIGHT
    © 2011-2023 Michal Josef Špaček

    BSD 2-Clause License

VERSION
    0.07

About

PYX optimization Perl class.

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published