Digimer at 03:58, 5 May 2013

2013-05-05T03:58:43Z

← Older revision		Revision as of 03:58, 5 May 2013
Line 1:		Line 1:
	{{mod_header}}		{{mod_header}}

	'''[https://alteeve.~~com~~/AN/Tools/Readable.pod Readable.pod]'''		'''[https://alteeve.ca/AN/Tools/Readable.pod Readable.pod]'''

	==NAME==		==NAME==

Digimer at 03:47, 20 September 2009

2009-09-20T03:47:01Z

← Older revision		Revision as of 03:47, 20 September 2009
Line 9:		Line 9:

	==SYNOPSIS==		==SYNOPSIS==
	<~~code~~>		<source lang="perl">
	use AN::Tools;		use AN::Tools;

Line 18:		Line 18:
	my $rounded=$an->Readable->...({		my $rounded=$an->Readable->...({
	});		});
	</~~code~~>		</source>
	==DESCRIPTION==		==DESCRIPTION==
	This is the human readable module. It's purpose is to provide methods meant to benefit humans (and others) reading output from various methods or other data soures. It serves this purpose by converting, generally large numbers, into smaller or formatted versions easier to understand by the reader.		This is the human readable module. It's purpose is to provide methods meant to benefit humans (and others) reading output from various methods or other data soures. It serves this purpose by converting, generally large numbers, into smaller or formatted versions easier to understand by the reader.
Line 32:		Line 32:
	===comma===		===comma===
	====Example====		====Example====
	<~~code~~>		<source lang="perl">
	# Add commas to a long number.		# Add commas to a long number.
	my $number=1234567890.09876;		my $number=1234567890.09876;
	my $hr_number=$an->Readable->commas($number);		my $hr_number=$an->Readable->commas($number);
	print "$hr_number\n"; # prints '1,234,567,890.09876'		print "$hr_number\n"; # prints '1,234,567,890.09876'
	</~~code~~>		</source>
	====Details====		====Details====
	This method adds commas to the whole-number portion of a real number that is four or more digits in length. This method does not take a parameters hash reference. It only accepts one argument, that being the number to change.		This method adds commas to the whole-number portion of a real number that is four or more digits in length. This method does not take a parameters hash reference. It only accepts one argument, that being the number to change.
Line 45:		Line 45:
	===base2===		===base2===
	====Example====		====Example====
	<~~code~~>		<source lang="perl">
	# Check if AN::Tools is currently using base 2 or base 10 notation for		# Check if AN::Tools is currently using base 2 or base 10 notation for
	# translating byte sizs.		# translating byte sizs.
Line 62:		Line 62:
	$an->Readable->base2(1);		$an->Readable->base2(1);
	# Back to using base 2 notation.		# Back to using base 2 notation.
	</~~code~~>		</source>
	====Default====		====Default====
	The default is <tt>1</tt>, which means Base 2 notation will be used when converting large byte sizes into a human readable format.		The default is <tt>1</tt>, which means Base 2 notation will be used when converting large byte sizes into a human readable format.
Line 74:		Line 74:
	Each line for both <tt>base2</tt> and <tt>base10</tt> shows; The short-form notation followed by it's English long-form name. Then it shows in the braces the X to the power of Y value that it represents followed, finally, by the exact number of bytes represented.		Each line for both <tt>base2</tt> and <tt>base10</tt> shows; The short-form notation followed by it's English long-form name. Then it shows in the braces the X to the power of Y value that it represents followed, finally, by the exact number of bytes represented.

	; <tt>base2</tt> Notation<code>		; <tt>base2</tt> Notation
			<code>
	IEC Notation Size		IEC Notation Size
	-------------- -------------------------------------------------		-------------- -------------------------------------------------
Line 86:		Line 87:
	YiB = yebibyte (2^80 / 1,208,925,819,614,629,174,706,176 bytes)		YiB = yebibyte (2^80 / 1,208,925,819,614,629,174,706,176 bytes)
	</code>		</code>
	; <tt>base10</tt> Notation<code>		; <tt>base10</tt> Notation
			<code>
	SI Notation Size		SI Notation Size
	-------------- -------------------------------------------------		-------------- -------------------------------------------------
Line 101:		Line 103:
	===time===		===time===
	====Example====		====Example====
	<~~code~~>		<source lang="perl">
	# Get the human-readable time represented by a passed number of seconds.		# Get the human-readable time represented by a passed number of seconds.
	my $time=1234567890.09876;		my $time=1234567890.09876;
Line 108:		Line 110:
	$say_time=$an->Readable->time($time);		$say_time=$an->Readable->time($time);
	print "$say_time\n"; # Also prints '2,041w 1d 23h 31m 30.09876s'		print "$say_time\n"; # Also prints '2,041w 1d 23h 31m 30.09876s'
	</~~code~~>		</source>
	====Details====		====Details====
	This method takes a given number of seconds are returns a human-readable form of that time expressed as a given number of weeks, days, hours, minutes and seconds. If the number is too small for weeks, days, hours or minutes to be needed, it simply doesn't use those portions (as opposed to returning 0w 0d 0h 0m). The digits to the right of the decimal place in a whole number will be interpreted as a given fraction of a second and will be returned as part of the second statement. Negative values are also okay and the returned string will have '-' at the start of the string to the left of the most significant number.		This method takes a given number of seconds are returns a human-readable form of that time expressed as a given number of weeks, days, hours, minutes and seconds. If the number is too small for weeks, days, hours or minutes to be needed, it simply doesn't use those portions (as opposed to returning 0w 0d 0h 0m). The digits to the right of the decimal place in a whole number will be interpreted as a given fraction of a second and will be returned as part of the second statement. Negative values are also okay and the returned string will have '-' at the start of the string to the left of the most significant number.
Line 118:		Line 120:
	===bytes_to_hr===		===bytes_to_hr===
	====Example====		====Example====
	<~~code~~>		<source lang="perl">
	# Get the human-readable time represented by a passed number of seconds.		# Get the human-readable time represented by a passed number of seconds.
	my $big_byte=1000000000;		my $big_byte=1000000000;
Line 126:		Line 128:
	$say_size=$an->Readable->bytes_to_hr($big_byte);		$say_size=$an->Readable->bytes_to_hr($big_byte);
	print "Size: $say_size\n"; # Prints 'Size: 1.00gb'		print "Size: $say_size\n"; # Prints 'Size: 1.00gb'
	</~~code~~>		</source>
	====Details====		====Details====
	This takes a singed integer representing a number of bytes and returns the shorter "human readable" form. By default, this is shortened using Base2 notation (1024 bytes = 1k), but can be switched to use Base10 (1000 bytes = 1k) notation via this module's <tt>base2()</tt> method.		This takes a singed integer representing a number of bytes and returns the shorter "human readable" form. By default, this is shortened using Base2 notation (1024 bytes = 1k), but can be switched to use Base10 (1000 bytes = 1k) notation via this module's <tt>base2()</tt> method.
Line 155:		Line 157:
	===hr_to_bytes===		===hr_to_bytes===
	====Example====		====Example====
	<~~code~~>		<source lang="perl">
	# Most reliable method;		# Most reliable method;
	my $bytes=$an->Readable->hr_to_bytes({		my $bytes=$an->Readable->hr_to_bytes({
Line 176:		Line 178:
	$bytes=$an->Readable->hr_to_bytes("-1.525", "kib");		$bytes=$an->Readable->hr_to_bytes("-1.525", "kib");
	print "$bytes\n"; # Prints '-1562'.		print "$bytes\n"; # Prints '-1562'.
	</~~code~~>		</source>
	====Details====		====Details====
	This takes a signed, human-readable data size and converts it back into bytes as accurately as possible.		This takes a signed, human-readable data size and converts it back into bytes as accurately as possible.

Digimer at 03:14, 20 September 2009

2009-09-20T03:14:36Z

← Older revision		Revision as of 03:14, 20 September 2009
Line 1:		Line 1:
	{{mod_header}}		{{mod_header}}

			'''[https://alteeve.com/AN/Tools/Readable.pod Readable.pod]'''

	==NAME==		==NAME==

Digimer at 02:31, 20 September 2009

2009-09-20T02:31:51Z

← Older revision		Revision as of 02:31, 20 September 2009
Line 1:		Line 1:
			{{mod_header}}

	==NAME==		==NAME==
	AN::Tools::Readable		AN::Tools::Readable
Line 192:		Line 194:
	This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.		This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
	</code>		</code>

			{{footer}}

Digimer at 02:31, 20 September 2009

2009-09-20T02:31:28Z

Show changes

Digimer: Created page with '{{mod_header}} {{footer}}'

2009-09-20T02:21:45Z

Created page with '{{mod_header}} {{footer}}'

Páàjì titun

POD AN::Tools::Readable - Revision history

Digimer at 03:58, 5 May 2013

Digimer at 03:47, 20 September 2009

Digimer at 03:14, 20 September 2009

Digimer at 02:31, 20 September 2009

Digimer at 02:31, 20 September 2009

Digimer: Created page with '{{mod_header}} {{footer}}'