The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Data-Str2Num-0.07
River stage zero No dependents
++
/ Data::Str2Num

NAME

Data::Str2Num - int str to int; float str to float, else undef. No warnings.

SYNOPSIS

 #####
 # Subroutine interface
 #  
 use Data::Str2Num qw(config str2float str2int str2integer);

 $float = str2float($string, [@options]);
 (\@strings, @floats) = str2float(@strings, [@options]);

 $integer = $secspack->str2int($string);

 $integer = str2integer($string, [@options]);
 (\@strings, @integers) = str2int(@strings, [@options]);


 #####
 # Class, Object interface
 #
 # For class interface, use Data::SecsPack instead of $self
 #
 use Data::Str2Num;

 $str2num = 'Data::Str2Num';
 $str2num = new Data::Str2Num;

 $float = $secspack->str2float($string, [@options]);
 (\@strings, @floats) = $secspack->str2float(@strings, [@options]);

 $integer = $secspack->str2int($string);

 $integer = $secspack->str2integer($string, [@options])
 (\@strings, @integers) = $secspack->str2int(@strings, [@options]);

Generally, if a subroutine will process a list of options, @options, that subroutine will also process an array reference, \@options, [@options], or hash reference, \%options, {@options}. If a subroutine will process an array reference, \@options, [@options], that subroutine will also process a hash reference, \%options, {@options}. See the description for a subroutine for details and exceptions.

DESCRIPTION

The Data::Str2Num program module provides subroutines that parse numeric strings from the beginning of alphanumeric strings.

str2float

 $float = str2float($string);
 $float = str2float($string, [@options]);
 $float = str2float($string, {@options});

 (\@strings, @floats) = str2float(@strings);
 (\@strings, @floats) = str2float(@strings, [@options]);
 (\@strings, @floats) = str2float(@strings, {@options});

The str2float subroutine, in an array context, supports converting multiple run of integers, decimals or floats in an array of strings @strings to an array of integers, decimals or floats, @floats. It keeps converting the strings, starting with the first string in @strings, continuing to the next and next until it fails an conversion. The str2int returns the stripped string data, naked of all integers, in @strings and the array of floats @floats. For the ascii_float option, the members of the @floats are scalar strings of the float numbers; otherwise, the members are a reference to an array of [$decimal_magnitude, $decimal_exponent] where the decimal point is set so that there is one decimal digit to the left of the decimal point for $decimal_magnitude.

In a scalar context, it parse out any type of $number in the leading $string. This is especially useful for $string that is certain to have a single number.

str2int

 $integer = $secspack->str2int($string);

The str2int subroutine is the same as the str2integer subroutine except that that the subroutine always returns the scalar processing str2integer subroutine.

str2integer

 $integer = str2int($string);
 $integer = str2int($string, [@options]);
 $integer = str2int($string, {@options});

 (\@strings, @integers) = str2int(@strings); 
 (\@strings, @integers) = str2int(@strings, [@options]); 
 (\@strings, @integers) = str2int(@strings, {@options});

In a scalar context, the Data::SecsPack program module translates an scalar string to a scalar integer. Perl itself has a documented function, '0+$x', that converts a scalar to so that its internal storage is an integer (See p.351, 3rd Edition of Programming Perl). If it cannot perform the conversion, it leaves the integer 0. Surprising not all Perls, some Microsoft Perls in particular, may leave the internal storage as a scalar string.

What is $x for the following:

  my $x = 0 + '0x100';  # $x is 0 with a warning

Instead use str2int uses a few simple Perl lines, without any evals starting up whatevers or firing up the regular expression engine with its interpretative overhead, to provide a slightly different response as follows:>.

 $x = str2int('033');   # $x is 27
 $x = str2int('0xFF');  # $x is 255
 $x = str2int('255');   # $x is 255
 $x = str2int('hello'); # $x is undef no warning
 $x = str2int(0.5);     # $x is undef no warning
 $x = str2int(1E0);     # $x is 1 
 $x = str2int(0xf);     # $x is 15
 $x = str2int(1E30);    # $x is undef no warning

The scalar str2int subroutine performs the conversion to an integer for strings that look like integers and actual integers without generating warnings. A non-numeric string, decimal or floating string returns an "undef" instead of the 0 and a warning that 0+'hello' produces. This makes it not only useful for forcing an integer conversion but also for testing a scalar to see if it is in fact an integer scalar. The scalar str2int is the same and supercedes C&<Data::StrInt::str2int>. The Data::SecsPack program module superceds the Data::StrInt program module.

The str2int subroutine, in an array context, supports converting multiple run of integers in an array of strings @strings to an array of integers, @integers. It keeps converting the strings, starting with the first string in @strings, continuing to the next and next until it fails a conversion. The str2int returns the remaining string data in @strings and the array of integers @integers.

DEMONSTRATION

 #########
 # perl Str2Num.d
 ###

~~~~~~ Demonstration overview ~~~~~

The results from executing the Perl Code follow on the next lines as comments. For example,

 2 + 2
 # 4

~~~~~~ The demonstration follows ~~~~~

     use File::Package;
     my $fp = 'File::Package';

     my $uut = 'Data::Str2Num';
     my $loaded;
     my ($result,@result); # force a context

 ##################
 # Load UUT
 # 

 my $errors = $fp->load_package($uut, 'str2float','str2int','str2integer',)
 $errors

 # ''
 #

 ##################
 # str2int('033')
 # 

 $uut->str2int('033')

 # '27'
 #

 ##################
 # str2int('0xFF')
 # 

 $uut->str2int('0xFF')

 # '255'
 #

 ##################
 # str2int('0b1010')
 # 

 $uut->str2int('0b1010')

 # '10'
 #

 ##################
 # str2int('255')
 # 

 $uut->str2int('255')

 # '255'
 #

 ##################
 # str2int('hello')
 # 

 $uut->str2int('hello')

 # undef
 #

 ##################
 # str2integer(1E20)
 # 

 $result = $uut->str2integer(1E20)

 # undef
 #

 ##################
 # str2integer(' 78 45 25', ' 512E4 1024 hello world') @numbers
 # 

 my ($strings, @numbers) = str2integer(' 78 45 25', ' 512E4 1024 hello world')
 [@numbers]

 # [
 #          '78',
 #          '45',
 #          '25'
 #        ]
 #

 ##################
 # str2integer(' 78 45 25', ' 512E4 1024 hello world') @strings
 # 

 join( ' ', @$strings)

 # '512E4 1024 hello world'
 #

 ##################
 # str2float(' 78 -2.4E-6 0.0025 0', ' 512E4 hello world') numbers
 # 

 ($strings, @numbers) = str2float(' 78 -2.4E-6 0.0025  0', ' 512E4 hello world')
 [@numbers]

 # [
 #          [
 #            '78',
 #            '1'
 #          ],
 #          [
 #            '-24',
 #            '-6'
 #          ],
 #          [
 #            '25',
 #            -3
 #          ],
 #          [
 #            '0',
 #            -1
 #          ],
 #          [
 #            '512',
 #            '6'
 #          ]
 #        ]
 #

 ##################
 # str2float(' 78 -2.4E-6 0.0025 0', ' 512E4 hello world') @strings
 # 

 join( ' ', @$strings)

 # 'hello world'
 #

 ##################
 # str2float(' 78 -2.4E-6 0.0025 0xFF 077 0', ' 512E4 hello world', {ascii_float => 1}) numbers
 # 

 ($strings, @numbers) = str2float(' 78 -2.4E-6 0.0025 0xFF 077 0', ' 512E4 hello world', {ascii_float => 1})
 [@numbers]

 # [
 #          '78',
 #          '-2.4E-6',
 #          '0.0025',
 #          '255',
 #          '63',
 #          '0',
 #          '512E4'
 #        ]
 #

 ##################
 # str2float(' 78 -2.4E-6 0.0025 0xFF 077 0', ' 512E4 hello world', {ascii_float => 1}) @strings
 # 

 join( ' ', @$strings)

 # 'hello world'
 #

QUALITY ASSURANCE

Running the test script Str2Num.t verifies the requirements for this module. The tmake.pl cover script for Test::STDmaker|Test::STDmaker automatically generated the Str2Num.t test script, the Str2Num.d demo script, and the t::Data::Str2Num STD program module PODs, from the t::Data::Str2Num program module's content. The t::Data::Str2Num program modules are in the distribution file Data-Str2Num-$VERSION.tar.gz.

NOTES

AUTHOR

The holder of the copyright and maintainer is

<support@SoftwareDiamonds.com>

Copyrighted (c) 2002 2004 Software Diamonds

All Rights Reserved

BINDING REQUIREMENTS NOTICE

Binding requirements are indexed with the pharse 'shall[dd]' where dd is an unique number for each header section. This conforms to standard federal government practices, STD490A 3.2.3.6. In accordance with the License, Software Diamonds is not liable for any requirement, binding or otherwise.

LICENSE

Software Diamonds permits the redistribution and use in source and binary forms, with or without modification, provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. Commercial installation of the binary or source must visually present to the installer the above copyright notice, this list of conditions intact, that the original source is available at http://softwarediamonds.com and provide means for the installer to actively accept the list of conditions; otherwise, a license fee must be paid to Softwareware Diamonds.

SOFTWARE DIAMONDS, http://www.softwarediamonds.com, PROVIDES THIS SOFTWARE 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SOFTWARE DIAMONDS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING USE OF THIS SOFTWARE, EVEN IF ADVISED OF NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE POSSIBILITY OF SUCH DAMAGE.

SEE_ALSO:

Data::Startup