pod/NTuple.pod

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