2 # This file is part of Language::Befunge::Vector::XS.
3 # Copyright (c) 2008 Jerome Quelin, all rights reserved.
5 # This program is free software; you can redistribute it and/or modify
6 # it under the same terms as Perl itself.
10 package Language
::Befunge
::Vector
::XS
;
20 '+=' => \
&_add_inplace
,
21 '-=' => \
&_substract_inplace
,
25 our $VERSION = '0.1.1';
28 XSLoader
::load
('Language::Befunge::Vector::XS', $VERSION);
30 # Preloaded methods go here.
38 #sub copy { my $vec = shift; return bless [@$vec], ref $vec; }
39 sub bounds_check {$_[0]}
46 Language::Befunge::Vector::XS - an opaque, N-dimensional vector class.
52 my $v1 = Language::Befunge::Vector::XS->new($x, $y, ...);
53 my $v2 = Language::Befunge::Vector::XS->new_zeroes($dims);
59 This class abstracts normal vector manipulation. It lets you pass
60 around one argument to your functions, rather than N arguments, one
61 per dimension. This means much of your code doesn't have to care
62 how many dimensions you're working with.
64 You can do vector arithmetic, test for equality, or even stringify
65 the vector to a string like I<"(1,2,3)">.
67 It has exactly the same api as C<Language::Befunge::Vector>, but LBVXS
68 is written in XS for speed reasons.
73 =head2 my $vec = LBV::XS->new( $x [, $y, ...] )
75 Create a new vector. The arguments are the actual vector data; one
76 integer per dimension.
79 =head2 my $vec = LBV::XS->new_zeroes($dims);
81 Create a new vector of dimension C<$dims>, set to the origin (all zeroes). C<<
82 LBV->new_zeroes(2) >> is exactly equivalent to B<< LBV->new(0,0) >>.
85 =head2 my $vec = $v->copy;
87 Return a new LBV object, which has the same dimensions and coordinates
94 =head2 my $str = $vec->as_string;
96 Return the stringified form of C<$vec>. For instance, a Befunge vector
97 might look like C<(1,2)>.
99 This method is also applied to stringification, ie when one forces
100 string context (C<"$vec">).
103 =head2 my $dims = $vec->get_dims;
105 Return the number of dimensions, an integer.
108 =head2 my $val = $vec->get_component($dim);
110 Get the value for dimension C<$dim>.
113 =head2 my @vals = $vec->get_all_components;
115 Get the values for all dimensions, in order from 0..N.
120 Set the vector back to the origin, all 0's.
123 =head2 $vec->set_component($dim, $value);
125 Set the value for dimension C<$dim> to C<$value>.
128 =head2 my $is_within = $vec->bounds_check($begin, $end);
130 Check whether C<$vec> is within the box defined by C<$begin> and C<$end>.
131 Return 1 if vector is contained within the box, and 0 otherwise.
135 =head1 MATHEMATICAL OPERATIONS
137 =head2 Standard operations
139 One can do some maths on the vectors. Addition and substraction work as
145 Either operation return a new LBV object, which is the result of C<$v1>
148 The inversion is also supported:
151 will subtracts C<$v1> from the origin, and effectively, gives the
152 inverse of the original vector. The new vector is the same distance from
153 the origin, in the opposite direction.
156 =head2 Inplace operations
158 LBV objects also supports inplace mathematical operations:
163 effectively adds / substracts C<$v2> to / from C<$v1>, and stores the
164 result back into C<$v1>.
169 Finally, LBV objects can be tested for equality, ie whether two vectors
170 both point at the same spot.
172 print "same
" if $v1 == $v2;
173 print "differ
" if $v1 != $v2;
178 L<Language::Befunge::Vector>
183 Jerome Quelin, E<lt>jquelin@cpan.orgE<gt>
185 Development is discussed on E<lt>language-befunge@mongueurs.netE<gt>
188 =head1 COPYRIGHT & LICENSE
190 Copyright (c) 2008 Jerome Quelin, all rights reserved.
192 This program is free software; you can redistribute it and/or modify
193 it under the same terms as Perl itself.