NTuple.i

   1 %module "Math::GSL::NTuple"
   2 %include "typemaps.i"
   3
   4 %typemap(in) void * {
   5     $1 = (double *) $input;
   6 };
   7
   8 %{
   9     #include "gsl/gsl_ntuple.h"
  10 %}
  11
  12 %include "gsl/gsl_ntuple.h"
  13
  14 //%apply double * OUTPUT {
  15
  16 %perlcode %{
  17 @EXPORT_OK = qw/
  18                gsl_ntuple_open
  19                gsl_ntuple_create
  20                gsl_ntuple_write
  21                gsl_ntuple_read
  22                gsl_ntuple_bookdata
  23                gsl_ntuple_project
  24                gsl_ntuple_close
  25              /;
  26 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  27
  28 __END__
  29
  30 =head1 NAME
  31
  32 Math::GSL::NTuple - Functions for creating and manipulating ntuples, sets of values associated with events
  33
  34 =head1 SYNOPSIS
  35
  36 This module is not yet implemented. Patches Welcome!
  37
  38 use Math::GSL::NTuple qw /:all/;
  39
  40 =head1 DESCRIPTION
  41
  42 Here is a list of all the functions in this module :
  43
  44 =over
  45
  46 =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.
  47
  48 =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.
  49
  50
  51 =item * <gsl_ntuple_write($ntuple)> - This function writes the current $ntuple $ntuple->{ntuple_data} of size $ntuple->{size} to the corresponding file.
  52
  53 =item * <gsl_ntuple_bookdata($ntuple)> - This function is a synonym for gsl_ntuple_write.
  54
  55 =item * <gsl_ntuple_read($ntuple)> - This function reads the current row of the ntuple file for ntuple and stores the values in $ntuple->{data}.
  56
  57 =item * <gsl_ntuple_project >
  58
  59 =item * <gsl_ntuple_close($ntuple)> - This function closes the ntuple file ntuple and frees its associated allocated memory.
  60
  61 =back
  62
  63 For more informations on the functions, we refer you to the GSL offcial
  64 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
  65
  66  Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
  67
  68
  69 =head1 AUTHORS
  70
  71 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
  72
  73 =head1 COPYRIGHT AND LICENSE
  74
  75 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
  76
  77 This program is free software; you can redistribute it and/or modify it
  78 under the same terms as Perl itself.
  79
  80 =cut
  81
  82 %}