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