Parano...VLNode(3pm)

📦
version 2.10 · 3 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

✨ Paranoid::Data::AVLTree::AVLNode — the 3pm girlies know 💅

okay so bestie, welcome to Paranoid::Data::AVLTree::AVLNode, a whole module living in the Paranoid::Data::AVLTree family, and honestly? she's the moment. 🎀

🌸 VERSION 🌸

$Id: lib/Paranoid/Data/AVLTree/AVLNode.pm, 2.10 2022/03/08 00:01:04
acorliss Exp $

no cap, that's the actual version line, don't touch it, it's sacred. 💖

🦋 SYNOPSIS 🦋

$node   = Paranoid::Data::AVLTree::AVLNode->new($key, $val);
$key    = $node->key;
$val    = $node->val;
$rv     = $node->setVal($val);
$ref    = $node->right;
$rv     = $node->setRight($node);
$ref    = $node->left;
$rv     = $node->setLeft($node);
$rv     = $node->incrRHeight;
$rv     = $node->incrLHeight;
$rv     = $node->addRHeight($n);
$rv     = $node->addLHeight($n);
$rv     = $node->decrRHeight;
$rv     = $node->decrLHeight;
$balance = $node->balance;
$count  = $node->count;
$height = $node->height;
$height = $node->rHeight;
$height = $node->lHeight;
$rv     = $node->updtHeights;
@crefs  = $node->children;

like, that's the whole vibe in one code block. screenshot it, memorize it, slay. 📸✨

💜 DESCRIPTION 💜

so this class hands you the core data objects that make up an AVL-balanced tree. she's the building block. the little node doing the heavy lifting. main character energy, honestly. 👑

🧚 SUBROUTINES/METHODS 🧚

🌟 new

$node   = Paranoid::Data::AVLTree::AVLNode->new($key, $val);

makes you a brand new AVLNode object, periodt. and listen — just like hashes, the key must be defined, and it cannot be a zero-length string. if you try either of those things? this method hands you back undef. it's giving "not today." 🙅‍♀️

🌟 key

$key    = $node->key;

returns the key for the node. that's it. that's the tweet. 💌

🌟 val

$val    = $node->val;

returns the associated value for the node. lowkey important: it can be undef. so don't come for her when it's empty, that's allowed. 🙈

🌟 setVal

$rv     = $node->setVal($val);

sets the associated value for the node. glow-up for your data. ✨

$ref    = $node->right;

grabs you a reference to the next right-side node in the branch — if there even is one, iykyk. 🫶

🌟 setRight

$rv     = $node->setRight($node);

sets or removes the reference to the next right-side node in the branch. she can add, she can delete, she contains multitudes. 💅

🌟 left

$ref    = $node->left;

grabs you a reference to the next left-side node in the branch, if any. the other side of the story. 🌙

🌟 setLeft

$rv     = $node->setLeft($node);

sets or removes the reference to the next left-side node in the branch. same energy, other direction. 🪞

🌟 incrRHeight

$rv     = $node->incrRHeight;

increments the height counter for the ride-side sub-branch. (yes, the original says "ride-side", and we respect the typo, we do not correct the typo, the typo is iconic now.) 😭

🌟 incrLHeight

$rv     = $node->incrLHeight;

increments the height counter for the left-side sub-branch. ⬆️

🌟 addRHeight

$rv     = $node->addRHeight($n);

adds the value you passed to the height counter for the right-side sub-branch. math but make it cute. 🔢

🌟 addLHeight

$rv     = $node->addLHeight($n);

adds the value you passed to the height counter for the left-side sub-branch. 🍓

🌟 decrRHeight

$rv     = $node->decrRHeight;

decrements the height counter for the right-side sub-branch. going down, but in a healthy way. ⬇️

🌟 decrLHeight

$rv     = $node->decrLHeight;

decrements the height counter for the left-side sub-branch. 💐

🌟 balance

$balance = $node->balance;

returns the node balance, which is a relative indicator of the disparity in heights of the right & left sub-branches. let's decode this together bestie:

  • a negative number means a longer left-side branch
  • zero means the sub-branch heights are equal
  • a positive integer means a longer right-side branch

it's giving scales ⚖️ and you will be reading them. 📊

🌟 count

$count  = $node->count;

returns the count of nodes, including all the nodes in linked sub-branches. she counts everyone, nobody gets left out. 🫂

🌟 height

$height = $node->height;

returns the longest height of the node and any attached sub-branches. the tallest queen in the room. 👑

🌟 rHeight

$height = $node->rHeight;

returns the height of the right-side sub-branch, or zero if there's no linked branch. no branch, no problem. 💛

🌟 lHeight

$height = $node->lHeight;

returns the height of the left-side sub-branch, or zero if there's no linked branch. balanced behavior honestly. 💚

🌟 updtHeights

$rv     = $node->updtHeights;

does a brute force recalculation of all attached sub-branches. not subtle, not elegant, but she gets the job done. 💪

🌟 children

@crefs  = $node->children;

returns references to the next nodes in any attached sub-branches. (the original says "attadhed", which is also iconic, also preserved, also untouchable.) 🧸

🎀 DEPENDENCIES 🎀

  • Carp
  • Paranoid

💀 BUGS AND LIMITATIONS 💀

nothing here. the section exists. it is simply... empty. a void. a vibe. we respect the silence. 🤫

👑 AUTHOR 👑

Arthur Corliss (corliss@digitalmages.com)

This software is free software. Similar to Perl, you can redistribute it and/or modify it under the terms of either:

  1. the GNU General Public License <https://www.gnu.org/licenses/gpl-1.0.html> as published by the Free Software Foundation <http://www.fsf.org/>; either version 1 <https://www.gnu.org/licenses/gpl-1.0.html>, or any later version <https://www.gnu.org/licenses/license-list.html#GNUGPL>, or
  2. the Artistic License 2.0 <https://opensource.org/licenses/Artistic-2.0>,

subject to the following additional term: No trademark rights to "Paranoid" have been or are conveyed under any of the above licenses. However, "Paranoid" may be used fairly to describe this unmodified software, in good faith, but not as a trademark.

(c) 2005 - 2020, Arthur Corliss (corliss@digitalmages.com) (tm) 2008 - 2020, Paranoid Inc. (www.paranoid.com)

okay that's the whole page bestie, and for the cute sign-off: this bad girl was rendered by perl v5.38.2 on 2024-03-07, filed under the Parano...VLNode(3pm) manual name. go balance a tree, you got this. 💖🌳✨

📦 where this page comes from