NTuple.i

   1 %module "Math::GSL::NTuple"
   2
   3 %typemap(in) void * {
   4     $1 = (double *) $input;
   5 };
   6
   7 %typemap(argout) void * {
   8     //Perl_sv_dump($1);
   9 }
  10
  11 %{
  12     #include "gsl/gsl_ntuple.h"
  13 %}
  14
  15 %include "gsl/gsl_ntuple.h"
  16
  17
  18 %perlcode %{
  19
  20 # Intermittent failure happens *after* this
  21 END { warn "This is the end" }
  22
  23
  24 @EXPORT_OK = qw/
  25                gsl_ntuple_open
  26                gsl_ntuple_create
  27                gsl_ntuple_write
  28                gsl_ntuple_read
  29                gsl_ntuple_bookdata
  30                gsl_ntuple_project
  31                gsl_ntuple_close
  32              /;
  33 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  34
  35 __END__
  36
  37 =head1 NAME
  38
  39 Math::GSL::NTuple - Functions for creating and manipulating ntuples, sets of values associated with events
  40
  41 =head1 SYNOPSIS
  42
  43 This module is partially implemented. Patches Welcome!
  44
  45     use Math::GSL::NTuple qw /:all/;
  46
  47 =head1 DESCRIPTION
  48
  49 Here is a list of all the functions in this module :
  50
  51 =over
  52
  53 =item * <gsl_ntuple_open($filename, $ntuple_data, $size)> - This function opens an existing ntuple file $filename for reading and returns a pointer to a corresponding ntuple struct. The ntuples in the file must have size $size. A pointer to memory for the current ntuple row $ntuple_data, which is an array reference, must be supplied—this is used to copy ntuples in and out of the file.
  54
  55 =item * <gsl_ntuple_create > - This function creates a new write-only ntuple file $filename for ntuples of size $size and returns a pointer to the newly created ntuple struct. Any existing file with the same name is truncated to zero length and overwritten. A pointer to memory for the current ntuple row $ntuple_data, which is an array reference, must be supplied—this is used to copy ntuples in and out of the file.
  56
  57
  58 =item * <gsl_ntuple_write($ntuple)> - This function writes the current $ntuple $ntuple->{ntuple_data} of size $ntuple->{size} to the corresponding file.
  59
  60 =item * <gsl_ntuple_bookdata($ntuple)> - This function is a synonym for gsl_ntuple_write.
  61
  62 =item * <gsl_ntuple_read($ntuple)> - This function reads the current row of the ntuple file for ntuple and stores the values in $ntuple->{data}.
  63
  64 =item * <gsl_ntuple_project >
  65
  66 =item * <gsl_ntuple_close($ntuple)> - This function closes the ntuple file ntuple and frees its associated allocated memory.
  67
  68 =back
  69
  70 For more informations on the functions, we refer you to the GSL offcial
  71 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
  72
  73  Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
  74
  75
  76 =head1 AUTHORS
  77
  78 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
  79
  80 =head1 COPYRIGHT AND LICENSE
  81
  82 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
  83
  84 This program is free software; you can redistribute it and/or modify it
  85 under the same terms as Perl itself.
  86
  87 =cut
  88
  89 %}