Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Compare::OrderedSubset.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::Compare::OrderedSubset 3pm"
61 .TH Test2::Compare::OrderedSubset 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::Compare::OrderedSubset \- Internal representation of an ordered subset.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This module is used to ensure an array has all the expected items int he
71 expected order. It ignores any unexpected items mixed into the array. It only
72 cares that all the expected values are present, and in order, everything else
73 is noise.
74 .SH METHODS
75 .IX Header "METHODS"
76 .ie n .IP "$ref = $arr\->\fBinref()\fR" 4
77 .el .IP "\f(CW$ref\fR = \f(CW$arr\fR\->\fBinref()\fR" 4
78 .IX Item "$ref = $arr->inref()"
79 If the instance was constructed from an actual array, this will have the
80 reference to that array.
81 .ie n .IP "$arrayref = $arr\->\fBitems()\fR" 4
82 .el .IP "\f(CW$arrayref\fR = \f(CW$arr\fR\->\fBitems()\fR" 4
83 .IX Item "$arrayref = $arr->items()"
84 .PD 0
85 .ie n .IP $arr\->set_items($arrayref) 4
86 .el .IP \f(CW$arr\fR\->set_items($arrayref) 4
87 .IX Item "$arr->set_items($arrayref)"
88 .PD
89 All the expected items, in order.
90 .ie n .IP "$name = $arr\->\fBname()\fR" 4
91 .el .IP "\f(CW$name\fR = \f(CW$arr\fR\->\fBname()\fR" 4
92 .IX Item "$name = $arr->name()"
93 Always returns the string \f(CW"<ORDERED SUBSET>"\fR.
94 .ie n .IP "$bool = $arr\->verify(got => $got, exists => $bool)" 4
95 .el .IP "\f(CW$bool\fR = \f(CW$arr\fR\->verify(got => \f(CW$got\fR, exists => \f(CW$bool\fR)" 4
96 .IX Item "$bool = $arr->verify(got => $got, exists => $bool)"
97 Check if \f(CW$got\fR is an array reference or not.
98 .ie n .IP $arr\->add_item($item) 4
99 .el .IP \f(CW$arr\fR\->add_item($item) 4
100 .IX Item "$arr->add_item($item)"
101 Add an item to the list of values to check.
102 .ie n .IP "@deltas = $arr\->deltas(got => $got, convert => \e&convert, seen => \e%seen)" 4
103 .el .IP "\f(CW@deltas\fR = \f(CW$arr\fR\->deltas(got => \f(CW$got\fR, convert => \e&convert, seen => \e%seen)" 4
104 .IX Item "@deltas = $arr->deltas(got => $got, convert => &convert, seen => %seen)"
105 Find the differences between the expected array values and those in the \f(CW$got\fR
106 arrayref.
107 .SH SOURCE
108 .IX Header "SOURCE"
109 The source code repository for Test2\-Suite can be found at
110 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
111 .SH MAINTAINERS
112 .IX Header "MAINTAINERS"
113 .IP "Chad Granum <[email protected]>" 4
114 .IX Item "Chad Granum <[email protected]>"
115 .SH AUTHORS
116 .IX Header "AUTHORS"
117 .IP "Chad Granum <[email protected]>" 4
118 .IX Item "Chad Granum <[email protected]>"
119 .SH COPYRIGHT
120 .IX Header "COPYRIGHT"
121 Copyright Chad Granum <[email protected]>.
122 .PP
123 This program is free software; you can redistribute it and/or
124 modify it under the same terms as Perl itself.
125 .PP
126 See \fIhttp://dev.perl.org/licenses/\fR