Math::...:NTuple(3pm)

📦
version 0.49 · 6 versions
, in ubuntu stonking

💖 Math::GSL::NTuple — the manual, but make it a group chat 💖

okay bestie, so this is Math::GSL::NTuple, a page from the User Contributed Perl Documentation. And what is it? It's Math::GSL::NTuple — functions for creating and manipulating ntuples, which are literally just sets of values. Think of an ntuple as a glow-up spreadsheet row that knows how to write itself to disk. Iconic behavior, honestly. 🦋

✨ NAME ✨

Math::GSL::NTuple — functions for creating and manipulating ntuples, sets of values. no cap, that's the whole job description. 💅

✨ SYNOPSIS ✨

bestie. bestie listen. This module is partially implemented. Patches Welcome! 🫶 that's not me being shady, that's the actual manpage talking, and honestly it's a whole invitation. come be the main character and write a patch.

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

✨ DESCRIPTION ✨

here's the whole rundown of every single function chilling in this module, in order, no skipping, no edits, we keep every fact:

  • <gsl_ntuple_open($filename, $ntuple_data, $size)>

this one opens an existing ntuple file $filename for reading, and hands you back a pointer to a corresponding ntuple struct. the ntuples in that file have to have size $size — that's the vibe check the file needs to pass. you also have to supply a pointer to memory for the current ntuple row, $ntuple_data, which is an array reference. what's it for? it's the lil scratch space used to copy ntuples in and out of the file. literally the clipboard of ntuples. 📋

  • <gsl_ntuple_create>

this one creates a new write-only ntuple file $filename for ntuples of size $size, and returns a pointer to the newly created ntuple struct. ⚠️ and here's the part where you gotta pay attention: any existing file with the same name is truncated to zero length and overwritten. gone. deleted. not even in the recycle bin. dramatic but true. also, just like above, you must supply a pointer to memory for the current ntuple row $ntuple_data, which is an array reference — that's the in-and-out copying buffer again. ✨

  • <gsl_ntuple_write($ntuple)>

writes the current $ntuple's $ntuple->{ntuple_data}, of size $ntuple->{size}, to the corresponding file. that's it. that's the whole function. she writes and she leaves. 💅

  • <gsl_ntuple_bookdata($ntuple)>

this is literally just a synonym for gsl_ntuple_write. same energy, different name. iykyk. 👑

  • <gsl_ntuple_read($ntuple)>

reads the current row of the ntuple file for ntuple, and stores the values in $ntuple->{data}. yes, it's $ntuple->{data} here, not $ntuple->{ntuple_data} — that's not a typo, that's what the page says, so we keep it exactly. 🔍

  • <gsl_ntuple_project()>

...and that's all she wrote, bestie. this bullet genuinely has no description attached. not my fault, not your fault, we simply report what's on the page. 🫠

  • <gsl_ntuple_close($ntuple)>

closes the ntuple file ntuple and frees its associated allocated memory. the responsible, hydrating, get-your-sleep goodbye. 🌸

if you want more info on the functions, the page points you to the GSL official documentation, right here: <http://www.gnu.org/software/gsl/manual/html_node/> 🌈

✨ AUTHORS ✨

shoutout to the legends who made this:

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

Copyright (C) 2008-2024 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. 🫶

and that's the whole page, bestie 💖 manually documented by the good people of perl, perl v5.42.3, dated 2026-08-20, filed under Math::...:NTuple(3pm). go write that patch, the module is a work in progress and she's waiting for you. periodt. 💅✨
📦 where this page comes from