XS.xs

   1 #include "EXTERN.h"
   2 #include "perl.h"
   3 #include "XSUB.h"
   4
   5 #include "ppport.h"
   6
   7 #include "const-c.inc"
   8
   9 MODULE = Math::Vector::XS               PACKAGE = Math::Vector::XS
  10
  11 INCLUDE: const-xs.inc
  12
  13 #-- CONSTRUCTORS
  14
  15 #
  16 # my $vec = Math::Vector::XS->new( \@numbers );
  17 #
  18 # Create a new vector. The only argument is a reference to an array containing
  19 # numbers, used to fill in the vector. The dimension of the newly created
  20 # vector is determined by the length of this array.
  21 #
  22 SV *
  23 new( class, values )
  24         char* class;
  25         AV*   values;
  26
  27         INIT:
  28             AV*  self;
  29             I32  i;
  30             SV** orig;
  31             SV*  clone;
  32             HV*  stash;
  33
  34         CODE:
  35             /* create the object and populate it */
  36             self = newAV();
  37             for ( i=0; i<=av_len(values); i++ ) {
  38                 orig  = av_fetch(values, i, 0);
  39                 clone = newSViv( SvIV(*orig) );
  40                 av_push(self, clone);
  41             }
  42
  43             /* Return a blessed reference to the AV */
  44             RETVAL = newRV_noinc( (SV *)self );
  45             stash  = gv_stashpv( class, TRUE );
  46             sv_bless( (SV *)RETVAL, stash );
  47
  48         OUTPUT:
  49             RETVAL
  50
  51
  52 #
  53 # my $vec = Math::Vector::XS->new_zeroes( dimension );
  54 #
  55 # Create a new vector, set to the origin. The only argument is the dimension of
  56 # the vector to be created.
  57 #
  58 # ->new_zeroes(2) is exactly equivalent to ->new([0,0])
  59 #
  60 SV *
  61 new_zeroes( class, dimension )
  62         char* class;
  63         I32   dimension;
  64
  65         INIT:
  66             AV*  self;
  67             I32  i;
  68             SV*  zero;
  69             HV*  stash;
  70
  71         CODE:
  72             /* create the object and populate it */
  73             self = newAV();
  74             for ( i=0; i<dimension; i++ ) {
  75                 zero = newSViv(0);
  76                 av_push(self, zero);
  77             }
  78
  79             /* return a blessed reference to the AV */
  80             RETVAL = newRV_noinc( (SV *)self );
  81             stash  = gv_stashpv( class, TRUE );
  82             sv_bless( (SV *)RETVAL, stash );
  83
  84         OUTPUT:
  85             RETVAL
  86
  87
  88 #-- PUBLIC METHODS
  89
  90
  91 #
  92 # my $dims = $vec->get_dims;
  93 #
  94 # Return the number of dimensions, an integer.
  95 #
  96 I32
  97 get_dims( self )
  98         AV* self
  99
 100     CODE:
 101         RETVAL = av_len(self) + 1;
 102
 103     OUTPUT:
 104         RETVAL
 105
 106 #
 107 # my $val = $vec->get_component( $index );
 108 #
 109 # Return the value for dimension $index.
 110 #
 111 I32
 112 get_component( self, index )
 113         AV* self
 114         I32 index
 115
 116     INIT:
 117         SV** val;
 118
 119     CODE:
 120         val = av_fetch(self, index, 0);
 121         RETVAL = SvIV(*val);
 122
 123     OUTPUT:
 124         RETVAL
 125
 126
 127
 128