lib/Language/Befunge/Vector/XS.pm

   1 #
   2 # This file is part of Language::Befunge::Vector::XS.
   3 # Copyright (c) 2008 Jerome Quelin, all rights reserved.
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the same terms as Perl itself.
   7 #
   8 #
   9
  10 package Language::Befunge::Vector::XS;
  11
  12 use strict;
  13 use warnings;
  14
  15 use overload
  16         '='   => \&copy,
  17         '+'   => \&_add,
  18         '-'   => \&_substract,
  19         'neg' => \&_invert,
  20         '+='  => \&_add_inplace,
  21     '-='  => \&_substract_inplace,
  22         '<=>' => \&_compare,
  23         '""'  => \&as_string;
  24
  25 our $VERSION = '1.0.0';
  26
  27 require XSLoader;
  28 XSLoader::load('Language::Befunge::Vector::XS', $VERSION);
  29
  30 # Preloaded methods go here.
  31
  32 sub as_string {
  33     my $self = shift;
  34     local $" = ',';
  35     return "(@$self)";
  36 }
  37
  38
  39 1;
  40 __END__
  41
  42 =head1 NAME
  43
  44 Language::Befunge::Vector::XS - Language::Befunge::Vector rewritten for speed
  45
  46
  47
  48 =head1 DESCRIPTION
  49
  50 The C<Language::Befunge> module makes heavy use of n-dims vectors,
  51 mapped to the C<Language::Befunge::Vector> class. This allows to
  52 abstract the funge dimension while still keeping the same code for the
  53 operations.
  54
  55 However, such an heavy usage does have some impact on the performances.
  56 Therefore, this modules is basically a rewrite of LBV in XS. If
  57 installed, then LBV will automagically load it and replace its own
  58 functions with the XS ones.
  59
  60
  61
  62 =head1 METHODS
  63
  64 This module implements exactly the same api as LBV. Please refer to this
  65 module for more information on the following methods:
  66
  67 =over 4
  68
  69 =item new()
  70
  71 =item new_zeroes()
  72
  73 =item copy()
  74
  75 =item as_string()
  76
  77 =item get_dims()
  78
  79 =item get_component()
  80
  81 =item get_all_components()
  82
  83 =item clear()
  84
  85 =item set_component()
  86
  87 =item bounds_check()
  88
  89 =item rasterize()
  90
  91 =item standard mathematical operations
  92
  93 =item inplace mathematical operations
  94
  95 =item comparison operations
  96
  97 =back
  98
  99
 100 =head1 SEE ALSO
 101
 102 L<Language::Befunge::Vector>
 103
 104
 105 =head1 AUTHOR
 106
 107 Jerome Quelin, E<lt>jquelin@cpan.orgE<gt>
 108
 109 Development is discussed on E<lt>language-befunge@mongueurs.netE<gt>
 110
 111
 112 =head1 COPYRIGHT & LICENSE
 113
 114 Copyright (c) 2008 Jerome Quelin, all rights reserved.
 115
 116 This program is free software; you can redistribute it and/or modify
 117 it under the same terms as Perl itself.
 118
 119
 120 =cut
 121