NAME

Data::Unixish::num - Format number

VERSION

version 1.28

SYNOPSIS

In Perl:

use Data::Unixish::num;
my $in  = [0, 10, -2, 34.5 [2], {}, "", undef];
my $out = [];
Data::Unixish::num::num(in=>$in, out=>$out, style=>"fixed");
# $out = ["0.00", "10.00", "-2.00", "34.50", [2], {}, "", undef];

In command line:

% echo -e "1\n-2\n" | dux num -s fixed --format=text-simple
1.00
-2.00

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Steven Haryanto.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

DESCRIPTION

FUNCTIONS

None are exported by default, but they are exportable.

num(%args) -> [status, msg, result, meta]

Format number.

Observe locale environment variable settings.

Undef and non-numbers are ignored.

Arguments ('*' denotes required arguments):

• decimal_digits => any

  Number of digits to the right of decimal point.

• in => any

• out => any

• prefix => str

  Add some string at the beginning (e.g. for currency).

• style => str (default: "general")

  Available styles:

  • fixed (Fixed number of decimal digits, e.g. 1.00, default decimal digits=2

  • general (General formatting, e.g. 1, 2.345

  • kibi (Use Ki/Mi/GiB/etc suffix with base-10 [1000], e.g. 1.2Mi

  • kilo (Use K/M/G/etc suffix with base-2, e.g. 1.2M

  • scientific (Scientific notation, e.g. 1.23e+21

• suffix => str

  Add some string at the end (e.g. for unit).

• thousands_sep => str

  Use a custom thousand separator character.

  Default is from locale (e.g. dot "." for en_US, etc).

  Use empty string "" if you want to disable printing thousands separator.

Return value:

Returns an enveloped result (an array). First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.