.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Paranoid::Data 3pm" .TH Paranoid::Data 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Paranoid::Data \- Misc. Data Manipulation Functions .SH VERSION .IX Header "VERSION" \&\f(CW$Id:\fR lib/Paranoid/Data.pm, 2.10 2022/03/08 00:01:04 acorliss Exp $ .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 3 \& $rv = deepCopy($source, $target); \& $rv = deepCopy(@source, @target); \& $rv = deepCopy(%source, %target); \& \& $rv = deepCmp($source, $target); \& $rv = deepCmp(@source, @target); \& $rv = deepCmp(%source, %target); \& \& $rv = has64bInt(); \& ($low, $high) = quad2Longs($quad); \& $quad = longs2Quad($low, $high); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This module provides data manipulation functions. .SH "IMPORT LISTS" .IX Header "IMPORT LISTS" This module exports the following symbols by default: .PP .Vb 1 \& deepCopy deepCmp has64bInt .Ve .PP The following specialized import lists also exist: .PP .Vb 3 \& List Members \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \& all @defaults .Ve .SH SUBROUTINES/METHODS .IX Header "SUBROUTINES/METHODS" .SS deepCopy .IX Subsection "deepCopy" .Vb 3 \& $rv = deepCopy($source, $target); \& $rv = deepCopy(@source, @target); \& $rv = deepCopy(%source, %target); .Ve .PP This function performs a deep and safe copy of arbitrary data structures, checking for circular references along the way. Hashes and lists are safely duplicated while all other data types are just copied. This means that any embedded object references, etc., are identical in both the source and the target, which is probably not what you want. .PP In short, this should only be used on pure hash/list/scalar value data structures. Both the source and the target data types must be of an identical type. .PP This function returns the number of elements copied unless it runs into a problem (such as a circular reference), in which case it returns a zero. .SS deepCmp .IX Subsection "deepCmp" .Vb 3 \& $rv = deepCmp($source, $target); \& $rv = deepCmp(@source, @target); \& $rv = deepCmp(%source, %target); .Ve .PP This function performs a deep comparison of arbitrarily complex data structures (i.e., hashes of lists of lists of scalars, etc.). It returns true if the values of the structures are identical, false otherwise. Like the \&\fBdeepCopy\fR function there are no provisions for evaluating objects beyond what their values are when coerced as scalar types. .PP End sum, the same caveats that applied to \fBdeepCopy\fR apply here. .SS has64bInt .IX Subsection "has64bInt" .Vb 1 \& $rv = has64bInt(); .Ve .PP This function returns a boolean value denoting whether the platform has native 64bit integers or not. .SS quad2Longs .IX Subsection "quad2Longs" .Vb 1 \& ($low, $high) = quad2Longs($quad); .Ve .PP This function takes any 64bit integer and splits it into two native longs, in the order of low order long, high order long. This function will still work on platforms that don't support native quads. In that case, it will just be assumed that the high order bytes equal zero. .SS longs2Quad .IX Subsection "longs2Quad" .Vb 1 \& $quad = longs2Quad($low, $high); .Ve .PP This function takes two longs and combines them into a single native quad. This function will still work on platforms without native quad support, but only if the value of the quad is small enough to fit into a long, which is what's actually returned in that scenario. .PP In the case of the high order bytes are not zero on a platform without native quad support, this function will return undef. .SH DEPENDENCIES .IX Header "DEPENDENCIES" .IP o 4 .IX Item "o" Carp .IP o 4 .IX Item "o" Paranoid .IP o 4 .IX Item "o" Paranoid::Debug .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" .SH AUTHOR .IX Header "AUTHOR" Arthur Corliss (corliss@digitalmages.com) .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" This software is free software. Similar to Perl, you can redistribute it and/or modify it under the terms of either: .PP .Vb 7 \& a) the GNU General Public License \& as published by the \& Free Software Foundation ; either version 1 \& , or any later version \& , or \& b) the Artistic License 2.0 \& , .Ve .PP 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. .PP (c) 2005 \- 2020, Arthur Corliss (corliss@digitalmages.com) (tm) 2008 \- 2020, Paranoid Inc. (www.paranoid.com)