-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.html
219 lines (149 loc) · 8.78 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
<html><head><title>String::Palindrome</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" >
</head>
<body class='pod'>
<!--
generated by Pod::Simple::HTML v3.16,
using Pod::Simple::PullParser v3.16,
under Perl v5.012003 at Tue Jun 21 05:45:51 2011 GMT.
If you want to change this HTML document, you probably shouldn't do that
by changing it directly. Instead, see about changing the calling options
to Pod::Simple::HTML, and/or subclassing Pod::Simple::HTML,
then reconverting this document from the Pod source.
When in doubt, email the author of Pod::Simple::HTML for advice.
See 'perldoc Pod::Simple::HTML' for more info.
-->
<!-- start doc -->
<a name='___top' class='dummyTopAnchor' ></a>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>
<p>String::Palindrome - Determine if a string is a palindrome</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="VERSION"
>VERSION</a></h1>
<p>version 2.000001</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>
<pre> use String::Palindrome qw/ is_palindrome /;
# Simple strings
my $is = 'abccba';
my $is_not = 'abcdef';
is_palindrome( $is ); # 1
is_palindrome( $is_not ); # 0
is_palindrome( {a => 1} ); # undef
is_palindrome( ); # undef
# Arrays
my @is = qw/ a ab cc ab a /;
my @is_not = qw/ a ab cc a ba /;
is_palindrome( @is ); # 1
is_palindrome( \@is ); # 1
is_palindrome( @is_not ); # 0
is_palindrome( \@is_not ); # 0
is_palindrome( [] ); # undef</pre>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="EXPORTS"
>EXPORTS</a></h1>
<ul>
<li>is_palindrome</li>
</ul>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="FUNCTIONS"
>FUNCTIONS</a></h1>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="is_palindrome"
>is_palindrome</a></h2>
<p>Returns true if the string, array, or array_ref is a palindrome. If more than one parameter is passed to the function, then it will blindly assume that you want to treat them as an array to be tested. This means that you could, theoretically, pass in a palindrome of array_refs and it would still pass.</p>
<p>If only one arg is passed, then it is first checked to see if it is an array ref. If it is an array ref it is treated as a normal array. If it is a simple scalar, then it is treated as a string. If it is any other type of ref, then undef is returned. Additionally, a blank array ref also returns undef.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="INSTALLATION"
>INSTALLATION</a></h1>
<p>See perlmodinstall for information and options on installing Perl modules.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="AUTHOR"
>AUTHOR</a></h1>
<p>Adam Lesperance <lespea@gmail.com></p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SUPPORT"
>SUPPORT</a></h1>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="Perldoc"
>Perldoc</a></h2>
<p>You can find documentation for this module with the perldoc command.</p>
<pre> perldoc String::Palindrome</pre>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="Websites"
>Websites</a></h2>
<p>The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.</p>
<ul>
<li>Search CPAN
<p>The default CPAN search engine, useful to view POD in HTML format.</p>
<p><a href="http://search.cpan.org/dist/String-Palindrome" class="podlinkurl"
>http://search.cpan.org/dist/String-Palindrome</a></p>
</li>
<li>RT: CPAN's Bug Tracker
<p>The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.</p>
<p><a href="http://rt.cpan.org/NoAuth/Bugs.html?Dist=String-Palindrome" class="podlinkurl"
>http://rt.cpan.org/NoAuth/Bugs.html?Dist=String-Palindrome</a></p>
</li>
<li>AnnoCPAN
<p>The AnnoCPAN is a website that allows community annonations of Perl module documentation.</p>
<p><a href="http://annocpan.org/dist/String-Palindrome" class="podlinkurl"
>http://annocpan.org/dist/String-Palindrome</a></p>
</li>
<li>CPAN Ratings
<p>The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.</p>
<p><a href="http://cpanratings.perl.org/d/String-Palindrome" class="podlinkurl"
>http://cpanratings.perl.org/d/String-Palindrome</a></p>
</li>
<li>CPAN Forum
<p>The CPAN Forum is a web forum for discussing Perl modules.</p>
<p><a href="http://cpanforum.com/dist/String-Palindrome" class="podlinkurl"
>http://cpanforum.com/dist/String-Palindrome</a></p>
</li>
<li>CPANTS
<p>The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.</p>
<p><a href="http://cpants.perl.org/dist/overview/String-Palindrome" class="podlinkurl"
>http://cpants.perl.org/dist/overview/String-Palindrome</a></p>
</li>
<li>CPAN Testers
<p>The CPAN Testers is a network of smokers who run automated tests on uploaded CPAN distributions.</p>
<p><a href="http://www.cpantesters.org/distro/S/String-Palindrome" class="podlinkurl"
>http://www.cpantesters.org/distro/S/String-Palindrome</a></p>
</li>
<li>CPAN Testers Matrix
<p>The CPAN Testers Matrix is a website that provides a visual way to determine what Perls/platforms PASSed for a distribution.</p>
<p><a href="http://matrix.cpantesters.org/?dist=String-Palindrome" class="podlinkurl"
>http://matrix.cpantesters.org/?dist=String-Palindrome</a></p>
</li>
<li>CPAN Testers Dependencies
<p>The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.</p>
<p><a href="http://deps.cpantesters.org/?module=String::Palindrome" class="podlinkurl"
>http://deps.cpantesters.org/?module=String::Palindrome</a></p>
</li>
</ul>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="Bugs_/_Feature_Requests"
>Bugs / Feature Requests</a></h2>
<p>Please report any bugs or feature requests by email to <code>bug-string-palindrome at rt.cpan.org</code>, or through the web interface at <a href="http://rt.cpan.org/NoAuth/ReportBug.html?Queue=String-Palindrome" class="podlinkurl"
>http://rt.cpan.org/NoAuth/ReportBug.html?Queue=String-Palindrome</a>. You will be automatically notified of any progress on the request by the system.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="Source_Code"
>Source Code</a></h2>
<p>The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)</p>
<p><a href="https://github.com/lespea/string-palindrome" class="podlinkurl"
>https://github.com/lespea/string-palindrome</a></p>
<pre> git clone git://github.com/lespea/string-palindrome.git</pre>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="COPYRIGHT_AND_LICENSE"
>COPYRIGHT AND LICENSE</a></h1>
<p>This software is copyright (c) 2011 by Adam Lesperance.</p>
<p>This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="DISCLAIMER_OF_WARRANTY"
>DISCLAIMER OF WARRANTY</a></h1>
<p>BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.</p>
<p>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</p>
<!-- end doc -->
</body></html>