Debian Codegraph @

upstream/debian-unstable/man3/Test2::Compare::OrderedSubset.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "Test2::Compare::OrderedSubset 3perl"
58 .TH Test2::Compare::OrderedSubset 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Test2::Compare::OrderedSubset \- Internal representation of an ordered subset.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This module is used to ensure an array has all the expected items int he
68 expected order. It ignores any unexpected items mixed into the array. It only
69 cares that all the expected values are present, and in order, everything else
70 is noise.
71 .SH METHODS
72 .IX Header "METHODS"
73 .ie n .IP "$ref = $arr\->\fBinref()\fR" 4
74 .el .IP "\f(CW$ref\fR = \f(CW$arr\fR\->\fBinref()\fR" 4
75 .IX Item "$ref = $arr->inref()"
76 If the instance was constructed from an actual array, this will have the
77 reference to that array.
78 .ie n .IP "$arrayref = $arr\->\fBitems()\fR" 4
79 .el .IP "\f(CW$arrayref\fR = \f(CW$arr\fR\->\fBitems()\fR" 4
80 .IX Item "$arrayref = $arr->items()"
81 .PD 0
82 .ie n .IP $arr\->set_items($arrayref) 4
83 .el .IP \f(CW$arr\fR\->set_items($arrayref) 4
84 .IX Item "$arr->set_items($arrayref)"
85 .PD
86 All the expected items, in order.
87 .ie n .IP "$name = $arr\->\fBname()\fR" 4
88 .el .IP "\f(CW$name\fR = \f(CW$arr\fR\->\fBname()\fR" 4
89 .IX Item "$name = $arr->name()"
90 Always returns the string \f(CW"<ORDERED SUBSET>"\fR.
91 .ie n .IP "$bool = $arr\->verify(got => $got, exists => $bool)" 4
92 .el .IP "\f(CW$bool\fR = \f(CW$arr\fR\->verify(got => \f(CW$got\fR, exists => \f(CW$bool\fR)" 4
93 .IX Item "$bool = $arr->verify(got => $got, exists => $bool)"
94 Check if \f(CW$got\fR is an array reference or not.
95 .ie n .IP $arr\->add_item($item) 4
96 .el .IP \f(CW$arr\fR\->add_item($item) 4
97 .IX Item "$arr->add_item($item)"
98 Add an item to the list of values to check.
99 .ie n .IP "@deltas = $arr\->deltas(got => $got, convert => \e&convert, seen => \e%seen)" 4
100 .el .IP "\f(CW@deltas\fR = \f(CW$arr\fR\->deltas(got => \f(CW$got\fR, convert => \e&convert, seen => \e%seen)" 4
101 .IX Item "@deltas = $arr->deltas(got => $got, convert => &convert, seen => %seen)"
102 Find the differences between the expected array values and those in the \f(CW$got\fR
103 arrayref.
104 .SH SOURCE
105 .IX Header "SOURCE"
106 The source code repository for Test2\-Suite can be found at
107 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
108 .SH MAINTAINERS
109 .IX Header "MAINTAINERS"
110 .IP "Chad Granum <[email protected]>" 4
111 .IX Item "Chad Granum <[email protected]>"
112 .SH AUTHORS
113 .IX Header "AUTHORS"
114 .PD 0
115 .IP "Chad Granum <[email protected]>" 4
116 .IX Item "Chad Granum <[email protected]>"
117 .PD
118 .SH COPYRIGHT
119 .IX Header "COPYRIGHT"
120 Copyright 2018 Chad Granum <[email protected]>.
121 .PP
122 This program is free software; you can redistribute it and/or
123 modify it under the same terms as Perl itself.
124 .PP
125 See \fIhttp://dev.perl.org/licenses/\fR