.\" -*- 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 "Test::Data::Array 3pm"
.TH Test::Data::Array 3pm 2024-03-16 "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
Test::Data::Array \-\- test functions for array variables
.SH SYNOPSIS
.IX Header "SYNOPSIS"
use Test::Data qw(Array);
.SH DESCRIPTION
.IX Header "DESCRIPTION"
.SS Functions
.IX Subsection "Functions"
.IP "array_any_ok( ITEM, ARRAY [, NAME] )" 4
.IX Item "array_any_ok( ITEM, ARRAY [, NAME] )"
Ok if any element of ARRAY is ITEM.
.IP "array_none_ok( ITEM, ARRAY [, NAME] )" 4
.IX Item "array_none_ok( ITEM, ARRAY [, NAME] )"
Ok if no element of ARRAY is ITEM.
.IP "array_once_ok( ITEM, ARRAY [, NAME] )" 4
.IX Item "array_once_ok( ITEM, ARRAY [, NAME] )"
Ok if only one element of ARRAY is ITEM.
.IP "array_multiple_ok( ITEM, ARRAY [, NAME] )" 4
.IX Item "array_multiple_ok( ITEM, ARRAY [, NAME] )"
Ok if more than one element of ARRAY is ITEM.
.IP "array_max_ok( NUMBER, ARRAY [, NAME] )" 4
.IX Item "array_max_ok( NUMBER, ARRAY [, NAME] )"
Ok if all elements of ARRAY are numerically less than
or equal to NUMBER.
.IP "array_min_ok( NUMBER, ARRAY [, NAME] )" 4
.IX Item "array_min_ok( NUMBER, ARRAY [, NAME] )"
Ok if all elements of ARRAY are numerically greater than
or equal to NUMBER.
.IP "array_maxstr_ok( ITEM, ARRAY [, NAME] )" 4
.IX Item "array_maxstr_ok( ITEM, ARRAY [, NAME] )"
Ok if all elements of ARRAY are asciibetically less than
or equal to MAX.
.IP "array_minstr_ok( ITEM, ARRAY [, NAME] )" 4
.IX Item "array_minstr_ok( ITEM, ARRAY [, NAME] )"
Ok if all elements of ARRAY are asciibetically greater than
or equal to MAX.
.IP "array_sum_ok( SUM, ARRAY [, NAME] )" 4
.IX Item "array_sum_ok( SUM, ARRAY [, NAME] )"
Ok if the numerical sum of ARRAY is SUM.
.IP "array_empty_ok( ARRAY [, NAME] )" 4
.IX Item "array_empty_ok( ARRAY [, NAME] )"
Ok if the array contains no elements.
.IP "array_length_ok( ARRAY, LENGTH [, NAME] )" 4
.IX Item "array_length_ok( ARRAY, LENGTH [, NAME] )"
Ok if the array contains LENGTH number of elements.
.IP "array_sortedstr_ascending_ok( ARRAY, [, NAME] )" 4
.IX Item "array_sortedstr_ascending_ok( ARRAY, [, NAME] )"
Ok if each succeeding element is asciibetically greater than or equal
to the one before.
.IP "array_sortedstr_descending_ok( ARRAY, [, NAME] )" 4
.IX Item "array_sortedstr_descending_ok( ARRAY, [, NAME] )"
Ok if each succeeding element is asciibetically less than or equal to
the one before.
.IP "array_sorted_ascending_ok( ARRAY, [, NAME] )" 4
.IX Item "array_sorted_ascending_ok( ARRAY, [, NAME] )"
Ok if each succeeding element is numerically greater than or equal
to the one before.
.IP "array_sorted_descending_ok( ARRAY, [, NAME] )" 4
.IX Item "array_sorted_descending_ok( ARRAY, [, NAME] )"
Ok if each succeeding element is numerically less than or equal to
the one before.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Test::Data,
Test::Data::Scalar,
Test::Data::Function,
Test::Data::Hash,
Test::Builder
.SH "SOURCE AVAILABILITY"
.IX Header "SOURCE AVAILABILITY"
This source is in Github:
.PP
.Vb 1
\&        https://github.com/briandfoy/test\-data
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
brian d foy, \f(CW\*(C`<briandfoy@pobox.com>\*(C'\fR
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright © 2002\-2024, brian d foy <briandfoy@pobox.com>. All rights reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the Artistic License 2.0.