/ 
Math-GSL-0.43
River stage one • 6 direct dependents • 9 total dependents
/ Math::GSL::NTuple

NAME

Math::GSL::NTuple - Functions for creating and manipulating ntuples, sets of values

SYNOPSIS

This module is partially implemented. Patches Welcome!

use Math::GSL::NTuple qw /:all/;

DESCRIPTION

Here is a list of all the functions in this module :

  • <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.

  • <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.

  • <gsl_ntuple_write($ntuple)>

    This function writes the current $ntuple $ntuple->{ntuple_data} of size $ntuple->{size} to the corresponding file.

  • <gsl_ntuple_bookdata($ntuple)>

    This function is a synonym for gsl_ntuple_write.

  • <gsl_ntuple_read($ntuple)>

    This function reads the current row of the ntuple file for ntuple and stores the values in $ntuple->{data}.

  • <gsl_ntuple_project()>

  • <gsl_ntuple_close($ntuple)>

    This function closes the ntuple file ntuple and frees its associated allocated memory.

For more informations on the functions, we refer you to the GSL official documentation: http://www.gnu.org/software/gsl/manual/html_node/

AUTHORS

Jonathan "Duke" Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>

COPYRIGHT AND LICENSE

Copyright (C) 2008-2021 Jonathan "Duke" Leto and Thierry Moisan

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.