.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 "String::Parity 3pm" .TH String::Parity 3pm "2022-10-13" "perl v5.34.0" "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" String::Parity \- parity (odd/even/mark/space) handling functions .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use String::Parity; \& use String::Parity qw(:DEFAULT /show/); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" .IP "setEvenParity \s-1LIST\s0" 8 .IX Item "setEvenParity LIST" Copies the elements of \s-1LIST\s0 to a new list and converts the new elements to strings of bytes with even parity. In array context returns the new list. In scalar context joins the elements of the new list into a single string and returns the string. .IP "setOddParity \s-1LIST\s0" 8 .IX Item "setOddParity LIST" Like setEvenParity function, but converts to strings with odd parity. .IP "setSpaceParity \s-1LIST\s0" 8 .IX Item "setSpaceParity LIST" Like setEvenParity function, but converts to strings with space (High bit cleared) parity. .IP "setMarkParity \s-1LIST\s0" 8 .IX Item "setMarkParity LIST" Like setEvenParity function, but converts to strings with mark (High bit set) parity. .IP "EvenBytes \s-1LIST\s0" 8 .IX Item "EvenBytes LIST" Returns the number of even parity bytes in the elements of \s-1LIST.\s0 .IP "OddBytes \s-1LIST\s0" 8 .IX Item "OddBytes LIST" Returns the number of odd parity bytes in the elements of \s-1LIST.\s0 .IP "SpaceBytes \s-1LIST\s0" 8 .IX Item "SpaceBytes LIST" Returns the number of space parity bytes in the elements of \s-1LIST.\s0 .IP "MarkBytes \s-1LIST\s0" 8 .IX Item "MarkBytes LIST" Returns the number of mark parity bytes in the elements of \s-1LIST.\s0 .IP "isEvenParity \s-1LIST\s0" 8 .IX Item "isEvenParity LIST" Returns \s-1TRUE\s0 if the \s-1LIST\s0 contains no byte with odd parity, \s-1FALSE\s0 otherwise. .IP "isOddParity \s-1LIST\s0" 8 .IX Item "isOddParity LIST" Returns \s-1TRUE\s0 if the \s-1LIST\s0 contains no byte with even parity, \s-1FALSE\s0 otherwise. .IP "isSpaceParity \s-1LIST\s0" 8 .IX Item "isSpaceParity LIST" Returns \s-1TRUE\s0 if the \s-1LIST\s0 contains no byte with mark parity, \s-1FALSE\s0 otherwise. .IP "isMarkParity \s-1LIST\s0" 8 .IX Item "isMarkParity LIST" Returns \s-1TRUE\s0 if the \s-1LIST\s0 contains no byte with space parity, \s-1FALSE\s0 otherwise. .IP "showParity \s-1LIST\s0" 8 .IX Item "showParity LIST" Like setEvenParity function, but converts bytes with even parity to 'e' and other bytes to 'o'. The function showParity must be imported by a specialised import list. .IP "showMarkSpace \s-1LIST\s0" 8 .IX Item "showMarkSpace LIST" Like setEvenParity function, but converts bytes with space parity to 's' and other bytes to 'm'. The function showMarkSpace must be imported by a specialised import list. .SH "NOTES" .IX Header "NOTES" Don't use this module unless you have to communicate with some old device or protocol. Please make your application 8 bit clean and use the internationally standardised \s-1ISO\-8859\-1\s0 character set. .SH "SEE ALSO" .IX Header "SEE ALSO" I don't know of any other modules that provide similar functionality. If you do, please let me know so I can update this section. .SH "REPOSITORY" .IX Header "REPOSITORY" .SH "AUTHOR" .IX Header "AUTHOR" This module was written by Winfried Koenig. .PP Updates to follow modern \s-1CPAN\s0 conventions by Neil Bowers (\s-1NEILB\s0). .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 1995 by Winfried Koenig. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.