Math::N...:Squares(3)

👑 Math::N...:Squares(3) — user contributed perl documentation, bestie edition 💅

okay so this page lives in the User Contributed Perl Documentation corner of the perl manual universe, and it's all about Math::NumSeq::Squares — the perfect squares sequence. yes, THE squares. the ones you learned in like third grade and never emotionally recovered from. let's go 🎀

---

✨ NAME ✨

Math::NumSeq::Squares — perfect squares, no cap 🟪

---

🌈 SYNOPSIS 🌈

use Math::NumSeq::Squares;
my $seq = Math::NumSeq::Squares->new;
my ($i, $value) = $seq->next;

that's it. that's the whole vibe. make the object, pull numbers out of it, slay. 💖

---

🦋 DESCRIPTION 🦋

it's the sequence of squares, aka i**2, and it goes a lil something like:

0, 1, 4, 9, 16, 25, ...     (A000290)

the way that A000290 is just right there being its iconic OEIS self 😭👑

---

💜 FUNCTIONS 💜

heads up bestie — for the behaviour that's common to all the sequence classes, go read "FUNCTIONS" in Math::NumSeq. this page is just the squares-specific stuff. 🫶

• $seq = Math::NumSeq::Squares->new () — creates and hands you back a shiny new sequence object. fresh out the box, zero notes. ✨

🧚 Iterating

• $seq->seek_to_i($i) — scoots the current sequence position over to $i. then the very next call to next() is gonna hand you $i and its matching value. like fast-forwarding to your fave part of the song. 🎧
• $seq->seek_to_value($value) — moves the current position so that next() gives you $value on the next call. BUT — and this is the plot twist — if $value isn't actually a square, then you get the next square above $value instead. the audacity. the drama. 💀

🔥 Random Access

• $value = $seq->ith($i) — returns "$i * $i". simple. elegant. iconic.
• $bool = $seq->pred($value) — returns true if $value is a square, i.e. k*k for some integer k. vibe check: passed or not passed, no in-between. 💅
• $i = $seq->value_to_i_ceil($value) — returns the square root of $value, rounded up to the next integer. ⬆️
• $i = $seq->value_to_i_floor($value) — returns the square root of $value, rounded down to the next integer. ⬇️
• $i = $seq->value_to_i_estimate($value) — returns an estimate of the i that corresponds to $value. an educated guess, a lil peek into the future, we love her. 🔮

---

🌸 SEE ALSO 🌸

• Math::NumSeq
• Math::NumSeq::Pronic
• Math::NumSeq::Triangular
• Math::NumSeq::Cubes

the whole squad fr fr 🫶🦋

---

🌈 HOME PAGE 🌈

<http://user42.tuxfamily.org/math-numseq/index.html>

go visit, she's gorgeous, tell her i said hi 💖

---

🎀 LICENSE 🎀

Copyright 2010, 2011, 2012, 2013, 2014, 2016, 2019, 2020 Kevin Ryde

Math-NumSeq is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.

Math-NumSeq is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Math-NumSeq. If not, see <http://www.gnu.org/licenses/>.

no warranty bestie, the lawyers made me say it 😭 read the GPL, it's giving legally binding main character energy 👑

---

and that's the whole page!! 💜 this was perl v5.42.0, dated 2025-07-25, straight from the Math::N...:Squares(3) page — mwah, bye, go square something 🧚✨