.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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 "Test2::Compare::OrderedSubset 3perl"
.TH Test2::Compare::OrderedSubset 3perl 2024-09-01 "perl v5.40.0" "Perl Programmers Reference Guide"
.\" 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
Test2::Compare::OrderedSubset \- Internal representation of an ordered subset.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module is used to ensure an array has all the expected items int he
expected order. It ignores any unexpected items mixed into the array. It only
cares that all the expected values are present, and in order, everything else
is noise.
.SH METHODS
.IX Header "METHODS"
.ie n .IP "$ref = $arr\->\fBinref()\fR" 4
.el .IP "\f(CW$ref\fR = \f(CW$arr\fR\->\fBinref()\fR" 4
.IX Item "$ref = $arr->inref()"
If the instance was constructed from an actual array, this will have the
reference to that array.
.ie n .IP "$arrayref = $arr\->\fBitems()\fR" 4
.el .IP "\f(CW$arrayref\fR = \f(CW$arr\fR\->\fBitems()\fR" 4
.IX Item "$arrayref = $arr->items()"
.PD 0
.ie n .IP $arr\->set_items($arrayref) 4
.el .IP \f(CW$arr\fR\->set_items($arrayref) 4
.IX Item "$arr->set_items($arrayref)"
.PD
All the expected items, in order.
.ie n .IP "$name = $arr\->\fBname()\fR" 4
.el .IP "\f(CW$name\fR = \f(CW$arr\fR\->\fBname()\fR" 4
.IX Item "$name = $arr->name()"
Always returns the string \f(CW"<ORDERED SUBSET>"\fR.
.ie n .IP "$bool = $arr\->verify(got => $got, exists => $bool)" 4
.el .IP "\f(CW$bool\fR = \f(CW$arr\fR\->verify(got => \f(CW$got\fR, exists => \f(CW$bool\fR)" 4
.IX Item "$bool = $arr->verify(got => $got, exists => $bool)"
Check if \f(CW$got\fR is an array reference or not.
.ie n .IP $arr\->add_item($item) 4
.el .IP \f(CW$arr\fR\->add_item($item) 4
.IX Item "$arr->add_item($item)"
Add an item to the list of values to check.
.ie n .IP "@deltas = $arr\->deltas(got => $got, convert => \e&convert, seen => \e%seen)" 4
.el .IP "\f(CW@deltas\fR = \f(CW$arr\fR\->deltas(got => \f(CW$got\fR, convert => \e&convert, seen => \e%seen)" 4
.IX Item "@deltas = $arr->deltas(got => $got, convert => &convert, seen => %seen)"
Find the differences between the expected array values and those in the \f(CW$got\fR
arrayref.
.SH SOURCE
.IX Header "SOURCE"
The source code repository for Test2\-Suite can be found at
\&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
.SH MAINTAINERS
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH AUTHORS
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2018 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR